Mxtube Turoriais: criar help com html help workshop

Com dito anteriormente o HTML Help Workshop é um aplicativo que compilar arquivos de ajuda, no formato .chm.

O HTML Help Workshop em utiliza em sua base, arquivos em formato .html, para a composição do conteúdo do seu arquivo.

Ele foi criado para substituir os arquivos de ajuda no padrão Windows (.hlp), sendo descomplicado e dando mais flexibilidade para trabalhar com o conteúdo.

Nesse tópico, vamos demonstrar as configurações básicas para a criação do seu arquivo de ajuda. Configurações avançadas, serão abordados em tópicos posteriores.

A estrutura do seu arquivo de ajuda é composto basicamente por:

Sumário: o sumário é uma relação de tópicos ordenados, que permite a visualização setorizada do conteúdo
Indices: permite relacionar todo o seu conteúdo em um índice com opção de busca
ContextId: Identificação do contexto de ajuda. São códigos numéricos associados as páginas do arquivo de ajuda, que permite o direcionamento a uma pagina especifica, dentro do arquivo de ajuda.

Consideramos que nessa etapa você já realizou as seguintes tarefas

Capturou todas as telas necessárias da aplicação
Todo o manual foi criado em formato .html e devidamente configurado

É recomendavel que no seu conteúdo tenha um arquivo .html que seja um índice de conteúdo, contendo o link para os demais arquivos html. Ele será necessário caso deseja que um arquivo principal seja carregado com seu projeto e permita acesso aos demais.

Vamos colocar a mão na passa.

Primeiro crie a pasta help em c:\, para armazenar nosso projeto.

Execute o HTML Help Workshop através do Iniciar do Windows

Na jenela da aplicação, clique em 'Novo', como demonstra o ícone da imagem abaixo.

Será iniciado o assistente, qual iniciará a criação do seu projeto. Clique na opção 'Project' e clique em 'OK'.

Na próxima janela, clique em 'Next'.

O próximo passo é determina a rota em que seu projeto será gravado. Informe a rota e o nome do arquivo. Não informa sua extensão (como mostra a imagem abaixo), e clique em 'Avançar'.

Exemplo: c:\help\tudo

onde

c:\help corresponde a pasta em que o projeto será gravado

tuto, o nome do arquivo.

Selecione os arquivos que serão criados para o seu projeto.

hhc: arquivo que conterá as informações sobre seu sumário
hhk: arquivo que conterá as informações sobre o seu índice
htm: arquivos html que farão parte do seu projeto
hhp: arquivo do projeto .chm (ele não é exibido nesse formulário)

Informe a pasta aonde o arquio contendo o 'sumário' do seu arquivo de ajuda será armazenado e clique em "Avançar'. Recomendamos utilizar a mesma pasta com os demais arquivos da aplicação

Informe agora o local para o armazenamento do arquivo contendo o índice. Recomendamos utilizar a mesma pasta com os demais arquivos da aplicação.

O próximo passo será selecionar todos os arquivos que farão parte do seu projeto. Par isso, clique em 'Add' e selecione todos os arquivos necessários.

Realizada essa operação, clique em 'Avançar'.

Na ultima janela, clique em 'Concluir', e será carregado o seu projeto, como mostra a imagem abaixo:

Uma vez o seu projeto criado, você verá três abas:

Project: são os dados gerais do seu projeto
Contents: são os dados referente ao sumário do arquivo. Esse por sua vez, permite organizar o conteúdo em blocos, funcionando uma relação de tópicos do seu arquivo de ajuda
Index: são os dados referente aos arquivos disponibilizados, permitindo a realização de consultas no conteúdo

Os componentes 'contents' e 'index' não são obrigatórios na criação do seu arquivo de ajuda, mas eles tornam o arquivo de ajuda criado, muito mais profissional.

Uma vez criado o 'Sumário', ele será apresentado como abaixo, no seu arquivo de ajuda.

Uma vez criado o 'Índice', ele será apresentado como abaixo, no seu arquivo de ajuda.

Vamos agora, configurar os parâmetro de inicialização do nosso arquivo de ajuda.a Isso consiste no arquivo principal que será carregado e título do seu projeto.

Clique em 'Projetc' e em seguida em 'Options', como mostra a imagem abaixo:

Será exibida a janela 'Options'. Nela você realizar as seguintes configurações:

Title: nome que será exibido no cabeçalho do seu arquivo de ajuda
Default file: o arquivo que será carregado na inicialização do arquivo de ajuda

Nesse tópico, não vamos entrar em detalhes sobre as outras opções. Vamos nos ater somente as configurações principais.

Apos realizar essa operação, clique em 'OK'.

O próximo passo agora é criar o nosso sumário. Para isso vamos clicar na aba 'Contents'.

Nosso sumários para ficar com a aparência como demonstrado, devemos criar 02 componentes no mesmo:

Heading: heading, corresponde a uma pasta, que irá abrir as paginas do tópico do sumário
Page: são os arquivos que pertencerão a esse tópico

O primeiro passo é adicionar um 'heading' e associar um ou mais arquivos a ele através de 'Page'

Clique em 'insert a heading':

Clique na guia "General' e informe um nome para o seu tópico em 'Entry titlte'.

Um tópico não precisa ter associação direta de um arquivo. Assim, clique em 'OK'

O seu tópico será adicionado como mostra abaixo.

O próximo passo é adicionar as paginas que farão parte do seu tópico.

Para isso, clique em 'Insert Page'

O processo é muito semelhante ao anterior.

Digite um nome para a sua pagina, em 'Entry title', e em seguida clique em 'add', para associar o arquio html, ao tópico desejada.

Selecione o arquivo desejado, clicando sobre o seu nome e clique em 'OK'.

A configuração final deverá ficar como abaixo:

Clique em 'OK', e sua pagina estará associada ao seu tópico.

Você poderá incluir quantos tópicos desejar, e associar quantos paginas desejar ao seu tópico.

Deverá ser utilizado as teclas de movimento, para que os arquivos associados fiquem como na disposição abaixo, pois eles são anexados aleatoriamente.

O próximo passo agora, é associar seus índices.

Clique na aba 'Index' e clique no botão 'keyword'.

Será exibida um formulário muito parecido com o anterior.

Na aba 'General', informe um nome para o seu índice em 'Keyword'. Em seguida clique em 'add' para associar o arquivo ao 'keyword'.