Sisällysluettelo

org.eclipse.help.toc

Tämän laajennuspisteen avulla voidaan rekisteröidä yksittäisen lisäosan käytönaikaisen ohjeen lisäys.

Ohjetiedostoja lisääville lisäosille yleensä kuuluvat tehtävät ovat

Hakutoiminnon ensimmäistä käyttökertaa voidaan haluttaessa nopeuttaa luomalla hakuindeksi etukäteen ja rekisteröimällä se index-elementin avulla. Kutakin lisäosaa varten voi rekisteröidä vain yhden indeksin. Jos index-elementtejä on useita, lisäosan toimintatapa ei ole määritysten mukainen.

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

(Käytettävissä versiosta 3.1 alkaen.) Tämän valinnaisen elementin avulla voidaan esitellä tämän lisäosan lisäämistä asiakirjoista valmiiksi luotu hakuindeksi.



Seuraavassa on toc-laajennuspisteen käyttöesimerkki.

(Määritystiedosto 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>

(Määritystiedosto maindocs.xml)

<toc label="Ohjejärjestelmäesimerkki">
 <topic label="Johdanto" href="intro.html"/>
 <topic label="Tehtävät">
  <topic label="Projektin luonti" href="tasks/task1.html">
   <topic label="Web-projektien luonti" href="tasks/task11.html"/>
   <topic label="Java-projektien luonti" href="tasks/task12.html"/>
  </topic>
  <link toc="task.xml" />
  <topic label="Projektin testaus" href="tasks/taskn.html"/>
 </topic>
 <topic label="Mallit">
  <topic label="Java-projektien luonti" href="samples/sample1.html">
   <topic label="Ohjatun toiminnon aloitus" href="samples/sample11.html"/>
   <topic label="Asetusten määritys" href="samples/sample12.html"/>
   <topic label="Projektin luonnin viimeistely" href="samples/sample13.html"/>
  </topic>
  <anchor id="samples" />
 </topic>
</toc>


(Määritystiedosto tasks.xml)

<toc label="Projektin koonti">
 <topic label="Projektin koonti" href="build/building.html">
  <topic label="Web-projektien koonti" href="build/web.html"/>
  <topic label="Java-projektien koonti" href="build/java.html"/>
 </topic>
</toc>


(Määritystiedosto samples.xml)

<toc link_to="maindocs.xml#samples" label="Kääntötyökalun käyttö">
 <topic label="Mallikääntötyökalu" href="compilesample/example.html">
  <topic label="Vaihe 1" href="compilesample/step1.html"/>
  <topic label="Vaihe 2" href="compilesample/step2.html"/>
  <topic label="Vaihe 3" href="compilesample/step3.html"/>
  <topic label="Vaihe 4" href="compilesample/step4.html"/>
 </topic>
</toc>

Mikäli samples-alkuisessa polussa on useampia asiakirjoja, ne eivät näy siirtymisrakenteessa, mutta niitä voidaan käyttää hakutoiminnon avulla. Tämä johtuu siitä, että plugin.xml-tiedoston <toc file="sample.xml" extradir="samples" /> -elementti sisältää extradir-määritteen.Esimerkiksi hakuehto "Java-projektien luonti" voisi palauttaa polussa samples/sample2.html. olevan asiakirjan "Muut Java-projektien luontitavat".

Kansainvälistys Sisällysluettelon XML-tiedostot voidaan kääntää ja käännetyt tiedostot (joiden nimiöt on myös käännetty) sijoittaa hakemistoon nl/<kieli>/<maa> tai nl/<kieli>. Hakemistopolkujen <kieli>- ja <maa>-osat ovat paikallistunnuskoodien mukaiset kaksikirjaimiset kieli- ja maakoodit. Esimerkiksi perinteisen kiinan käännösten tallennushakemisto olisi nl/zh/TW. Nl/<kieli>/<maa>-hakemisto on ensisijainen nl/<kieli>-hakemistoon verrattuna. Nl/<kieli>-hakemistossa olevaa tiedostoa käytetään vain, jos tiedostoa ei löydy nl/<kieli>/<maa>-hakemistosta. Tiedostoa etsitään viimeisenä lisäosan päähakemistosta.

Doc.zip-arkistotiedoston sisältämät asiakirjat voidaan lokalisoida luomalla doc.zip-tiedostosta käännetyt asiakirjat sisältävä versio ja tallentamalla se
nl/<kieli>/<maa>- tai nl/<kieli>-hakemistoon. Ohjejärjestelmä etsii tiedostoja ensin näistä hakemistoista ja viimeisenä oletusarvoisesta lisäosan hakemistosta.
 

Tämän laajennuspisteen käyttö ei edellytä koodia. Riittää, että plugin.xml-tiedoston mukaiset manifest-tiedostot on luotu.

Eclipse-käyttöympäristön mukana toimitettava ohjejärjestelmän käyttöliittymän oletustoteutus tukee toc-laajennuspistettä.