Wypełnianie manifestu modułu dodatkowego

W tym przykładzie rozpoczęliśmy od utworzenia modułu dodatkowego i plików dokumentacji. Następnie utworzyliśmy pliki spisu treści (toc) opisujące organizację treści dokumentacji. Teraz należy umieścić te elementy w głównym pliku spisu treści i zaktualizować plik plugin.xml w celu dodania tego pliku. 

Zaczynamy od utworzenia pliku toc.xml, aby dodać do niego trzy pliki spisu treści utworzone na początku. Zamiast używać elementu href dla każdego tematu pomocy, użyjemy atrybutu link do odwołania się do istniejących już plików spisu treści.

<toc label="Online Help Sample" 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>

Następnie zaktualizujemy plik plugin.xml przez dodanie głównego pliku spisu treści:

   <extension point="org.eclipse.help.toc">
      <toc file="toc.xml" primary="true" />
    </extension>

Należy zwrócić uwagę na użycie atrybutu primary. Nadanie temu atrybutowi wartości true wskazuje, że dany spis treści powinien być zawsze widoczny w obszarze nawigacji, nawet jeśli żaden inny plik spisu treści nie odwołuje się do niego. W ten sposób dany "główny" spis treści będzie zawsze wyświetlany na liście tematów pomocy. Jest on wyświetlany na najwyższym poziomie listy podręczników, ponieważ żaden inny spis treści nie odwołuje się do niego. 
Uwaga
: Jeśli z danym plikiem spisu treści powiązanych jest więcej plików, które nie są widoczne w obszarze nawigacji, ale w innych tematach pomocy istnieją odsyłacze do nich, to aby udostępnić te tematy mechanizmowi wyszukiwania, należy w spisie treści użyć atrybutu extradir.

W końcu dodajemy indywidualne pliki spisu treści.

   <extension point="org.eclipse.help.toc">
       <toc file="toc_Concepts.xml" />
       <toc file="toc_Tasks.xml" />
       <toc file="toc_Reference.xml" />
    </extension>

Te pliki spisu treści nie będą wyświetlane na najwyższym poziomie listy podręczników, ponieważ nie ustawiono atrybutu primary. Pliki spisu treści, które nie są oznaczone jako primary, zostaną wyświetlone w sieci dokumentacji tylko wówczas, gdy odwołuje się do nich inny główny plik spisu treści lub gdy w głównym pliku spisu treści istnieje do niego odsyłacz.

I to już wszystko. Aby zobaczyć przykład na liście podręczników, należy skopiować katalog modułu dodatkowego do katalogu plugins platformy, uruchomić platformę, a następnie wybrać opcję Pomoc -> Spis treści pomocy. Po kliknięciu pozycji Online Help Sample wyświetlona zostanie struktura spisu treści:

Przykładowa struktura podręczników w przeglądarce pomocy elektronicznej