Helyzetérzékeny súgótartalom leírása és csomagolása

A tartalomérzékeny súgó az UI kódban deklarált kontextusazonosító és leírás társításával, valamint a kapcsolódó témakörhöz tartozó hivatkozások listájával kerül leírásra az online súgóban.  Ezek a társítások egy XML fájlon belül kerülnek létrehozásra. Tetszőleges számú kontextussúgó társítást tartalmazó XML fájlt hozhat létre minden bedolgozóhoz. A kontextusazonosítók leírása és hivatkozásaik az XML fájlban lévő <kontextus> elemen belül kerülnek létrehozásra. Minden kontextuselem rendelkezhet egy elhagyható <leírás> elemmel, amely leírja az UI objektumot és tetszőleges számú <témakör> elemet, amelyek az online dokumentációra hivatkoznak.

A 3.1 verzió óta a kontextuselemek opcionálisan újradefiniálhatják a Súgónézetben a kontextusinformációk megjelenítésére használt alapértelmezett címet.

<contexts>
	<context id="panic_button" title="Panic Button Title">
		<description>This is the panic button.</description>
		<topic href="tasks/pushing_the_panic_button.htm" label="Pushing the panic button"/>
		<topic href="reference/panic_button.htm" label="Panic Button Reference"/>
	</context>
	...
</contexts>

Ha a kontextus leírásra került az XML fájlban (vagy fájlokban), akkor készen áll a kontextusfájlokra hivatkozásra a bedolgozó leírófájlban.  Ne feledje el, hogy a fenti kontextusazonosító nem teljes képzésű.  Ez engedélyezett, amíg a kontextusfájl biztosítva van a bedolgozó kontextusazonosítót megadó leírófájljában. Más szavakkal a kontextusazonosító feloldásra kerül a bedolgozó azonosítójára, amely közreadta az XML fájlt.  

A bedolgozó az org.eclipse.help.contexts kiterjesztési pont segítségével biztosít kontextusfájlokat.  

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

A kontextusfájlokra más bedolgozókból a plugin attribútum megadásával hivatkozhat. Ennek segítségével az összes dokumentáció, a tartalomérzékeny súgókat is beleértve egy bedolgozóba csoportosítható, és lehet rá hivatkozni az UI kód bedolgozóból vagy más kapcsolódó bedolgozóból.

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

Ahogy láthattuk, nagyfokú rugalmasság biztosított a környezetérzékeny súgó egy vagy több bedolgozóban lévő fájlba rendezéséhez. A fő szempont, hogy a fájlokban lévő kontextusazonosítók megfelelően legyenek feloldva. Ha nem teljes képzésű kontextusazonosítót ad meg, akkor biztosítani kell kontextus XML fájlokat a kontextusazonosítókat deklaráló bedolgozóban.  Ha teljes képzésű kontextusazonosítókat használ a kontextus XML fájlban, akkor teljes rugalmassággal adhatja meg az XML fájlok helyét valamint azt, hogy mely bedolgozó biztosítsa a kontextusokat.

Helyzetérzékeny súgó több bedolgozóból

Másik rugalmassági szint, hogy különböző bedolgozókból lehet azonos kontextusazonosítóhoz helyzetérzékeny súgót biztosítani. Ez például akkor hasznos, ha különböző dokumentáció bedolgozóhalmazok állnak rendelkezésre, amelyek vagy telepítve vannak a felhasználó konfigurációjában, vagy nem.  Ennek segítségével a dokumentáció bedolgozó függetlenül deklarálja a kontextusokat. A végfelhasználó láthatja az összefésült helyzetérzékeny súgótartalmat az összes bedolgozóhoz, amely kontextusokat biztosított a felületi elem azonosítójához.

Ne feledje el, hogy a felületi elem teljes képzésű kontextusazonosítóját kell használni, mivel egyik dokumentáció bedolgozó sem deklarálta a kontextusazonosítót. Ha több bedolgozó biztosít helyzetérzékeny súgókat ugyanahhoz a kontextusazonosítóhoz, akkor a kontextust (az UI bedolgozó) biztosító bedolgozóban megadott tartalom jelenik meg először. További leírások és hivatkozások nem garantált sorrendben kerülnek hozzáfűzésre.