Como criar um novo arquivo CHM

Os arquivos CHM (Compiled HTML Help) são o padrão para documentação de software no Windows. Seja você um desenvolvedor documentando sua aplicação ou um redator técnico, criar um arquivo de ajuda estruturado e navegável é essencial. Este guia irá orientá-lo na criação de um novo projeto CHM usando o CHM Editor.

Nota: Criar arquivos CHM do zero pode ser complexo com ferramentas padrão. O CHM Editor simplifica este processo com uma interface visual e modelos integrados.

1. Instalação e configuração

Primeiro, certifique-se de ter o CHM Editor instalado. Se ainda não o fez, você pode baixar a versão de teste para seguir este tutorial.

Uma vez instalado, inicie o aplicativo. Você será recebido pela tela inicial.

2. Criar um novo arquivo CHM

Para criar um novo arquivo CHM, navegue até Arquivo > Novo no menu superior, ou simplesmente pressione Ctrl+N.

Configuração do arquivo CHM

A caixa de diálogo "Novo arquivo CHM" permite configurar sua documentação. É chamado de "projeto" porque o CHM Editor cria arquivos auxiliares (como configurações do projeto e arquivos HTML fonte) junto com o CHM compilado final:

Caixa de diálogo de propriedades do novo projeto CHM

Nome do projeto: O título interno do seu projeto de ajuda.
Nome do arquivo e localização: Onde seu projeto será salvo.
Idioma: O idioma padrão para seu arquivo de ajuda.
Nome da empresa e site: Metadados opcionais que aparecem nas propriedades do arquivo.
Modelo: Escolha entre os esquemas de cores profissionais integrados:
- Simple Blue — Uma aparência padrão e profissional.
- Simple Green — Uma aparência fresca e moderna.
- Simple Orange — Um estilo quente e energético.

3. Adicionar tópicos

Um arquivo de ajuda consiste em múltiplos tópicos organizados em uma estrutura de árvore. Os tópicos são as páginas individuais da sua documentação pelas quais os usuários navegarão.

Passo 1: Clique no botão Adicionar tópico

Para adicionar um novo tópico, clique no botão + na barra de navegação:

Botão Adicionar tópico na barra de ferramentas do CHM Editor

Passo 2: Configure seu tópico

Na caixa de diálogo que aparece, você pode definir os parâmetros do seu tópico:

Caixa de diálogo de criação de novo tópico

Você tem três opções para criar um tópico:

Criar com novo arquivo: Cria uma nova página HTML em branco para escrever conteúdo. Esta é a opção mais comum ao criar documentação do zero.
Criar sem arquivo: Cria um cabeçalho de seção (pasta) no índice que contém outros tópicos, mas não tem conteúdo próprio. Use para organizar tópicos em grupos lógicos.
Criar com arquivo existente: Vincula um arquivo HTML existente do seu sistema ao projeto. Útil quando você já tem documentação em formato HTML.

Passo 3: Definir o tópico padrão

O tópico padrão é a primeira página que os usuários verão ao abrir seu arquivo CHM. Há duas maneiras de defini-lo:

Opção A: Durante a criação do tópico, marque a caixa "Definir como padrão":

Caixa 'Definir como padrão' durante a criação do tópico

Opção B: Clique com o botão direito em qualquer tópico existente e selecione "Definir como padrão":

Opção 'Definir como padrão' no menu de contexto

Dica: Não se esqueça de definir um tópico padrão — esta é a página que os usuários verão primeiro ao abrir seu arquivo de ajuda.

4. Editar conteúdo

Use o painel do editor para formatar texto, inserir imagens e criar links.

Use a Visualização em árvore à esquerda para organizar a hierarquia dos tópicos.
Use o painel do Editor à direita para editar conteúdo visualmente.

Traduzir seu conteúdo

O CHM Editor inclui tradução integrada alimentada por Google ou Bing. Você pode traduzir seu conteúdo de duas maneiras:

Traduzir texto selecionado: Destaque o texto desejado, escolha o idioma de destino no menu suspenso e clique no botão Traduzir. Isso é útil para traduzir partes da sua documentação enquanto mantém outras partes no idioma original.
Traduzir toda a página: Sem selecionar nenhum texto, simplesmente permaneça na página, escolha o idioma de destino e clique em Traduzir. Todo o conteúdo da página será traduzido preservando toda a formatação e estrutura HTML.

Nota: Tradutores profissionais podem usar o CHM Editor para lidar com arquivos de ajuda como documentos padrão — não é necessário conhecimento de HTML. Todas as tags e formatação são preservadas durante a tradução.

Dica profissional: Você pode exportar seu arquivo de ajuda para formatos PDF ou Word posteriormente se precisar fornecer documentação imprimível.

Com seu projeto configurado, você está pronto para criar documentação abrangente. O CHM Editor lida com o complexo processo de compilação em segundo plano, permitindo que você se concentre em escrever bom conteúdo.