Die Erstellung des Beispiels wurde durch die Erstellung der Plug-in- und Dokumentdateien begonnen. Als Nächstes wurden TOC-Dateien erstellt, die den Aufbau des Inhalts beschreiben. Die einzige verbleibende Task ist jetzt die Zusammenführung aller Angaben in einer TOC-Masterdatei und die Aktualisierung der Datei plugin.xml, damit die TOC-Masterdatei tatsächlich ergänzt wird.
Hierzu erstellen Sie zunächst eine Datei toc.xml, um die drei TOC-Dateien zu ergänzen, die Sie bereits erstellt haben. Statt für jedes Thema ein Argument href anzugeben, verwenden Sie das Attribut link, um einen Verweis auf die vorhandenen TOC-Dateien zu erstellen.
<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>
Anschließend wird die Datei plugin.xml aktualisiert, damit die TOC-Masterdatei ergänzt wird:
<extension point="org.eclipse.help.toc"> <toc file="toc.xml" primary="true" /> </extension>
Beachten Sie in diesem Zusammenhang die Verwendung des Attributs
primary. Wenn Sie dieses Attribut auf "true" (= wahr)
setzen, geben Sie an, dass die TOC-Datei immer in der Navigation
angezeigt werden soll, und zwar auch dann,
wenn keine andere TOC-Datei auf sie verweist.
Auf diese Weise wird garantiert, dass die TOC-Masterdatei
immer in der Liste der Themen angezeigt wird.
Diese Datei befindet sich auf der höchsten Ebene der Bücher, da keine
andere TOC-Datei auf sie verweist.
Hinweis:
Falls dieser TOC-Datei weitere Dateien zugeordnet wurden, in der Navigation allerdings nicht vorhanden sind, sondern nur als Links in anderen Themen angezeigt werden, müssten Sie das Attribut extradir in der TOC-Datei verwenden, damit diese Themen für die Suchmaschine verfügbar sind.
Als Letztes müssen Sie die einzelnen TOC-Dateien ergänzen.
<extension point="org.eclipse.help.toc"> <toc file="toc_Concepts.xml" /> <toc file="toc_Tasks.xml" /> <toc file="toc_Reference.xml" /> </extension>
Diese TOC-Dateien werden nicht auf der höchsten Ebene der Bücher angezeigt, weil das Attribut primary nicht angegeben wurde. TOC-Dateien, die nicht mit dem Attribut primary gekennzeichnet werden, werden nur dann in der Dokumentationsstruktur angezeigt, wenn eine andere TOC-Datei, für die dieses Attribut definiert wurde, auf sie verweist oder einen Link zu dieser Datei enthält.
Die Aktualisierung ist hiermit abgeschlossen. Wenn Sie das Plug-in-Verzeichnis in das Verzeichnis plugins der Plattform kopiert haben, die Plattform starten und anschließend die Optionen Hilfe > Inhalt der Hilfetexte auswählen, sollte das Beispiel im Bücherverzeichnis angezeigt werden. Wenn Sie auf die Option "Online Help Sample" klicken, wir die TOC-Struktur angezeigt: