Infocenter

Você pode permitir que os usuários acessem o sistema de ajuda pela Internet ou em uma intranet instalando um infocenter e os plug-ins de documentação em um servidor. Os clientes visualizam a ajuda navegando em um URL, e o sistema de ajuda é mostrado no navegador da Web. O sistema de ajuda do infocenter pode ser utilizado para aplicativos cliente e da Web, sendo que qualquer deles pode ter sua ajuda acessada remotamente. Todos os recursos do sistema de ajuda, exceto ajuda de contexto, ajuda ativa, suporte de comando e a visualização de ajuda, são suportados.

O sistema de ajuda do infocenter permite transmitir várias opções que podem ser utilizadas para personalizar vários aspectos do infocenter. As seguintes opções são suportadas:

Instalação/Compactação

Essas etapas são destinadas ao integrador do sistema de ajuda e não se destinam a endereçar todos os cenários possíveis. Supõe-se que toda sua documentação seja entregue como plug-ins do Eclipse e, geralmente, que você esteja familiarizado com o sistema de ajuda do eclipse.

  1. Faça download do driver Eclipse Platform Runtime Binary em eclipse.org.
  2. Instale (descompacte o arquivo zip) o driver em um diretório, ou seja d:\myApp. Isso criará um subdiretório do eclipse, d:\myApp\eclipse, que contém o código requerido pela plataforma Eclipse (que inclui o sistema de ajuda).

Como Iniciar ou Parar o Infocenter na Linha de Comandos

A classe org.eclipse.help.standalone.Infocenter tem um método main() que você pode utilizar para ativar o infocenter na linha de comandos. A sintaxe de argumento da linha de comando é:

-command start | shutdown | [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]

Para iniciar um infocenter na porta 8081, emita um comando start executando

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command start -eclipsehome d:\myApp\eclipse -port 8081

Para encerrar o infocenter, emita um comando shutdown executando

java -classpath d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar org.eclipse.help.standalone.Infocenter -command shutdown -eclipsehome d:\myApp\eclipse

Utilizando o Infocenter

Inicie o infocenter utilizando as instruções anteriores. Aponte um navegador da Web para o aplicativo da Web "/help" que está em execução na porta especificada ao iniciar o infocenter (por exemplo, 8081). Por exemplo, na máquina na qual o infocenter está instalado, isso seria http://localhost:8081/help/.

Como Iniciar e Parar um Infocenter no Java

Ao incluir um infocenter como parte de outro aplicativo, talvez seja mais conveniente iniciá-lo e pará-lo utilizando chamadas de API Java em vez de utilizar comandos do sistema. Se esse for o caso, siga as etapas:

  1. Certifique-se de que d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar esteja no caminho de classe do aplicativo. A classe utilizada para iniciar e encerrar o infocenter é org.eclipse.help.standalone.Infocenter .
  2. Crie uma matriz de objetos de Cadeia contendo as opções que você deseja transmitir ao infocenter. Normalmente, as opções eclipsehome e port são necessárias.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
  3. No aplicativo, crie uma instância da classe de Ajuda transmitindo as opções.
    Infocenter infocenter = new Help(options);
  4. Para iniciar o sistema de ajuda:
    helpSystem.start();
  5. Para encerrar o infocenter:
    helpSystem.shutdown();

Tornando o Infocenter Disponível na Web

O Eclipse contém um infocenter completo e não exige a execução de nenhum outro software de servidor. Entretanto, em um ambiente não seguro, como a Internet, não é recomendável permitir acesso direto pelos clientes, mas disponível por meio de um servidor HTTP ou de um servidor de aplicativos. A maioria dos servidores vem com módulos ou servlets para delegar determinado pedido a outros recursos da Web. Por exemplo, um pode configurar um módulo de proxy do Apache HTTP Server para redirecionar os pedidos feitos ao http://mycompany.com/myproduct/infocenter para o http://internalserver:8081/help que executa um infocenter. A adição das linhas

LoadModule proxy_module modules/ApacheModuleProxy.dll
ProxyPass /myproduct/infocenter http://internalserver:8081/help
ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help

ao arquivo conf/httpd.conf do servidor Apache que está executando o Web site de mycompany faz isso.

Algumas versões do servidor Apache HTTP podem conter uma diretiva AddDefaultCharset ativada no arquivo de configuração. Remova a diretiva ou substitua-a por

AddDefaultCharset Off

para que os navegadores exibam documentos utilizando o conjunto de caracteres correto.

Executando Várias Instâncias de um Infocenter

Várias instâncias de um infocenter podem ser executadas em uma máquina de uma só instalação. Cada instância iniciada deve utilizar sua própria porta e receber um espaço de trabalho; por isso, as opções -port e -data devem ser especificadas. As instâncias podem atender a documentação de diferentes conjuntos de plug-ins fornecendo a uma configuração de plataforma válida a opção -configuration.

Se -configuration não for utilizado e o diretório de configuração for compartilhado entre as diversas instâncias do infocenter com sobreposição de conjuntos de códigos de idioma, certifique-se de que todos os índices de procura sejam criados por uma única instância do infocenter antes que outra instância seja iniciada. Índices são salvos no diretório de configuração, e o acesso de gravação não é sincronizado em todas as instâncias do infocenter.

Filtragem

O suporte de filtragem é desativado quando da execução no modo do infocenter, fazendo com que todo conteúdo, inclusive o filtrado, fique visível. Se você planeja hospedar sua documentação nos modos ambiente de trabalho e infocenter, utilize filtros de maneira que faça sentido mesmo com a filtragem desativada.

[Opcional] Instalando um Conjunto Mínimo de Plug-ins

O infocenter não exige todo o pacote de Plataforma Eclipse. É possível executar um infocenter com os seguintes plug-ins (localizados no diretório eclipse\plugins):

org.apache.lucene
org.eclipse.core.runtime
org.eclipse.help
org.eclipse.help.appserver
org.eclipse.help.base
org.eclipse.help.webapp
org.eclipse.osgi
org.eclipse.tomcat
org.eclipse.update.configurator

Alguns plug-ins de documentação podem ter dependências de outros plug-ins, normalmente especificando os plug-ins requeridos em seu manifesto de pacote configurável. Os plug-ins dependentes precisam ser instalados no infocenter igualmente.

Os plug-ins do Infocenter podem ser atualizados sem reiniciar o infocenter, utilizando os comandos explicados no tópico Atualizando um Infocenter em Execução na Linha de Comandos. Para utilizar essa funcionalidade, o conjunto mínimo de plug-ins também deverá incluir o plug-in org.eclipse.update.core .

Consulte o tópico Customização do Produto para obter informações adicionais sobre como customizar o sistema de ajuda.