Instalace systému nápovědy jako modul InfoCenter

Instalací modulu InfoCenter a modulů plug-in dokumentace na server můžete svým uživatelům umožnit přístup k systému nápovědy prostřednictvím Internetu či 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 InfoCenter lze použít pro klientské i pro webové aplikace - aplikace obou typů mohou přistupovat ke své nápovědě vzdáleně. Podporovány jsou veškeré funkce systému nápovědy s výjimkou rozevíracích informačních oken a aktivní nápovědy.

Systém nápovědy modulu InfoCenter umožňuje předávání řady voleb, jež lze použít k přizpůsobení různých aspektů modulu InfoCenter. 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 www.eclipse.org.
  2. Instalujte (rozbalte) ovladač do adresáře d:\myApp. Vytvoří se podadresář d:\myApp\eclipse, který obsahuje kód požadovaný platformou Eclipse (který obsahuje systém nápovědy).

Jak spustit nebo zastavit modul InfoCenter z příkazového řádku

Třída org.eclipse.help.standalone.Infocenter má hlavní metodu, která vám umožňuje spouštět modul InfoCenter 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]

Modul InfoCenter spustíte na portu 8081 zadáním příkazu 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

Modul InfoCenter vypnete zadáním příkazu 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í modulu InfoCenter

Spusťte webový server. Zadejte ve webovém prohlížeči cestu webové aplikace "nápovědy" provozované na portu zadaném při spuštění modulu InfoCenter.  Na počítači vybaveném instalací modulu InfoCenter bude cesta http://localhost:8081/help/.

Jak spustit nebo zastavit modul InfoCenter z prostředí Java

Při použití modulu InfoCenter jako součásti jiné aplikace může být příhodnější spouštět a zastavovat tento modul s použitím rozhraní API místo systémových příkazů. V takovém případě postupujte tímto způsobem:

  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řídu použijete ke spouštění a vypínání modulu InfoCenter isorg.eclipse.help.standalone.Infocenter.
  2. Vytvořte pole řetězců obsahující volby, které chcete předat modulu InfoCenter. V běžném případě 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 nápovědy předáním voleb.
    Infocenter infocenter = new Help(options); 
  4. Spuštění systému nápovědy:
    helpSystem.start();
  5. Vypnutí modulu InfoCenter:

    helpSystem.shutdown(); 

Zpřístupnění modulu InfoCenter na webu

Platforma Eclipse obsahuje kompletní modul InfoCenter, a nevyžaduje tak provoz dalšího programového vybavení serveru. Nicméně v nezabezpečeném prostředí, kterým je například Internet, nedoporučujeme přímý přístup klientů k modulu InfoCenter, ale zpřístupnění nápovědy prostřednictvím serveru HTTP nebo aplikačního serveru. Většina serverů je vybavena moduly nebo servlety, které zajišťují předávání určitých požadavků jiným webovým prostředkům. Například modul proxy HTTP serveru Apache lze nastavit tak, aby požadavky odeslané na adresu http://mycompany.com/myproduct/infocenter přesměrovával na adresu http://internalserver:8081/help, na které běží modul InfoCenter. 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 mít v konfiguračním souboru povolenu 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í modulu InfoCenter

Z jediné instalace lze na stroji spustit více instancí modulu InfoCenter. Každá ze spuštěných instancí musí používat svůj vlastní port a mít přidělen vlastní 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 volbou -configuration.

Není-li volba -configuration použita a pokud sdílí konfigurační adresář více instancí modulu InfoCenter tak, že se sady národních prostředí překrývají, musí být zajištěno vytvoření všech vyhledávacích rejstříků jedné instance modulu InfoCenter ještě před spuštěním další instance. Rejstříky jsou uloženy v konfiguračním adresáři a přístupy zápisu jednotlivých procesů modulů InfoCenter nejsou vzájemně synchronizovány.

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

Modul InfoCenter nevyžaduje kompletní balíček  platformy Eclipse. Modul InfoCenter lze provozovat již při použití těchto modulů plug-in (které jsou umístěny 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 dokumentace mohou záviset na jiných modulech plug-in. V takovém případě se zadávají požadované moduly plug-in do souboru plugin.xml daného modulu plug-in. Rovněž takovéto moduly plug-in závislostí musejí být instalovány do modulu InfoCenter. Kromě toho moduly plug-in navržené pro verze Eclipse předcházející verzi 3.0 požadují ke své činnosti přítomnost modulu plug-in org.eclipse.core.runtime.compatibility.

Moduly plug-in modulu InfoCenter lze aktualizovat bez obnoveného spouštění modulu InfoCenter s použitím příkazů vyložených v tématu Aktualizace spuštěného modulu InfoCenter z příkazového řádku. Chcete-li používat tuto funkci, musí minimální sada modulů plug-in obsahovat modul plug-in org.eclipse.update.core.

Další informace o přizpůsobení systému nápovědy viz Systémové předvolby nápovědy.