Indholdsfortegnelse (TOC)

org.eclipse.help.toc

Til registrering af en onlinehjælplevering til en individuel plugin.

Hver enkelt plugin, der leverer hjælpefiler, skal generelt gøre følgende:

Du kan også bygge et søgeindeks på forhånd og registrere det ved hjælp af elementet index for at optimere ydeevnen for det første søgeforsøg. Du kan kun registrere ét indeks pr. plugin - flere index-elementer vil resultere i en ikke-defineret funktionsmåde.

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

<!ATTLIST-udvidelse

point CDATA #REQUIRED

id    CDATA #IMPLIED

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

(siden 3.1) et valgfrit element, som gør erklæring mulig af et forudbygget indeks oprettet på basis af dokumenter, der er leveret af denne plugin.



Det følgende er et eksempel på, hvordan du bruger toc-udvidelsespunktet.

(i filen plugin.xml)

 

<udvidelsespunkt=

"org.eclipse.help.toc"

>

<toc file=

"toc1.xml"

primary=

"true"

/>

<toc file=

"toc2.xml"

primary=

"true"

category=

"myCategory"

/>

<toc file=

"task.xml"

/>

<toc file=

"sample.xml"

extradir=

"samples"

/>

<index path=

"index/"

/>

</extension>

(i filen maindocs.xml)

<toc label="Eksempel på hjælp">
 <topic label="Introduktion" href="intro.html"/>
 <topic label="Tasks">
  <topic label="Opret et projekt" href="tasks/task1.html">
   <topic label="Opret et web-projekt" href="tasks/task11.html"/>
   <topic label="Opret et Java-projekt" href="tasks/task12.html"/>
  </topic>
  <link toc="task.xml" />
  <topic label="Test et projekt" href="tasks/taskn.html"/>
 </topic>
 <topic label="Eksempler">
  <topic label="Opret et Java-projekt" href="samples/sample1.html">
   <topic label="Start en guide" href="samples/sample11.html"/>
   <topic label="Angiv valg" href="samples/sample12.html"/>
   <topic label="Afslut oprettelse af projekt" href="samples/sample13.html"/>
  </topic>
  <anchor id="samples" />
 </topic>
</toc>


(i filen tasks.xml)

<toc label="Byg et projekt">
 <topic label="Bygning af et projekt" href="build/building.html">
  <topic label="Byg et web-projekt" href="build/web.html"/>
  <topic label="Byg et Java-projekt" href="build/java.html"/>
 </topic>
</toc>


(i filen samples.xml)

<toc link_to="maindocs.xml#samples" label="Brug af kompileringsværktøjet">
 <topic label="Eksempel på kompileringsværktøjet" 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>

Hvis der findes flere dokumenter med en sti, der begynder med "samples", bliver de ikke i navigationstræstrukturen, men kan vises ved hjælp af søgning. Det skyldes attributten "extradir" i elementet <toc file="sample.xml" extradir="samples" /> i filen plugin.xml . Hvis du f.eks. søger efter "Opret et Java-projekt", kan resultatet være et dokument "Andre måder at oprette et Java-projekt på", hvis sti er samples/sample2.html.

Internationalisering TOC XML-filerne kan oversættes, og den resulterende kopi (med oversatte etiketter) skal placeres i nl/<language>/<country> eller nl/<language> directory. <language> og <country> står for sprog- og landekoder på to bogstaver, som anvendt i forbindelse med koder for sprogkonventioner.  Oversættelser til uforkortet kinesisk skal f.eks. placeres i biblioteket nl/zh/TW. Biblioteket nl/<language>/<country> har højere prioritet end nl/<language>. Det er kun, hvis der ikke findes nogen fil i nl/<language>/<country>, at filen i nl/<language> bliver benyttet. Der vil blive søgt i rodbiblioteket for en plugin til sidst.

Dokumentationen i doc.zip kan lokaliseres ved at oprette en doc.zip-fil med de oversatte versioner af dokumenterne og placere doc.zip i
biblioteket nl/<language>/<country> eller nl/<language>. Hjælpen vil lede efter filer under disse biblioteker, inden det anvender plugin-biblioteket.
 

Der kræves ingen kode for at anvende dette udvidelsespunkt. Det eneste, du skal levere, er den relevante manifestfil omtalt i plugin.xml-filen.

Standardimplementeringen af brugergrænsefladen til hjælpen, der leveres sammen med Eclipse-platformen, understøtter udvidelsespunktet til toc.