Tartalomjegyzék (TOC)

org.eclipse.help.toc

Online súgó közreadásának regisztrálása céljából egyéni bedolgozóhoz.

Minden egyes bedolgozó, amely súgófájlokat tesz közzé, általában a következő tevékenységeket végzi:

Nem kötelező módon egy keresőindex előregyártható és bejegyezhető az index elem használatával az első keresési kísérlet végrehajtásához. Bedolgozónként csak egy index jegyezhető be, a több index elem meghatározatlan viselkedést eredményez.

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


<!ELEMENT index EMPTY>

<!ATTLIST index

path CDATA #REQUIRED>

(3.1 változat óta) elhagyható elem, amely lehetővé teszi az ezen bedolgozó által hozzáadott dokumentumokból létrehozott előregyártott keresési index deklarálását.



Az alábbiakban egy példa látható a toc kiterjesztési pont használatára:

(a plugin.xml fájlban)

 

<extension point=

"org.eclipse.help.toc"

>

<toc file=

"maindocs.html"

primary=

"true"

/>

<toc file=

"task.xml"

/>

<toc file=

"sample.xml"

extradir=

"samples"

/>

<index path=

"index/"

/>

</extension>

(a maindocs.xml fájlban)

<toc label="Súgórendszer példa">
 <topic label="Bevezetés" href="intro.html"/>
 <topic label="Feladatok">
  <topic label="Projekt létrehozása" href="tasks/task1.html">
   <topic label="Webprojekt létrehozása" href="tasks/task11.html"/>
   <topic label="Java projekt létrehozása" href="tasks/task12.html"/>
  </topic>
  <link toc="task.xml" />
  <topic label="Projekt tesztelése" href="tasks/taskn.html"/>
 </topic>
 <topic label="Minták">
  <topic label="Java projekt létrehozása" href="samples/sample1.html">
   <topic label="Varázsló indítása" href="samples/sample11.html"/>
   <topic label="Paraméterek beállítása" href="samples/sample12.html"/>
   <topic label="Projekt létrehozásának befejezése" href="samples/sample13.html"/>
  </topic>
  <anchor id="samples" />
 </topic>
</toc>


(a tasks.xml fájlban)

<toc label="Projekt összeépítése">
 <topic label="Projekt összeépítése" href="build/building.html">
  <topic label="Webprojekt összeépítése" href="build/web.html"/>
  <topic label="Java projekt összeépítése" href="build/java.html"/>
 </topic>
</toc>


(a samples.xml fájlban)

<toc link_to="maindocs.xml#samples" label="A fordítási eszköz használata">
 <topic label="Fordítási eszköz példa" href="compilesample/example.html">
  <topic label="1. lépés" href="compilesample/step1.html"/>
  <topic label="2. lépés" href="compilesample/step2.html"/>
  <topic label="3. lépés" href="compilesample/step3.html"/>
  <topic label="4. lépés" href="compilesample/step4.html"/>
 </topic>
</toc>

Mivel több dokumentum rendelkezik "samples" kezdetű elérései úttal, ezért ezek nem jelennek meg a navigációs fában, keresés használatával azonban elérhetők.   Ezt a plugin.xml fájlban lévő <toc file="sample.xml" extradir="samples" /> elem "extradir" attribútumának jelenléte okozza. Például a "Java projekt létrehozása" kifejezésre keresés visszaadhatná a "Java projekt létrehozásának további módjai" dokumentumot, amelynek elérési útja samples/sample2.html.

Nemzetközivé tétel A TOC XML fájlok lefordíthatók, az eredményül kapott másolatokat (a lefordított címkékkel) pedig az nl/<language>/<country> vagy az nl/<language> könyvtárban kell elhelyezni.   A <language> és <country> két betűs nyelv- és országkódokat képviselnek a helyi kódokban használtak szerint.  Például a hagyományos kínai fordításokat az nl/zh/TW könyvtárban kell elhelyezni.   Az nl/<language>/<country> könyvtár az nl/<language> könyvtárnál magasabb prioritással rendelkezik.   Az nl/<language> könyvtárban található fájl csak akkor kerül felhasználásra, ha az nl/<language>/<country> könyvtár üres.   A bedolgozó gyökérkönyvtárának átnézése az utolsó.

A doc.zip fájlban tárolt dokumentáció a következőképpen honosítható: a dokumentációk lefordított változatának felhasználásával kell létrehozni a doc.zip fájlt, majd el kell helyezni az
nl/<language>/<country> vagy az nl<language> könyvtárban. A súgórendszer a fájlokat ezekben a könyvtárakban fogja keresni mielőtt rátérne az alapértelmezett bedolgozó könyvtárra.
 

Ez a kiterjesztési pont használatához nem szükséges kód. Mindössze a plugin.xml fájlban említett megfelelő leírófájlokat szükséges biztosítani.

Az Eclipse környezettel biztosított súgórendszer felhasználói felületének alapértelmezett megvalósítása teljes mértékben támogatja a toc kiterjesztési pontot.