Inhaltsverzeichnis

Kennung: org.eclipse.help.toc

Beschreibung: 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:

Konfigurationsbefehle:

   <!ELEMENT extension (toc*)>

   <!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
   >

Beispiele: Das folgende Beispiel zeigt die Verwendung des Erweiterungspunktes 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"/>
 </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 -Datei. 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 TOC-XML-Dateien können übersetzt werden. Die resultierende Kopie (mit den übersetzten Bezeichnungen) sollte in das Verzeichnis "nl/<sprache>/<land>" oder das Verzeichnis "nl/<sprache>" gestellt werden.  Die Angaben <sprache> und <land> stehen für die zweistelligen Sprachen- und Landescodes, wie sie in Codes für Ländereinstellungen verwendet werden.  Übersetzungen in traditionelles Chinesisch sollten beispielsweise in das Verzeichnis "nl/zh/TW" gestellt werden.  Das Verzeichnis "nl/<sprache>/<land>" hat eine höhere Priorität als das Verzeichnis "nl/<sprache>".  Nur dann, wenn keine Datei im Verzeichnis "nl/<sprache>/<land>" gefunden wird, wird die Datei verwendet, die im Verzeichnis "nl/<sprache>" vorhanden ist.  Zu allerletzt wird dann das Stammverzeichnis eines Plug-ins durchsucht.

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.
 

API-Informationen: Für die Verwendung dieses Erweiterungspunktes wird kein Code benötigt. Es ist lediglich erforderlich, die entsprechenden Manifestdateien bereitzustellen, die in der Datei "plugin.xml" angegeben sind.

Bereitgestellte Implementierung: Die Standardimplementierung der Benutzerschnittstelle für die Hilfefunktion, die durch die Eclipse-Plattform bereitgestellt wird, unterstützt den Erweiterungspunkt toc ohne Einschränkungen.

Copyright (c) 2000, 2003 IBM Corporation und Andere.
Alle Rechte vorbehalten. Dieses Programm und sein Begleitmaterial werden unter den Bedingungen der "Common Public License v1.0" zur Verfügung gestellt, die diese Verteilung begleitet und unter http://www.eclipse.org/legal/cpl-v10.html abgerufen werden kann.