Incorporando sistema de ajuda on-line em aplicações Java – Parte 02

Você precisa estar logado para dar um feedback. Clique aqui para efetuar o login
Para efetuar o download você precisa estar logado. Clique aqui para efetuar o login
Confirmar voto
0
 (0)  (0)

Neste segunda parte deste artigo trataremos sobre tópicos HTML e arquivos como HelpSet, de mapeamentos e da tabela de conteúdo.



Tópicos HTML

As informações a serem disponibilizadas pelo sistema de ajuda devem ser escritas no formato HTML. É importante analisar como as páginas criadas vão se integrar à estrutura de tópicos a ser definida, uma vez que cada tópico da tabela de conteúdo, responsável por exibir informação de ajuda ao usuário, deve estar associado a um arquivo HTML. Outro detalhe é que os arquivos HTML podem conter links para outros arquivos ou imagens.

O código da Listagem 01 apresenta um exemplo de arquivo HTML a ser usado como fonte de informação para um tópico da tabela de conteúdo:

Listagem 01. Arquivo de informação HTML para tópico da tabela de conteúdo

pb_12_06_09_pic02.JPG

Este é um sistema para exemplificação do funcionamento do sistema de ajuda JavaHelp. Ele tem as seguinte funções:

pb_12_06_09_pic03.JPG

Arquivo HelpSet (helpset.hs)

O arquivo helpset é referenciado somente uma vez pela aplicação. Quando o JavaHelp é acionado, ele inicia lendo este arquivo, obtendo desta forma todas as informações necessárias sobre o sistema de ajuda. Por convenção, o nome do arquivo helpset tem extensão .hs. Algumas de suas principais informações:

pb_12_06_09_pic04.JPG

Uma descrição completa de arquivo helpset pode ser encontrada em:
http://docs.sun.com/source/819-0913/author/helpset.html

Na Listagem 02 segue o arquivo helpset para o exemplo em construção.

Listagem 02. Arquivo HelpSet

pb_12_06_09_pic05.JPG


Observe que, para a aplicação de exemplo, estamos definindo apenas duas abas na janela de ajuda: a aba de Tabela de Conteúdo e a a aba de Pesquisa de Conteúdo. Outras opções de abas podem ser incluídas, conforme a documentação do arquivo helpset.

Além disso, estamos definindo apenas as opções de back, forward e print na janela principal de ajuda. Novamente, outras opções podem ser incorporadas.

Arquivo de Mapeamentos (map.jhm)

Quando o JavaHelp é ativado pela aplicação, sua primeira ação é a de ler o arquivo helpset, conforme indicado na seção anterior. O próximo passo, no entanto, é ler o arquivo de mapeamentos indicado no helpset. Neste arquivo estão as associações entre os identificadores (IDs) e as URLs (caminhos para os arquivos HTML de conteúdo). Por convenção, o arquivo de mapeamento tem extensão .jhm.

As tag's que definem seu conteúdo são descritas como segue:

pb_12_06_09_pic06.JPG

Uma descrição completa deste arquivo pode ser encontrada em:
http://docs.sun.com/source/819-0913/author/map.html

Na Listagem 03 segue o arquivo map.jhm para o exemplo em construção:

Listagem 03. Arquivo map.jhm

pb_12_06_09_pic07.JPG

Arquivo da Tabela de Conteúdo (toc.xml)

Este arquivo descreve o conteúdo da aba de table of contents (TOC) e seu layout. As tag's que definem seu conteúdo são descritas como segue:

pb_12_06_09_pic08.JPG

Uma descrição completa deste arquivo pode ser encontrada em:
http://docs.sun.com/source/819-0913/author/toc.html

Na Listagem 04 segue o arquivo toc.xml para o exemplo em construção:

Listagem 04. Arquivo toc.xml

pb_12_06_09_pic09.JPG

 
Você precisa estar logado para dar um feedback. Clique aqui para efetuar o login
Receba nossas novidades
Ficou com alguma dúvida?