Inhaltsverzeichnis

org.eclipse.help.toc

Hier kann eine Ergänzung für die Onlinehilfefunktion eines einzelnen Plug-ins registriert werden.

Ein Plug-in, das Hilfedateien ergänzt, sollte im Allgemeinen Folgendes ausführen:

Optional kann ein Suchindex vordefiniert und registriert werden mit Hilfe des Elements Index, um den ersten Suchversuch durchzuführen. Es kann nur ein Index pro Plug-in registriert werden - mehrere Index-Elemente führen zu einem undefinierten Verhalten.

<!ELEMENT extension (toc* , index?)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED>


<!ELEMENT toc EMPTY>

<!ATTLIST toc

file     CDATA #REQUIRED

primary  (true | false) "false"

extradir CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

path CDATA #REQUIRED>

(Ab 3.1) Ein optionales Element, das die Deklaration eines vordefinierten Suchindex ermöglicht, der aus Dokumenten erstellt wurde, die durch dieses Plug-in beigesteuert wurden .



Das folgende Beispiel verwendet den Erweiterungspunkt toc.

Angaben in der Datei plugin.xml:

 

<extension point=

"org.eclipse.help.toc"

>

<toc file=

"maindocs.html"

primary=

"true"

/>

<toc file=

"task.xml"

/>

<toc file=

"sample.xml"

extradir=

"samples"

/>

<index path=

"index/"

/>

</extension>

(Angaben in der Datei maindocs.xml)

<toc label="Help System Example">
 <topic label="Introduction" href="intro.html"/>
 <topic label="Tasks">
  <topic label="Creating a Project" href="tasks/task1.html">
   <topic label="Creating a Web Project" href="tasks/task11.html"/>
   <topic label="Creating a Java Project" href="tasks/task12.html"/>
  </topic>
  <link toc="task.xml" />
  <topic label="Testing a Project" href="tasks/taskn.html"/>
 </topic>
 <topic label="Samples">
  <topic label="Creating Java Project" href="samples/sample1.html">
   <topic label="Launch a Wizard" href="samples/sample11.html"/>
   <topic label="Set Options" href="samples/sample12.html"/>
   <topic label="Finish Creating Project" href="samples/sample13.html"/>
  </topic>
  <anchor id="samples" />
 </topic>
</toc>


(Angaben in der Datei tasks.xml)

<toc label="Building a Project">
 <topic label="Building a Project" href="build/building.html">
  <topic label="Building a Web Project" href="build/web.html"/>
  <topic label="Building a Java Project" href="build/java.html"/>
 </topic>
</toc>


(Angaben in der Datei samples.xml)

<toc link_to="maindocs.xml#samples" label="Using The Compile Tool">
 <topic label="The Compile Tool Sample" href="compilesample/example.html">
  <topic label="Step 1" href="compilesample/step1.html"/>
  <topic label="Step 2" href="compilesample/step2.html"/>
  <topic label="Step 3" href="compilesample/step3.html"/>
  <topic label="Step 4" href="compilesample/step4.html"/>
 </topic>
</toc>

Wenn es mehrere Dokumente mit einem Pfad beginnend mit "samples" gibt, werden diese nicht im Navigationsbaum angezeigt, sind jedoch über die Suche zugreifbar.  Das liegt am Attribut "extradir" im Element <toc file="sample.xml" extradir="samples" /> inside plugin.xml file. Die Suche etwa nach "Creating Java Project" könnte ein Dokument namens "Other Ways of Creating Java Project" liefern, dessen Pfad samples/sample2.html. lautet.

Internationalisierung Die Dateien 'TOC XML' können übersetzt werden und die daraus resultierende Kopie (mit übersetzten Bezeichnungen)sollte in dem Verzeichnis nl/<language>/<country> oder nl/<language> abgelegt werden.  Die Codes <language> and <country> stand for two letter language and country codes as used in locale codes.  Zum Beispiel sollten Übersetzungen in traditionellem Chinesisch in dem Verzeichnis nl/zh/TW abgelegt werden.  Das Verzeichnis nl/<language>/<country> hat eine höhere Priorität als das Verzeichnis nl/<language>.  Nur wenn keine Datei in dem Verzeichnis nl/<language>/<country> gefunden wird, wird die Datei verwendet, die in dem Verzeichnis nl/<language> abgelegt ist.  Das Stammverzeichnis eines Plug-Ins wird zuletzt gesucht.

Die in doc.zip enthaltene Dokumentation kann durch Erstellen der Datei doc.zip mit den übersetzten Versionen von Dokumenten und durch Stellen von doc.zip in das Verzeichnis
nl/<sprache>/<land> oder nl/<sprache> lokalisiert werden. Die Hilfefunktion sucht nach Dateien in diesem Verzeichnis, bevor das Standardverzeichnis plugin durchsucht wird.
 

Zur Verwendung dieses Erweiterungspunktes ist kein Code erforderlich. Es ist lediglich erforderlich, die entsprechenden Manifestdateien bereitzustellen, die in der Datei plugin.xml angegeben sind.

Die Standardimplementierung der Benutzerschnittstelle der Hilfefunktion, die mit der Eclipse-Plattform ausgeliefert wird, bietet eine vollständige Unterstützung des Erweiterungspunkts toc.