Innehållsförteckning

org.eclipse.help.toc

För registrering av hjälpinnehåll för ett individuellt insticksprogram.

Varje insticksprogram som bidrar med hjälpfiler bör i allmänhet göra följande:

Om så önskas kan ett sökindex byggas i förväg och registreras med hjälp av elementet index för att ge bättre prestanda vid det första sökförsöket. Endast ett index per insticksprogram kan registreras - flera index-element ger oförutsägbara resultat.

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

(sedan 3.1) ett valfritt element som möjliggör deklarering av i förväg byggda sökindex som skapas från dokument som tillhandahålls från insticksprogrammet.



Här följer ett exempel på hur utökningspunkten för innehållsförteckning används.

(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="Hjälpsystemsexempel">
 <topic label="Introduktion" href="intro.html"/>
 <topic label="Uppgifter">
  <topic label="Skapa ett projekt" href="tasks/task1.html">
   <topic label="Skapa ett webbprojekt" href="tasks/task11.html"/>
   <topic label="Skapa ett Java-projekt" href="tasks/task12.html"/>
  </topic>
  <link toc="task.xml" />
  <topic label="Testa ett projekt" href="tasks/taskn.html"/>
 </topic>
 <topic label="Exempel">
  <topic label="Skapa Java-projekt" href="samples/sample1.html">
   <topic label="Starta en guide" href="samples/sample11.html"/>
   <topic label="Ställa in alternativ" href="samples/sample12.html"/>
   <topic label="Slutföra skapandet av projekt" href="samples/sample13.html"/>
  </topic>
  <anchor id="samples" />
 </topic>
</toc>


(i filen tasks.xml)

<toc label="Bygga ett projekt">
 <topic label="Bygga ett projekt" href="build/building.html">
  <topic label="Bygga ett webbprojekt" href="build/web.html"/>
  <topic label="Bygga ett Java-projekt" href="build/java.html"/>
 </topic>
</toc>


(i filen samples.xml)

<toc link_to="maindocs.xml#samples" label="Använda kompileringsverktyget">
 <topic label="Kompileringsexempel" href="compilesample/example.html">
  <topic label="Steg 1" href="compilesample/step1.html"/>
  <topic label="Steg 2" href="compilesample/step2.html"/>
  <topic label="Steg 3" href="compilesample/step3.html"/>
  <topic label="Steg 4" href="compilesample/step4.html"/>
 </topic>
</toc>

Om vi antar att det finns fler dokument vars sökväg börjar med "samples" så visas de inte i navigeringsträden men är åtkomliga vid sökning.  Det beror på attributet "extradir" i elementet <toc file="sample.xml" extradir="samples" /> i filen plugin.xml . Om du till exempel söker efter "Skapa Java-projekt" kan dokumentet "Andra sätt att skapa Java-projekt" returneras vars sökväg är samples/sample2.html.

Internationalisering Innehållsförteckningens XML-filer kan översättas och de resulterande kopiorna (med översatta etiketter) placeras i katalogen nl/<språk>/<land> eller nl/<språk>.  <language> and <country> står för de språk- och landskoder med två tecken som används i språkmiljökoder.  Översättningar till traditionell kinesiska placeras t.ex. i katalogen nl/zh/TW.  Katalogen nl/<language>/<country> har högre prioritet än nl/<language>.  Endast om ingen fil återfinns i nl/<language>/<country> används den fil som finns i nl/<language>.  Rotkatalogen för ett insticksprogram genomsöks sist.

Dokumentationen i doc.zip kan du lokalisera genom att skapa en doc.zip-fil med översatta versioner av dokumenten och placera doc.zip i
katalogen nl/<language>/<country> eller nl/<language>. Hjälpsystemet söker efter filerna under dessa kataloger innan insticksprogrammets katalog används som standard.
 

Ingen kod behöver användas för den här utökningspunkten. Allt som behövs är att tillhandahålla lämpliga manifestfiler som omnämns i filen plugin.xml.

Standardimplementeringen av hjälpsystemets användargränssnitt som tillhandahålls med Eclipse plattform stödjer fullständigt utökningspunkten innehållsförteckning.