Editor kontextové nápovědy

Kontextově citlivá nápověda je mechanizmus, který povoluje propojování části uživatelského rozhraní se specifickým tématem nápovědy. Když uživatel aktivuje přidruženou část uživatelského rozhraní, objeví se systémová stránka v oblasti dynamické nápovědy. Uživatelské rozhraní a stránky nápovědy jsou vzájemně přidruženy dvěma způsoby: statický soubor XML nebo dynamický poskytovatel kontextu. Aby byly stránky přidruženy staticky, musí být vytvořen soubor xml kontextové nápovědy. Editor kontextové nápovědy pomáhá při vytváření těchto stránek.

Stránka editoru Definice poskytuje grafický pohled na soubor xml, rozdělený do dvou sloupců. Levý je nazván Kontextová nápověda a zobrazuje prvky xml ve formátu stromu společně s akcemi k jejich přidáním, přesunutím a odebráním. Druhý sloupec poskytuje podrobnější informace o prvku vybraném v levém sloupci a povoluje úpravy podrobností.

Stránka editoru Zdroj poskytuje textové zobrazení souboru xml. Soubor xml lze přímo upravit a změny, jsou-li platné, se odrazí na grafické stránce Definice.

Přidání nových kontextů nápovědy

Editor kontextové nápovědy s vyplněnými poli

Chcete-li přidat nový kontext, klepněte na tlačítko Přidat kontext. Tím se přidá nová kontextová položka do souboru xml a zobrazí se ve stromě na stránce Definice. Nový kontext bude vybrán, čím se v pravém sloupci editoru otevře sekce s podrobnostmi. V této sekci podrobností můžete poskytnout podrobnější informace o kontextu, včetně:

Přidání příkazů a témat nápovědy

Přidání kontextu do souboru poskytne dynamické nápovědě základní popis, který se zobrazí uživateli. Zpravidla budete chtít v systému nápovědy poskytnout další odkazy na související témata. Abyste to mohli udělat, musíte do souboru xml přidat témata a příkazy.

Editor kontextové nápovědy s vyplněnými poli podrobností

Klepnutím na tlačítko Přidat téma přidáte do souboru xml nové téma pod kontexty nápovědy. Téma se uživateli zobrazí jako odkaz. Jakmile je nové téma vytvořeno, můžete je vybrat, a tím otevřít v sekci Podrobnosti témata v pravém sloupci stránky Definice. V sekci s podrobnostmi můžete změnit návěští, které bude zobrazeno uživateli, a umístění souboru, který bude propojen. Propojeným souborem bude ve většině případů stránka html v systému nápovědy. Pro hledání souboru k propojení můžete použít tlačítko Procházet....

Kromě témat můžete také chtít přidat příkaz. Příkaz má pro uživatele stejný vzhled jako téma. Když je ovšem odkaz aktivován, místo otevření souboru se provede kód příkazu. Příkazy lze použít k otevírání stránek předvoleb a k provádění dalších akcí.

Příkaz přidat editoru kontextové nápovědy

Nový příkaz lze přidat klepnutím na tlačítko Přidat příkaz. Podrobnosti příkazu můžete upravit stejným způsobem jako témata.

Příkazy Odebrat, Nahoru, Dolů

Na stránce Definice existují tři další tlačítka umožňující manipulaci s pořadím položek v seznamu kontextů nebo jejich odstranění.

Kontextová nápověda s tlačítky manipulace

Tato tlačítka jsou:

Registrace souboru kontextové nápovědy

Aby mohla platforma Eclipse rozpoznat soubor xml kontextové nápovědy jako zdroj pro dynamický systém nápovědy, musí být zaregistrován pomocí bodu rozšíření org.eclipse.help.contexts. Editor poskytuje způsob, jak soubor kontextové nápovědy registrovat automaticky. V pravém horním rohu editoru je odkaz nazvaný "Registrovat tento soubor kontextové nápovědy". Klepnutí na tento odkaz přidá správný záznam do souboru plugin.xml.