| Últimas 20 atualizações de THIAGO NASCIMENTO |
|
|
Incorporando sistema de ajuda on-line em aplicações Java – Parte 03
Gerando a busca de conteúdo
A engine da busca de
conteúdo recupera tanto documentos quanto trechos específicos dos documentos em
resposta às consultas do usuário. A base de dados para busca é gerada a partir
da ferramenta jhindexer.jar sobre o
diretório de arquivos de informações HTML. Logo, todos os arquivos de
documentação devem ser salvos num diretório específico.
Neste exemplo, todos os arquivos .html
serão salvos em JH_HOME\javahelp\bin\html.
Para a geração da busca de conteúdo, o seguinte comando deve ser executado:
jhindexer html
onde o parâmetro html constitui o diretório onde a documentação de consulta
(arquivos .html) foi salva. Após a
execução do comando, a base de dados gerada será armazenada no diretório
JavaHelpSearch.
Para testar a busca sobre a base gerada, use a ferramenta jhsearch executando o
comando
jhsearch JavaHelpSearch
O comando retornará solicitando a palavra a ser buscada na base
initialized; enter query
Neste momento, deve ser informada uma palavra a ser pesquisada ou o
caracter . (ponto) para finalizar a busca.
Adicionando JavaHelp à aplicação
A aplicação de exemplo, que terá o JavaHelp incorporado, tem a seguinte
estrutura de pacotes:
O arquivo jhall.jar deve ser
adicionado ao classpath da aplicação.
O conteúdo do diretório JavaHelpSearch, gerado a partir da ferramenta jhindexer, deve ser copiado para o
pacote correpondente na aplicação (com.myapp.help.JavaHelpSearch).
A aplicação de exemplo é constituída de apenas duas entradas de menu. A
primeira entrada correspondendo às operações disponibilizadas pela aplicação, e
a segunda compondo a chamada ao tópico de ajuda. A tela é mostrada na Figura 01 e seu respectivo código na Listagem 05.
Listagem
05. Tela da aplicação.
...
Exibição do post interrompida. Para ler conteúdo completo, clique aqui |
|
|
|
Incorporando sistema de ajuda on-line em aplicações Java – Parte 02
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
Este é um sistema para exemplificação do funcionamento do sistema de ajuda
JavaHelp. Ele tem as seguinte funções:
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:
Uma descrição completa de arquivo helpset pode ser encontrada em:
...
Exibição do post interrompida. Para ler conteúdo completo, clique aqui |
|
|
|
Incorporando sistema de ajuda on-line em aplicações Java – Parte 01
Sistemas de Ajuda
Sistemas de Ajuda (SA) são aquisições relativamente
recentes dos projetos de software. Até 1975, sistemas que apresentassem esse
tipo de funcionalidade eram raros. Atualmente, porém, a disponibilização de um
SA é tida como componente essencial para um bom projeto de software.
Nesse sentido, um SA se encarrega das responsabilidades de prover, de forma
intuitiva, informações que facilitem aos usuários navegar, pesquisar e aprender
a utilizar o sistema do qual a ajuda é parte integrante.
A consideração primária relativa ao projeto de um SA é se este será dinâmico ou
estático. Sistemas de ajuda dinâmicos variam a ajuda oferecida baseando-se
tanto na localização do usuário dentro da aplicação, quanto de suas ações
prévias sobre a mesma. Em contrapartida, os sistemas de ajuda estáticos não
levam em conta essas duas variáveis ao interagir com o usuário. Funcionam como
um guia de referência online onde os termos de entrada são determinados previamente.
Quando a ajuda é requisitada, o usuário tem a oportunidade de obter
esclarecimento do termo desejado, ou selecionar um termo de uma lista provida.
Este artigo se dedicará a analisar um sistema de ajuda estático.
Tecnologia JavaHelp
JavaHelp é tanto uma API quanto um sistema extensível e independente de
plataforma para implementação da ajuda ao usuário em aplicações e geração de
documentação online. É escrito em Java e, portanto, roda em qualquer plataforma
ou browser com suporte ao JRE. Baseado em Swing, o JavaHelp provê uma interface
padrão que habilita tanto desenvolvedores quanto autores a adicionarem uma
ajuda online em suas aplicações.
O sistema JavaHelp é flexível para prover ajuda online em diferentes cenários:
- Aplicações (applet e standalone)
- Componentes JavaBeans
- Applets em páginas HTML
- Aplicações Web.
Diversos aspectos distinguem o JavaHelp de outr
...
Exibição do post interrompida. Para ler conteúdo completo, clique aqui |
|
|
| |
|
12/06/2009 18:00:00
2009
2009
1
0
