Fórum Criando Help no Delphi #197176

Esse é um tutorial de como fazer um help em hlp.
facinho facinho de ver... faça o que diz aqui e pa pum, ta feito seu help. valeu?

[b:807dcc671f]HELP ao Molho RTF[/b:807dcc671f]

Esse artigo é uma receita que descreve passo a passo o processo de criação de um arquivo de Help para suas aplicações sem a necessidade de um programa gerador.

Os elementos básicos do arquivo de Help são:
Arquivos de Tópico: São os arquivos .RTF que contém os tópicos, os links e os jumps.
Arquivo de Projeto: São arquivos .HPJ que contém informações sobre o projeto
Arquivo de Include para IDContext: São arquivos textos (.H, .INC, .TXT) que contém os ID´s para o VB (opcional)
Arquivo de Conteúdo: São arquivos .CNT que contém um índice com os principais tópicos da Ajuda. (opcional)
Arquivo de Ajuda: São os arquivos .HLP que são gerados a partir dos arquivos acima.

Na ajuda do Help Workshop tem todos os detalhes das características desse arquivos. Dê uma olhada no tópico ´Step-by-Step Procedures´ da ajuda.

Ingredientes:
1. Microsoft Word 97 ou superior (você encontra nas casas do ramo)
2. Microsoft Help Workshop 4.03 ou superior (download no site de Microsoft: http://support.microsoft.com/download/support/mslfiles/Hcwsetup.exe )
3. Bloco de Notas do Windows

Modo de Preparo:
Abra o Word 97 e crie um novo arquivo. Salve no formato RTF
Agora você vai digitar o texto dos tópicos que farão parte do Help. Você pode utilizar as formatações de fonte, cor e paragrafo do Word. Cuidado! Não utilize as ferramentas de desenho ou caixa de texto. O arquivo RTF é um pouco limitado. Procure usar formatações simples porque assim a compilação do Help é mais rápida. As tabelas, por exemplo, serão convertidas para texto tabulado e não serão apresentadas as linhas de grade.

O tópico é identificado por uma quebra de página (CTRL+ENTER)
Todo tópico é iniciado pelas notas de rodapé (Word Menu: Exibir | Notas). São chamandos links.

As notas de rodapé comuns são:
# - Nome do ID do tópico (pode ser IDH_ALGUMACOISA)
$ - Título do Tópico (pode ser ´Meu Tópico´)
K - Entrada no índice do arquivo de help (pode ser ´Meu Tópico´)
Existem outras notas (mais não são necessárias)

Normalmente o conteúdo de $ é igual ao de K para que o índice e o título não fiquem diferentes. Para inserir uma nota de rodapé utilize o menu ´ Inserir | Notas... ´ escolha ´Numeração Personalizada´ e digite na caixa o símbolo (, $ ou K) e então OK. Será criada a nota e você verá a nota em uma janela separada no fim do documento. Se não aparecer use o menu ´ Exibir | Notas ´. Na frente do símbolo da nota escreva o texto correspondente.

Se você definir um ID de tópico começando com IDH_ , você terá que fornecer ao Workshop o valor numérico para esse ID de tópico. Esse valor numérico é aquele que você coloca na propriedade HelpContextID dos formulários e controles do VB. Caso você não queira fornecer essa característica ao Help, use uma outra nomenclatura para os IDs do seu Help como por exemplo TOP_ , assim no momento de compilar o help não haverá erros. Caso você decida colocar os números então você deve criar uma entrada para cada IDs de tópico na seção [MAP] do arquivo de projeto, ou então criar o Arquivo de Include para os IDs e colocar uma referencia a esse arquivo na seção [MAP] do projeto. Você pode acessar essa seção pelo botão MAP no Help Workshop.

Você deve ter pelo menos um tópico no RTF com o ID igual a IDH_CONTENTS e esse será o tópico que será aberto no momento que você chamar o Help a partir do VB. O IDH_CONTENTS já está mapeado no HPJ para o valor 1.

Veja o exemplo abaixo: (Se estiver usando o Word, posicione no parágrafo abaixo e escolha a opção do menu: Exibir | Notas)

# $ K Cadastros

Para cada campo a ser preenchido no sistema será preciso clicar no ícone ´Incluir novo Registro´ situado na barra de ferramenta do sistema, pois caso não seja escolhido tal opção o sistema não aceitará mais que “um” registro.

Clientes e Fornecedores

Para que haja um melhor controle de todos seus clientes ou fornecedores é de extrema importância que seja cadastrado todas as informações contida na opção dos mesmos. Para se cadastrar tais informações, basta escolher no menu de cadastro a sub-opção de “Clientes” ou “Fornecedores”, de acordo com a necessidade de cadastramento de cada um.

{bmc ENDPG.BMP}

A marca de quebra de página deve separar um tópico do outro. As notas # $ K podem ser vistas quando a exibição de nota de rodapé está ativada. Os jumps podem ser identificados por uma formatação de sublinha dupla. Para conseguir a sublinha dupla selecione o texto e use o menu ´Formatar | Fonte... ´ na caixa ´Sublinhado´ escolha ´Duplo´ e pronto. Esse jump é aquele texto em verde que aparece no arquivo de Help que quando você clica pula para outro tópico. Se você quiser pode marcar a cor do texto do jump em verde para identificar no Word, porém não é necessário, pois no arquivo de projeto do Help (.HPJ) você define a cor do jump.

Para que um jump esteja completo você deve definir o tópico para o qual ele irá pular assim que for clicado. Para fazer isso coloque um texto logo em seguida ao jump com o ID do tópico para o qual ele irá. Esse texto fica invisível no Word pois ele é formatado como ´Texto oculto´. Após escrever o ID do tópico marque o texto e use o menu ´Formatar | Fonte...´ e marque a caixa ´Oculto´. Pronto o jump está completo. Se quiser visualizar o jump completo no Word clique no ícone ´mostrar / ocultar (CTRL + *)´ (é aquele ícone com o símbolo ).

Bem, parece complicado mas é fácil, depois que você escrever uns três tópicos verá que não é complicado.

Se você quiser inserir alguma figura no meio do texto pode usar os comandos de macro do Help. Existem vários, mas o mais comum é o de imagem. Coloque o comando {bmc NOMEARQUIVO.BMP} no momento em que você quer que a imagem apareça e pronto. É só copiar o BMP (tem que ser imagem do tipo BMP – Procure usar os BMPs de 16 cores) para o diretório do projeto e está pronto. O Help Workshop diz que compila a imagem que estiver dentro do Word mas eu não aconselho porque o arquivo fica difícil de manusear e além disso o Word tem umas trezentas ferramentas de imagem que só complicam.

Colocando o comando de imagem vinculada no texto fica mais fácil de substituir uma imagem. No exemplo eu uso um BMP simples para o fim de página. O comando ´bmc´ faz com que a imagem siga o alinhamento do parágrafo. Na ajuda do Workshop tem os outros comandos. Não sei ainda com fazer para colocar um texto ao lado de uma figura, se você conseguir me avise!

Ufa!! Tá quase no fim ! :O)

Agora você precisa do arquivo de projeto do Help e do Arquivo de Conteúdo (opcional).

O projeto é um arquivo do tipo .HPJ que pode ser criado no próprio Workshop. Na verdade é um arquivo texto parecido com um arquivo .INI do VB. Estou te mandando em anexo um arquivo .HJP com o mínimo necessário para um arquivo de help, para melhorar dê uma olhada na ajuda do Workshop. Belê?

As referências estão todas para ´Minha Ajuda´. Altere para um nome que deseja. Se alterar alguma referência de arquivo não esqueça de alterar o nome do arquivo. :O)

O arquivo de conteúdo é um arquivo .CNT que contém os tópicos da ajuda no formato padrão do Win 95. Esse arquivo deve ser distribuído junto com o .HLP quando estiver compilado, senão o usuário não poderá ver as “pastinhas”, apenas o arquivo de ajuda como no formato do Win 3.1. Se você está fazendo um help para o Win 3.1 então não precisa desse arquivo, porém precisar deixar definido o IDH_CONTENTS no arquivo de projeto para o valor padrão para que o VB possa mostrar a tela de conteúdo inicial quando você chamar o help (definindo a propriedade HelpContextID do form principal do projeto VB). O valor para ele é 1.

O arquivo CNT pode ser editado no Workshop, é só definir se o elemento é uma pasta ou um tópico, se for um tópico você diz o título que aparece e o ID correspondente no Help. Se for pasta só precisa do título.

Bom, agora está tudo pronto. Não esqueça de colocar tudo num mesmo diretório.
Abra o arquivo .HPJ no Help Workshop e clique no botão ´Save and Compile´.
Misture tudo e leve ao forno do Help Workshop e aguarde alguns minutos.

Ele vai gerar um arquivo .HPL no diretório. No final ele mostra as mensagens de compilação. Se os ERRORS e os WARNINGS forem iguais a zero, beleza, o arquivo está pronto, senão tem que conferir o que está errado de acordo com a mensagem.

Para colocar no VB, é só colocar o nome do arquivo propriedade Help File da pasta de configuração do projeto (não coloque o path, somente o nome. O VB procura no diretório \Windows\Help, \Windows\System e no diretório da aplicação automaticamente). Não esqueça de distribuir os arquivos .HLP e .CNT com a aplicação. Normalmente eles ficam no mesmo diretório de instalação.

Bom Apetite !!!

Microsoft, Windows e Visual Basic são marcas registradas da Mircosoft Corp.

Data: 19 de Agosto de 1999
Autor: Vagner Pagotti
e-mail: gordon@correio.com