Produtividade e Rapidez na Construção do Help Online

Como Usar o

Agenda

Mostraremos neste breve tutorial como criar e integrar um help online em sua aplicação Java utilizando o Hhelp.

Hhelp é um site que disponibiliza o serviço de criação automática do help online convertendo documentos em formato OpenOffice para o formato JavaHelp™.

Os potenciais dessa ferramenta são a facilidade de criação e manutenção do help online aliada a uma qualidade profissional do resultado.

Além disso é gratuíto.

Etapas

Elaborar os documentos de help no OpenOffice

Acessar o site Hhelp e submeter os documentos de help

Visualizar e baixar o help online gerado

Integrar o help online em sua aplicação

1 – Elaborar os documentos de help no OpenOffice

Iremos apresentar nessa etapa como elaborar a documentação do help utilizando para isso o OpenOffice.

Caso não disponha do OpenOffice baixe-o no site oficial www.openoffice.org .

Essa documentação do help em formato OpenOffice será a entrada para obtermos o helponline utilizando a ferramenta Hhelp.

Vamos começar!

Abra o editor de texto OpenOffice ou BrOffice para começar a edição do seu documento de Help Online no idioma português (Brasil).

Comece a digitar o título do primeiro tópico do help.

Iremos selecionar o tópico para aplicar um estilo.

Aplicaremos o estilo pré-definido Título 1 (tópico de nível 1).

Pronto! Seu primeiro tópico de help foi criado.

Digitamos a seguir um texto para o tópico 'Título 1'.

Criaremos agora um novo tópico estruturado hierarquicamente abaixo do anterior (nível 2).

Selecionamos o tópico para aplicar o estilo pré-formatado Título 2 de nível 2.

Aplicamos o estilo 'Título 2'.

O tópico de nível 2 foi criado.

Digitamos um conteúdo de texto associado ao tópico 'Título 1.1'.

Iremos inserir na sequência do corpo de texto do segundo tópico uma imagem.

Imagem inserida!A seguir posicionamos o cursor para o final do documento.

Iremos definir uma referência cruzada para o tópico 'Título 1'.

Selecione o tipo 'Definir referência' e especifique o nome da referência a ser criada, no caso 'titulo1'.

A referência cruzada foi definida, conforme a visualização.

Uma referência cruzada remetendo para 'Título 1' será' criada aqui.

Basta criarmos agora uma referência cruzada apontando para a referência anteriormente definida.

Criamos a referência Cruzada para o primeiro tópico 'Título 1'.

Pronto! Ao clicarmos nesta referência 'Título 1' seremos redirecionados para o primeiro tópico ao início do documento.

O arquivo de help em português (Brasil) está pronto. Agora basta salvá-lo.

Seguindo os mesmos passos anteriormente criamos este novo documento agora no idioma inglês.

2 – Acessar o site Hhelp e submeter os documentos de help

Geramos na etapa anterior dois documentos de help, um para cada idioma: português (padrão) e inglês.

Nesta etapa iremos mostrar como configurar o Hhelp para processar esses documentos e gerar o help.

Criado os documentos do help vamos acessar o site www.hhelp.com.br

Especifique o documento de help em português (idioma padrão).

Agora especifique o documento help em inglês.

Selecione o idioma inglês.

Clique a seguir no botão Enviar.

3 – Visualizar e baixar o help online gerado

Neste ponto seu help acabou de ser gerado. Agora ensinaremos como visualizar o help gerado e baixá-lo em seu computador.

Seu help foi gerado. Vamos visualizá-lo clicando no botão Help de cada idioma.

Clicar no botão Help do idioma padrão.

Esta é a versão do help gerado em idioma português (padrão).

Clicar no botão Help do idioma Inglês.

Esta é a versão do help gerado em idioma inglês.

A seguir, basta baixar o help gerado compactado em formato JAR.Clique no link Download Help

Salvando o help em seu computador.

Abrindo o help compatado em formato jar notamos que segue o padrão JavaHelp™.

4 – Integrando o Help em sua Aplicação

Apresentamos a seguir código exemplo em java de como integrar o help online criado com o Hhelp em sua Aplicação.

Abra sua IDE preferida e digite o código abaixo. Em nosso caso usamos a IDE Eclipse.

Aqui a continuação do código.

E aqui a terceira e última parte do código.

Inclua no classpath o arquivo jh.jar fornecido no pacote javahelp e o help.jar gerado pelo Hhelp.

Executando o código digitado será aberta esta tela. O objetivo é demonstrar a integração do help criado com o Hhelp em sua aplicação Java.

Ao clicar no item de menu 'Help Topics' será aberto o help

Dúvidas?

Basta acessar o site:

www.hhelp.com.br

Hhelp Teamhhelp.online@gmail.com