Sommario (TOC)

org.eclipse.help.toc

Consente di registrare un contributo della guida in linea per un singolo plugin.

Ciascun plugin che contribuisce con file della guida dovrebbe eseguire le seguenti azioni:

Facoltativamente, un indice di ricerca può essere pregenerato e registrato utilizzando l'elemento index per migliorare le prestazioni della prima ricerca. Può essere registrato solo un indice per plugin; più elementi index possono causare un comportamento imprevisto.

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

(Dalla versione 3.1) un elemento facoltativo che consente la dichiarazione di un indice di ricerca pregenerato creato in base ai documenti forniti da questo plugin.



Di seguito è riportato un esempio di utilizzo del punto di estensione toc.

(nel file plugin.xml).

 

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

(nel file 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>


(nel file 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>


(nel file 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>

Presupponendo che esistano più documenti che abbiano il percorso che inizia con "samples", questi non verranno visualizzati nella struttura di esplorazione, ma saranno accessibili con la funzione di ricerca.  Ciò è dovuto alla presenza dell'attributo "extradir" nell'elemento <toc file="sample.xml" extradir="samples" /> all'interno del file plugin.xml. Ad esempio, la ricerca di "Creating Java Project" potrebbe restituire un documento del tipo "Other Ways of Creating Java Project", il cui percorso è samples/sample2.html.

Internazionalizzazione È possibile convertire i file TOC XML e posizionare la copia risultante (con le etichette convertite) nella directory nl/<lingua>/<paese> o nl/<lingua>.  <lingua> e <paese> indicano i codici di due caratteri della lingua e del paese, utilizzati nei codici di lingua locale.  Ad esempio, le traduzioni in italiano saranno collocate nella directory nl/it/IT.  La directory nl/<lingua>/<paese> ha priorità sulla directory nl/<lingua>. Solo se non viene individuato alcun file in nl/<lingua>/<paese>, saranno utilizzati i file della directory nl/<lingua>.  La directory principale del plugin sarà esaminata per ultima.

È possibile localizzare la documentazione contenuta nel pacchetto doc.zip mediante la creazione di un file doc.zip con la versione tradotta dei documenti da posizionare nella directory
nl/<lingua>/<paese> o nl/<lingua>. Il sistema della Guida ricercherà i file in queste directory prima di impostare come predefinita la directory plugin.
 

Non è richiesto alcun codice per questo punto di estensione. Occorre soltanto fornire i file manifest appropriati, menzionati nel file plugin.xml.

L'implementazione predefinita dell'interfaccia utente del sistema della guida, in dotazione con la piattaforma Eclipse, supporta completamente il punto di estensione toc.