Popisování a balení obsahu kontextově citlivé nápovědy

Kontextově citlivá nápověda se popisuje pomocí přiřazení ID kontextu deklarovaného v kódu uživatelského rozhraní k popisu a seznamu odkazů na související témata v online nápovědě.  Tato přiřazení jsou provedeny uvnitř souboru XML.  Pro každý z modulů plug-in můžete vytvořit libovolný počet souborů XML obsahujících přiřazení kontextu nápovědy.  Popis a odkazy pro každé ID kontextu jsou vnitř prvků <context> v souboru XML.  Každý prvek popisu může mít volitelný prvek<description>, který se používá k popisu uživatelského rozhraní objektu, a libovolný počet prvků <topic>, které odkazují na online dokumentaci.

Od verze 3.1 mohou prvky kontextu volitelně potlačit výchozí název použitý k reprezentaci informace kontextově citlivé nápovědy v pohledu Nápověda.

<contexts>
	<context id="panic_button" title="Název nouzového tlačítka">
		<description>Toto je nouzové tlačítko.</description>
		<topic href="tasks/pushing_the_panic_button.htm" label="Stisk nouzového tlačítka"/>
		<topic href="reference/panic_button.htm" label="Odkaz na nouzové tlačítko"/>
	</context>
	...
</contexts>

Jakmile jsou kontexty popsány v souboru nebo souborech XML, můžete se odkazovat na kontextové soubory ve svém manifestu modulu plug-in.  Vezměte na vědomí, že výše uvedené ID kontextu není plně kvalifikované.  Je to povoleno, pokud kontextový soubor přispívá do souboru typu manifest modulu plug-in, který definuje ID kontextu.  Jinak řečeno, ID kontextu je vyřešeno do ID modulu plug-in, do kterého přispěl soubor XML.  

Modul plug-in přispívá kontextovými soubory pomocí bodu rozšířeníorg.eclipse.help.contexts.  

   <extension point="org.eclipse.help.contexts">
      <contexts name="myContextHelp.xml"  />
    </extension>

Můžete použít odkaz na kontextové soubory z jiných modulů plug-in pomocí začlenění atributu plugin.  To vám umožňuje seskupit celou svou dokumentaci včetně kontextově citlivé nápovědy do jediného modulu plug-in a odkazovat na ni z modulu plug-in kódu uživatelského rozhraní nebo z jiného souvisejícího modulu plug-in.

   <extension point="org.eclipse.help.contexts">
      <contexts name="myContextHelp.xml" plugin="com.example.helpExample"  />
    </extension>

Jak je patrné, že máte velkou volnost při organizování svých kontextů do jednoho nebo několika souborů obsažených v jednom nebo více modulech plug-in.  Nejdůležitější je, aby se ID kontextů v souborech vyřešila správně.  Pokud neúplně kvalifikujete ID kontextu, pak musíte vkládat kontextové soubory XML do modulu plug-in, který deklaroval ID kontextů.  Pokud ve svém kontextovém souboru XML použijete plně kvalifikované ID kontextu, máte úplnou volnost ohledně umístění svých souborů XML a toho, který modul plug-in vkládá obsah.

Kontextově citlivá nápověda skupiny modulů plug-in

Dalším stupněm volnosti je schopnost vkládat kontextově citlivou nápovědu téhož kontextu různými moduly plug-in.  Toto je užitečné například tehdy, kdy existují různé sady dokumentačních modulů plug-in, které mohou nebo nemusejí být instalovány v uživatelově konfiguraci.  To umožňuje, aby každý dokumentační modul plug-in deklaroval svůj obsah nezávisle.  Koncový uživatel uvidí sloučený obsah kontextově citlivé nápovědy pro všechny moduly plug-in, které pro ID prvku widget poskytly kontexty.

Vezměte na vědomí, že se musí použít plně kvalifikované ID kontextu pro prvek, jelikož žádný z dokumentačních modulů plug-in nedeklaroval ID kontextu.  Pokud více modulů plug-in přispívá kontextově citlivou nápovědou pro tentýž kontext, zobrazuje se nejprve obsah určený modulem plug-in, který deklaroval kontext (modul plug-in uživatelského rozhraní).  Pořadí dalších připojených popisů a odkazů není zaručeno.