Informační centrum

Instalací Informačního centra a modulů plug-in dokumentace na server můžete povolit svým uživatelům přístup do systému nápovědy prostřednictvím internetu nebo intranetu. Klienti zobrazují nápovědu vyhledáním adresy URL. Systém nápovědy je zobrazen v jejich webovém prohlížeči. Systém nápovědy Informačního centra lze používat pro klientské i webové aplikace. Aplikace obou typů mohou přistupovat ke své nápovědě vzdáleně. Jsou podporovány všechny funkce systému nápovědy kromě kontextové nápovědy, aktivní nápovědy, podpory příkazů a pohledu Nápověda.

Systém nápovědy Informačního centra umožňuje předávání řady voleb, jež lze použít k přizpůsobení různých aspektů Informačního centra. Podporovány jsou tyto volby:

Instalace/balení

Popsané úkony jsou určeny pro integrátora systému nápovědy a neuvádějí všechny možné situace. Předpokládejme, že je veškerá vaše dokumentace dodána v podobě modulů plug-in Eclipse a že jste obecně obeznámeni se systémem nápovědy Eclipse.

  1. Stáhněte binární ovladač běhové komponenty platformy Eclipse z adresy eclipse.org.
  2. Instalujte (rozbalte) ovladač do adresáře, řekněme d:\myApp. Vytvoří se podadresář Eclipse, d:\myApp\eclipse, který obsahuje kód požadovaný platformou Eclipse (který obsahuje systém nápovědy).

Jak spustit nebo ukončit Informační centrum z příkazového řádku

Třída org.eclipse.help.standalone.Infocenter má metodu main(), kterou můžete používat ke spuštění Informačního centra z příkazového řádku. Syntaxe argumentů příkazového řádku:

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

Chcete-li spustit Informační centrum na portu 8081, vyšlete příkaz start spuštěním

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

Chcete-li ukončit Informační centrum, vyšlete příkaz shutdown spuštěním

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

Použití Informačního centra

Spusťte Informační centrum pomocí výše uvedených pokynů. Zadejte ve webovém prohlížeči cestu webové aplikace "/help" provozované na portu zadaném při spuštění Informačního centra (např. 8081). Například na počítači s nainstalovaným Informačním centrem bude tato cesta http://localhost:8081/help/.

Jak spustit nebo ukončit Informační centrum z prostředí Java

Při použití Informačního centra jako součásti jiné aplikace může být výhodnější spouštět a ukončovat Informační centrum pomocí volání API Java místo systémových příkazů. V tom případě postupujte podle kroků:

  1. Ujistěte se, že v cestě ke třídě vaší aplikace máte d:\myApp\eclipse\plugins\org.eclipse.help.base_3.1.0.jar . Třída, která se používá ke spouštění a vypínání Informačního centra, je org.eclipse.help.standalone.Infocenter.
  2. Vytvořte pole objektů String obsahující volby, které chcete předat Informačnímu centru. Zpravidla jsou zapotřebí volby eclipsehome a port.
    String[] options = new String[] { "-eclipsehome", "d:\\myApp\\eclipse" , "-port", "8081" };
  3. Ve své aplikaci vytvořte instanci třídy Help předáním voleb.
    Infocenter infocenter = new Help(options);
  4. Spuštění systému nápovědy:
    helpSystem.start();
  5. Vypnutí Informačního centra:
    helpSystem.shutdown();

Zpřístupnění Informačního centra na webu

Platforma Eclipse obsahuje kompletní Informační centrum, a nevyžaduje tak spuštění žádného jiného softwaru serveru. Nicméně, v nezabezpečeném prostředí, jakým je například Internet se nedoporučuje umožnit přímý přístup klientů. Místo toho se doporučuje zpřístupnit Informační centrum prostřednictvím serveru HTTP nebo aplikačního serveru. Většina serverů je vybavena moduly nebo servlety pro delegování určitého požadavku na jiné webové prostředky. Naříklad modul proxy HTTP serveru Apache lze konfigurovat tak, aby požadavky odeslané na adresu http://mycompany.com/myproduct/infocenter přesměrovával na adresu http://internalserver:8081/help, kde je spuštěno Informační centrum. Tento úkol lze provést přidáním řádků

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

do souboru conf/httpd.conf serveru Apache, který provozuje webovou stránku mycompany.

Některé verze HTTP serveru Apache mohou v konfiguračním souboru obsahovat povolenou direktivu AddDefaultCharset. Odebráním této direktivy nebo jejím nahrazením direktivou

AddDefaultCharset Off

dosáhnete zobrazení dokumentů v prohlížeči s použitím správné znakové sady.

Spuštění vícenásobných instancí Informačního centra

Z jedné instalace lze na počítači spustit více instancí Informačního centra. Každá ze spuštěných instancí musí používat svůj vlastní port a mít přidělen pracovní prostor, tj. musejí být zadány volby -port a -data. Instance mohou poskytovat dokumentaci z různých sad modulů plug-in zadáním platné konfigurace platformy pomocí volby -configuration.

Pokud volba -configuration není použita a sdílí konfigurační adresář více instancí Informačního centra tak, že se překrývají sady národních prostředí, musíte zajistit vytvoření všech vyhledávacích rejstříků jedné instance Informačního centra ještě před spuštěním další instance. Rejstříky jsou uloženy v konfiguračním adresáři a přístupy pro zápis jednotlivých instancí Informačního centra nejsou vzájemně synchronizovány.

Filtrování

V režimu Informačního centra je podpora filtrování vypnutá, což způsobí, že bude viditelný všechen obsah, včetně filtrovaného obsahu. Pokud zamýšlíte používat dokumentaci v režimech pracovní plochy i Informačního centra, měli byste filtry použít způsobem, který dává smysl i při vypnutém filtrování.

[Optional] Instalace minimální sady modulů plug-in.

Informační centrum nevyžaduje celý balíček platformy Eclipse. Informační centrum lze spustit již s následujícími moduly plug-in (které se nachází v adresáři 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

Některé moduly plug-in mohou záviset na jiných modulech plug-in. Požadované moduly plug-in jsou obvykle uvedeny v manifestech balíku. Rovněž takovéto moduly plug-in závislostí musejí být instalovány do Informačního centra.

Moduly plug-in Informačního centra lze aktualizovat bez restartování Informačního centra pomocí příkazů vysvětlených v tématu Aktualizace spuštěného Informačního centra z příkazového řádku. Chcete-li používat tuto funkčnost, musí minimální sada modulů plug-in obsahovat rovněž modul plug-in org.eclipse.update.core.

Podrobnější informace o přizpůsobení systému nápovědy najdete v části Přizpůsobení produktu.