como criar arquivos de Ajuda
8 pág.

como criar arquivos de Ajuda


DisciplinaOrganização de Computadores6.412 materiais120.238 seguidores
Pré-visualização2 páginas
TUTORIAL III: ADICIONANDO AJUDA 
PÁGINA: 1 DE 8 
Adicionando Ajuda 
 
Para construir arquivos de ajuda do Windows, é necessário saber quais são os 
componentes de um arquivo de ajuda. Você tem três arquivos básicos que são parte de cada 
arquivo de ajuda: o arquivo de projeto da ajuda (.HPJ), o arquivo de conteúdo da ajuda (.CNT), e 
o arquivo rich-text (.RTF) que contém o texto de ajuda propriamente dito. O arquivo de projeto e 
o arquivo de conteúdo são ambos arquivos texto. O arquivo que contém o texto de ajuda é um 
arquivo no formato rich-text que pode ser criado com uma grande variedade de processadores 
de texto, incluindo o Microsoft Word. Você junta estes três arquivos (e possivelmente outros) 
dentro do arquivo de ajuda através da compilação que é feita com o Microsoft Help 
Workshop. 
 
NOTA 
O WordPad que acompanha o Windows também pode ler e gravar arquivos de formato 
rich-text, mas ele não suporta todas as capacidades de formatação necessárias para construir 
arquivos de ajuda. Ele não suporta notas de rodapé e texto escondido, portanto não pode ser 
usado como editor de arquivos de ajuda Windows. 
 
 Cada um dos três arquivos contém instruções especiais que controlam a construção e o 
comportamento do arquivo de ajuda gerado. Antes do Windows95, você tinha que editar os 
arquivos de projeto e conteúdo manualmente se você não tivesse um utilitário de terceiros para 
isto. Juntamente com o Windows95, entretanto, a Microsoft produziu uma interface para editar 
e compilar projetos de ajuda. Este utilitário é chamado Microsoft Help Workshop, que é 
incluído com o Delphi. 
 
 Antes de você criar o arquivo de projeto ou o arquivo de conteúdo, você precisa compor 
o texto de ajuda propriamente dito. Este arquivo consiste de texto simples com a ajuda de 
alguns caracteres especiais e outros atributos de formatação que definem os tópicos de ajuda e 
os relacionamentos entre eles. 
 
 Você organiza o texto por tópicos, colocando cada tópico em uma página separada. 
Dentro de cada tópico, você usa notas de rodapé com caracteres customizados para denotar o 
título de um tópico, seu número, sua seqüência de navegação, e suas entradas no índice. Você 
usa atributos especiais de texto para denotar links de um tópico para outro. 
 
Tabela 1 - caracteres especiais e atributos de texto usados na composição de arquivos de ajuda 
Símbolo/Atributo Significado 
# Define o identificador do tópico que será usado para se fazer referência a este 
tópico 
$ Define o título do tópico 
K Define uma entrada no índice ou um conjunto de entradas (palavras chave) 
+ Define a ordem deste tópico na seqüência de navegação 
Duplo sublinhado Define um salto para outro tópico 
Texto escondido Identifica o tópico para onde saltar 
 
 
Construindo o arquivo texto de ajuda 
 
 Agora que você sabe o que estes símbolos significam, vamos colocá-los em uso. Crie 
um arquivo novo no seu processador de texto Windows. Este processador de texto deve 
TUTORIAL III: ADICIONANDO AJUDA 
PÁGINA: 2 DE 8 
suportar o formato RTF, notas de rodapé customizadas, sublinhado duplo e texto escondido. O 
mais usado é o Microsoft Word, mas você pode usar qualquer um que atenda aos 
pré-requisitos. 
 
 Você irá criar três tópicos simples, mais um tópico de conteúdo. Você irá criar links 
entre eles e definir entradas no índice para cada um deles. 
 
 Vamos iniciar digitando o primeiro tópico: 
 
Tópico 1 
 
Este é o texto de ajuda do tópico 1. Logo a seguir você verá outros tópicos. 
 
Criando o identificador do tópico 
 
 Posicione o cursor exatamente antes da palavra Tópico e insira uma nota de rodapé com 
o caractere #. Isto irá denotar o identificador do tópico ou a string de contexto. Digite Tópico1 no 
texto da nota de rodapé. Os outros tópicos que estabelecerem links com este irão usar este 
identificador para criar o link. Você também usa este identificador no Help Workshop \u23af você 
irá mapeá-lo para os números de ajuda de contexto que sua aplicação usa. 
 
Criando o título do tópico 
 
 Reposicione o cursor antes da palavra Tópico e insira uma nota de rodapé com o 
caractere $. Digite Tópico 1 no texto da nota de rodapé. O Windows permite pesquisar tópicos 
usando seus títulos, então é uma boa idéia colocar títulos nos tópicos. O título que você 
especificar para um tópico é exibido na lista de histórico do WinHelp, na caixa de diálogo 
Pesquisa, e no menu Bookmark. Usualmente, o título que você especificar deverá ser o mesmo 
que o texto da primeira linha do tópico. 
 
 Você pode formatar a primeira linha do tópico como qualquer título. Você pode usar um 
tamanho de fonte maior e negrito para destacá-lo. 
 
Criando as palavras chaves do tópico 
 
 Insira um nota de rodapé com o caractere K antes da palavra Tópico e digite 
Tópico1;Tópico 1;Primeiro. Estas entradas irão aparecer no índice do arquivo de ajuda, e ajudarão 
os usuários a encontrar mais facilmente os tópicos de interesse. 
 
Criando os tópicos restantes 
 
 Insira uma quebra de página após o texto do tópico. Todas as definições de tópicos 
terminam com uma quebra de página. 
 
 Agora que o Tópico1 está definido, você pode criar os dois tópicos restantes de acordo 
com o texto abaixo: 
 
 
 
TUTORIAL III: ADICIONANDO AJUDA 
PÁGINA: 3 DE 8 
Tópico 2 
 
Este é o segundo tópico de nosso exemplo. Ele vêm depois do primeiro. Aguarde pois vêm mais coisas 
por aí. 
 
Tópico 3 
 
Este é o terceiro e último tópico. Você já viu o primeiro e o segundo tópicos. Agora já chega! 
 
 Insira as notas de rodapé para o identificador, o título e palavras chaves destes dois 
tópicos. Use o mesmo tipo de notas de rodapé customizadas que você usou para o Tópico 1 e 
não esqueça de formatar a primeira linha de cada tópico de maneira a salientá-la e inserir uma 
quebra de página entre eles. Na tabela abaixo você verá como ficam as notas de rodapé dos três 
tópicos: 
 
Tabela 2 - notas de rodapé dos tópicos de exemplo 
Símbolo Tópico 1 Tópico 2 Tópico 3 
# Tópico1 Tópico2 Tópico3 
$ Tópico 1 Tópico 2 Tópico 3 
K Tópico1; Tópico 1; Primeiro Tópico2; Tópico 2; Segundo Tópico3; Tópico 3; Terceiro; 
Último 
 
Linkando dois tópicos 
 
 Depois que os tópicos foram criados, você pode linkar o segundo com o primeiro. 
Posicione o cursor logo após a palavra primeiro no segundo tópico (sem espaços). Digite Tópico1, 
e então selecione a palavra Tópico1 e esconda-a com o comando Formatar/Fonte/Oculto. A 
seguir selecione a palavra primeiro e formate-a com duplo sublinhado usando o comando 
Formatar/Fonte/Sublinhado/Duplo. Isto irá transformar a palavra primeiro em um link para o 
Tópico 1. Quando o usuário clicar nela, o Tópico 1 será exibido. 
 
 Agora crie dois links como foi feito anteriormente, porém no Tópico 3 e usando as 
palavras primeiro e segundo, e use sublinhado simples ao invés de usar sublinhado duplo. O link 
na palavra primeiro deverá chamar o Tópico 1 e o link na palavra segundo deverá chamar o Tópico 
2. A diferença deste tipo de link para o anterior, é que este não salta diretamente para o tópico, 
mas sim exibe-o em uma janela pop-up. 
 
Criando o tópico de conteúdo 
 
 Até agora já criamos os tópicos do arquivo de ajuda e os links entre eles, agora você 
precisa criar um tópico chamado Conteúdo no seu arquivo de ajuda. Este tópico consiste em 
nada mais do que o título e links para os outros tópicos. 
 
 O compilador de help assume que o tópico de conteúdo é o primeiro no arquivo 
contendo o texto de ajuda, então insira uma quebra de página no começo do seu arquivo. E 
digite o seguinte texto: 
 
Conteúdo do arquivo de ajuda de exemplo 
 
Tópico 1 
 
Tópico 2 
 
TUTORIAL III: ADICIONANDO AJUDA 
PÁGINA: 4 DE 8 
Tópico 3 
 
 Depois disto, crie as notas de rodapé como você já fez anteriormente e nas três use 
apenas o texto Conteúdo. 
 
 Depois das notas de rodapé, basta linkar cada um dos tópicos usando o sublinhado 
duplo. 
 
 Agora, só falta mais uma coisa a fazer antes de passarmos para os arquivos de projeto e 
conteúdo. Você precisa determinar a ordem em que