Inhoudsopgave

org.eclipse.help.toc

Voor het registreren van online Help voor afzonderlijke plugins.

Voor elke plugin met helpbestanden geldt over het algemeen het volgende:

U kunt eventueel een zoekindex vooraf bouwen en registreren met het element index, zodat u een eerste zoekopdracht kunt uitvoeren. Per plugin kunt u één index registreren; het definiëren van meerdere index-elementen leidt tot onvoorspelbaar gedrag.

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

category CDATA #IMPLIED>


<!ELEMENT index EMPTY>

<!ATTLIST index

path CDATA #REQUIRED>

(vanaf 3.1) Een optioneel element waarmee u vooraf gebouwde zoekindices kunt declareren die zijn gemaakt op basis van documenten die door deze plugin zijn toegevoegd.



Dit is een voorbeeld van de extensie toc:

(in bestand plugin.xml)

 

<extension point=

"org.eclipse.help.toc"

>

<toc file=

"toc1.xml"

primary=

"true"

/>

<toc file=

"toc2.xml"

primary=

"true"

category=

"mijnCategorie"

/>

<toc file=

"task.xml"

/>

<toc file=

"sample.xml"

extradir=

"samples"

/>

<index path=

"index/"

/>

</extension>

(in bestand maindocs.xml)

<toc label="Voorbeeld van Help-systeem">
 <topic label="Inleiding" href="intro.html"/>
 <topic label="Taken">
  <topic label="Een project maken" href="tasks/task1.html">
   <topic label="Een webproject maken" href="tasks/task11.html"/>
   <topic label="Een Java-project maken" href="tasks/task12.html"/>
  </topic>
  <link toc="task.xml" />
  <topic label="Een project testen" href="tasks/taskn.html"/>
 </topic>
 <topic label="Voorbeelden">
  <topic label="Een Java-project maken" href="samples/sample1.html">
   <topic label="Een wizard starten" href="samples/sample11.html"/>
   <topic label="Opties instellen" href="samples/sample12.html"/>
   <topic label="Het maken van een project voltooien" href="samples/sample13.html"/>
  </topic>
  <anchor id="samples" />
 </topic>
</toc>


(in bestand tasks.xml)

<toc label="Een project bouwen">
 <topic label="Een project bouwen" href="build/building.html">
  <topic label="Een webproject bouwen" href="build/web.html"/>
  <topic label="Een Java-project bouwen" href="build/java.html"/>
 </topic>
</toc>


(in bestand samples.xml)

<toc link_to="maindocs.xml#samples" label="Het compileerprogramma gebruiken">
 <topic label="Voorbeeld van het compileerprogramma" href="compilesample/example.html">
  <topic label="Stap 1" href="compilesample/step1.html"/>
  <topic label="Stap 2" href="compilesample/step2.html"/>
  <topic label="Stap 3" href="compilesample/step3.html"/>
  <topic label="Stap 4" href="compilesample/step4.html"/>
 </topic>
</toc>

We gaan er in dit voorbeeld vanuit dat er meer documenten zijn waarvan het pad met "samples" begint. Deze worden niet afgebeeld in de navigatiestructuur maar kunnen wel doorzocht worden. Dit gedrag is ingesteld door het kenmerk "extradir" in het element <toc file="sample.xml" extradir="samples" /> in het bestand plugin.xml. Als u bijvoorbeeld zoekt naar "Een Java-project maken", kunt u het document "Een Java-project maken op andere manieren" (waarvan het pad samples/sample2.html is) opsporen.

Internationalisering De XML-inhoudsopgavebestanden kunnen worden vertaald. Vertaalde versies (met vertaalde labels) moeten in de directory's nl/<taal>/<land> of nl/<taal> worden geplaatst. De <taal> en het <land> worden aangeduid door een code van twee letters (zoals in locales). Een vertaling in traditioneel Chinees moet bijvoorbeeld in de directory nl/zh/TW worden geplaatst. De directory nl/<taal>/<land> heeft meer prioriteit dan nl/<taal>. Het bestand in de directory nl/<taal> wordt alleen gebruikt als de directory nl/<taal>/<land> leeg is. De hoofddirectory van de plugin wordt als laatste doorzocht.

U kunt de documentatie in het bestand doc.zip lokaliseren door de vertaalde versies in te pakken in het bestand doc.zip en dit ZIP-bestand in de directory nl/<taal>/<land> of nl/<taal> te plaatsen. Het Help-systeem zoekt eerst naar de bestanden in deze directory's voordat de plugindirectory als standaardinstelling wordt gebruikt.
 

Voor dit extensiepunt is geen code nodig. U hoeft alleen de juiste manifestbestanden te leveren, die in het bestand plugin.xml zijn vermeld.

De standaardimplementatie van de Help-systeeminterface, die bij het Eclipse-platform wordt geleverd, biedt volledige ondersteuning voor het extensiepunt toc.