Začali jsme tento příklad vytvořením souboru modulu plug-in a souboru dokumentu. Dále jsme vytvořili soubory s obsahem k popisu uspořádání našeho obsahu. Zbývajícím úkolem je shromáždit všechno dohromady do hlavního obsahu a aktualizovat náš soubor plugin.xml, aby skutečně přispíval do hlavního obsahu.
Začneme vytvořením souboru toc.xml kvůli vložení tří obsahů vytvořených na začátku. Namísto uvedení href pro každé téma, použijeme k odkazu na naše stávající soubory atribut link.
<toc label="Příklad online nápovědy" topic="html/book.html"> <topic label="Concepts"> <link toc="toc_Concepts.xml" /> </topic> <topic label="Tasks"> <link toc="toc_Tasks.xml" /> </topic> <topic label="Reference"> <link toc="toc_Ref.xml" /> </topic> </toc>
Potom aktualizujeme soubor plugin.xml tak, aby přispíval do našeho hlavního obsahu:
<extension point="org.eclipse.help.toc"> <toc file="toc.xml" primary="true" /> </extension>
Všimněte si použití atributu primary. Nastavení tohoto atributu na
true indikuje, že by se obsah měl vždy objevit v navigaci, a to i tehdy,
kdy není odkazován žádným jiným obsahem. Tímto způsobem je zaručeno, že náš "hlavní" obsah vždy zobrazen v seznamu témat. Zobrazí se na nejvyšší úrovni seznamu příruček, jelikož žádný jiný obsah na něj neodkazuje.
Poznámka:
Pokud bylo asociováno více souborů s tímto obsahem, který není v navigaci, pouze na něj vedou odkazy z jiných témat, pak chceme-li mít dostupná tato témata pro vyhledávač, měli bychom použít v obsahu atribut extradir.
Nakonec vložíme naše individuální soubory s obsahem.
<extension point="org.eclipse.help.toc"> <toc file="toc_Concepts.xml" /> <toc file="toc_Tasks.xml" /> <toc file="toc_Reference.xml" /> </extension>
Tyto soubory s obsahem se neobjeví v nejvyšší úrovni seznamu příruček, protože jsme nenastavili atribut primary. Soubory s obsahem, které nejsou označeny jako primární, se objeví na webové stránce dokumentace pouze tehdy, pokud na ně jsou odkazy z některého obsahu, který je primárním obsahem nebo je propojen s primárním obsahem.
To je všechno. Pokud zapůjčíte svůj adresář modulů plug-in do adresářeplugins platformy, spustíte platformu a zvolíte Nápověda->Obsah nápovědy, měli byste vidět svůj příklad v seznamu příruček. Jestliže klepnete na "Příklad online nápovědy", uvidíte strukturu svého obsahu: