Innholdsfortegnelse (TOC)

org.eclipse.help.toc

For registrering av hjelp til en individuell plugin-modul.

Hver plugin-modul som har hjelpefiler, bør generelt gjøre dette:

En søkeindeks kan valgfritt forhåndsbygges og registreres ved hjelp av et index-element for å utføre det første søkeforsøket. Bare en indeks per plugin-modul kan registreres - flere index-elementer vil gi en udefinert virkemåte.

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

(Siden 3.1) et valgfritt element som tillater deklarering av en forhåndsbygd søkeindeks som er opprettet fra dokumenter fra denne plugin-modulen.



Nedenfor finner du et eksempel på bruken av utvidelsespunktet toc.

(i filen plugin.xml)

 

<extension point=

"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="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>


(i filen 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>


(i filen 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>

Hvis det finnes flere dokumenter med en bane som begynner med "samples", blir de ikke vist i navigeringstreet, men de blir tilgjengelige gjennom søk. Dette skyldes at attributtet "extradir" finnes i elementet <toc file="sample.xml" extradir="samples" /> inside plugin.xml file.Et søk etter "Creating Java Project" kan for eksempel returnere dokumentet "Other Ways of Creating Java Project", som har banen samples/sample2.html.

Internasjonalisering TOC XML-filene kan oversettes, og resultatet (med oversatte etiketter) bør legges i katalogen nl/<språk>/<land> eller nl/<språk>. <språk> og <land> står for språk- og landkoder på to bokstaver som brukes i språkmiljøkoder. Oversettelser til tradisjonell kinesisk legges for eksempel i katalogen nl/zh/TW. Katalogen nl/<språk>/<land> har høyere prioritet enn nl/<språk>. Bare hvis det ikke blir funnet en fil i nl/<språk>/<land>, vil filen som ligger i nl/<språk> bli brukt. Rotkatalogen for en plugin-modul blir søkt i sist.

Dokumentasjonen i doc.zip kan lokaliseres ved å opprette en doc.zip-fil med oversatte versjoner av dokumenter, og legge doc.zip i katalogen nl/<språk>/<land> eller nl/<språk>. Hjelpefunksjonen leter etter filene under disse katalogene før standard plugin-katalog brukes.
 

Det er ikke nødvendig med kode for å bruke dette utvidelsespunktet. Alt som trengs er å oppgi de riktige manifestfilene som er nevnt i plugin.xml-filen.

Standardimplementeringen av hjelpefunksjonens brukergrensesnitt som leveres med Eclipse-plattformen, har fullstendig støtte for utvidelsespunktet toc.