Pode permitir que os utilizadores tenham acesso ao sistema de ajuda através da Internet ou da intranet, ao instalar um infocenter e os plug-ins de documentação num servidor. Os clientes podem visualizar a ajuda ao navegar para um URL e o sistema de ajuda é apresentado no respectivo browser da Web. O sistema de ajuda do infocenter pode ser utilizado pelas aplicações de clientes e da Web, cuja ajuda pode ser acedida remotamente. Todas as funções do sistema de ajuda são suportadas, excepto a ajuda de contexto, a ajuda activa, o suporte de comando e a vista ajuda.
O sistema de ajuda do infocenter permite a passagem de várias opções que podem ser utilizadas para personalizar vários aspectos do infocenter. São suportadas as seguintes opções:
osgi.instance.area
ou osgi.instance.area.default
. -nl en -locales de en es fr it ja ko pt_BR zh_CN
zh_TW
fará com que o infocenter opere em 10 locales. Todos os outros
locales receberão conteúdo do locale en
. -vmargs -Xmx256M
aumenta a memória
disponível para o infocenter e permite servir uma maior recolha de manuais. Estes passos destinam-se ao integrador do sistema de ajuda e não para visualizar todos os possíveis cenários. Pressupõem-se que toda a documentação é entregue como plug-ins do Eclipse e que o utilizador conhece, de uma forma geral, o sistema de ajuda do Eclipse.
d:\myApp
.
Este procedimento irá criar um sub-directório do eclipse,
d:\myApp\eclipse
que contém o código necessário para a plataforma
do Eclipse (que inclui o sistema de ajuda).
A classe org.eclipse.help.standalone.Infocenter
contém um método
main()
que pode utilizar para lançar o infocenter a partir da
linha de comandos. A sintaxe do sintaxe da linha de comandos é:
-command start | shutdown | [-eclipsehome eclipseInstallPath] [-data instanceArea] [-host helpServerHost] [-locales localeList] [-port helpServerPort] [-dir rtl] [-noexec] [platform options] [-vmargs JavaVMarguments]
Para iniciar um infocenter numa porta 8081, emita um comando start
ao executar
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
ao executar
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
Inicie o infocenter utilizando as instruções acima apresentadas. Indique um
browser da Web para a aplicação da Web "/help" a ser executada numa
porta especificada ao iniciar o infocenter (por exemplo 8081). Por exemplo, a
na máquina na qual o infocenter está instalado, seria http://localhost:8081/help/
.
Ao incluir um infocenter como parte de outra aplicação, poderá ser mais conveniente iniciá-lo e encerrá-lo através da utilização de chamadas da API Java em vez dos comandos de sistemas. Se for o caso, siga os seguintes passos:
d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar
está no caminho da classe da sua aplicação. A classe que utiliza para
iniciar e encerrar o infocenter é org.eclipse.help.standalone.Infocenter
. String
que contenham opções que
pretende transmitir para o suporte do infocenter. Geralmente, são necessárias
as opções eclipsehome
e port
. String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
Help
ao transmitir estas opções. Infocenter infocenter = new Help(options);
helpSystem.start();
helpSystem.shutdown();
O Eclipse contém um infocenter completo e não necessita de qualquer outro
software de servidor para ser executado. Contudo, num ambiente inseguro como a
Internet, não se recomenda a permissão de acesso directo por parte dos
clientes, mas, pelo contrário, disponibilizado através de um servidor HTTP ou
de um servidor da aplicação. A maioria dos servidores inclui módulos ou
servlets utilizados para delegar determinados pedidos a outros recursos da Web.
Por exemplo, um modelo de proxy do Apache HTTP Server pode ser configurado
para redireccionar os pedidos efectuados ao
http://mycompany.com/myproduct/infocenter
e ao
http://internalserver:8081/help
que executa uminfocenter. Conseguirá isso, adicionando as linhas
LoadModule proxy_module modules/ApacheModuleProxy.dll ProxyPass /myproduct/infocenter http://internalserver:8081/help ProxyPassReverse /myproduct/infocenter http://internalserver:8081/help
ao ficheiro conf/httpd.conf
do servidor Apache que executa o
sítio da Web de mycompany.
Algumas versões do servidor Apache HTTP server podem conter directivas AddDefaultCharset activadas no ficheiro de configuração. Remova a directiva ou substitua-a por
AddDefaultCharset Off
para os browsers apresentarem os documentos utilizando o conjunto de caracteres correcto.
É possível executar várias instâncias do infocenter numa máquina a partir de
uma instalação. Cada instância iniciada deve utilizar a sua própria porta e
deve ser fornecida com uma área de trabalho, sendo, por conseguinte, necessário
especificar as opções -port
e -data
. As instâncias
podem proporcionar documentação a partir de conjuntos diferentes de plug-ins,
fornecendo uma configuração de plataforma válida com a opção -configuration
.
Se a opção -configuration
não for utilizada e se o directório de
configuração for partilhado entre instâncias múltiplas do infocenter, com a
sobreposição do conjunto de locales, deve assegurar-se de que todos os índices
de pesquisa são criados por uma instância do infocenter antes de
iniciar outra instância. Os índices são guardados no directório de configuração
e o acesso de escrita não está sincronizado através das instâncias do infocenter.
O suporte Filtragem é desligado ao executar em modo infocenter, tornando todos os conteúdos visíveis, incluindo o conteúdo filtrado. Se pretender alojar a documentação na área de trabalho e nos modos infocenter, deve utilizar os filtros de um modo que faça sentido, mesmo que a filtragem esteja desligada.
O infocenter não necessita do pacote completo da Plataforma do Eclipse. É
possível executar o infocenter com os seguintes plug-ins (localizados no
directó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 poderão conter dependências em outros plug-ins, geralmente ao especificar os plug-ins necessários no respectivo manifesto. Os plug-ins dependentes também têm de ser instalados no infocenter.
Os plug-ins do infocenter podem ser actualizados sem que seja necessário
reiniciar o infocenter, através da utilização dos comandos explicados no tópico
Actualizar um infocenter em
execução a partir da linha de comandos. Para utilizar esta funcionalidade,
o conjunto mínimo de plug-ins tem de incluir o plug-in
org.eclipse.update.core
.
Para mais informações sobre a personalização do sistema de ajuda, consulte o tópico Personalização do produto.