Πίνακας περιεχομένων (TOC)

org.eclipse.help.toc

Για την καταχώρηση μιας συνεισφοράς περιεχομένου ηλεκτρονικής βοήθειας για μια μεμονωμένη πρόσθετη λειτουργία.

Κάθε πρόσθετη λειτουργία που συνεισφέρει αρχεία βοήθειας θα πρέπει γενικά να πραγματοποιεί τα εξής:

Προαιρετικά, μπορεί να προ-δομηθεί ένα ευρετήριο αναζήτησης και να καταχωρηθεί με τη χρήση του στοιχείου index προκειμένου να πραγματοποιείται η πρώτη προσπάθεια αναζήτησης. Μπορεί να καταχωρηθεί μόνο ένα ευρετήριο ανά πρόσθετη λειτουργία - περισσότερα στοιχεία index θα οδηγήσουν σε ακαθόριστη συμπεριφορά.

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

(Από την έκδοση 3.1 και έπειτα) ένα προαιρετικό στοιχείο που επιτρέπει τη δήλωση προ-δομημένου ευρετηρίου αναζήτησης που δημιουργείται από έγγραφα τα οποία συνεισφέρονται από αυτή την πρόσθετη λειτουργία.



Παρακάτω δίνεται ένα παράδειγμα χρήσης του σημείου επέκτασης toc.

(σε αρχείο 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>

(σε αρχείο 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>


(σε αρχείο 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>


(σε αρχείο 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>

Αν υποθέσουμε ότι υπάρχουν περισσότερα του ενός έγγραφα με διαδρομή που ξεκινά με "samples", αυτά δεν θα εμφανίζονται στη διακλάδωση πλοήγησης, αλλά θα είναι προσβάσιμα με τη χρήση της αναζήτησης.  Αυτό οφείλεται στο γνώρισμα "extradir" του στοιχείου <toc file="sample.xml" extradir="samples" /> μέσα στο αρχείο plugin.xml . Για παράδειγμα, η αναζήτηση του "Creating Java Project" θα επιστρέψει ως αποτέλεσμα ένα έγγραφο "Other Ways of Creating Java Project", του οποίου η διαδρομή είναι samples/sample2.html.

Διεθνής προσαρμογή Τα αρχεία XML TOC μπορούν να μεταφραστούν και το αντίγραφο που προκύπτει (με μεταφρασμένες ετικέτες) θα πρέπει να τοποθετείται στον κατάλογο nl/<language>/<country> ή nl/<language>.  Τα <language> και <country> θα είναι κωδικοί δύο γραμμάτων για τη γλώσσα και τη χώρα, όπως χρησιμοποιούνται στους κωδικούς τοπικών ρυθμίσεων.   Για παράδειγμα, οι μεταφράσεις σε παραδοσιακή κινεζική θα πρέπει να τοποθετηθούν στον κατάλογο nl/zh/TW.  Ο κατάλογος nl/<language>/<country> έχει υψηλότερη προτεραιότητα από τον κατάλογο nl/<language>.  Εάν δεν βρεθεί το αρχείο του καταλόγου nl/<language>/<country>, μόνο τότε θα χρησιμοποιηθεί το αρχείο του καταλόγου nl/<language>.  Η αναζήτηση στον κεντρικό κατάλογο μιας πρόσθετης λειτουργίας θα πραγματοποιηθεί τελευταία.

Η τεκμηρίωση που περιέχεται στο doc.zip μπορεί να τροποποιηθεί τοπικά σε ένα αρχείο doc.zip με μεταφρασμένη έκδοση των εγγράφων και το doc.zip να τοποθετηθεί στον κατάλογο
nl/<language>/<country> ή nl/<language>. Το σύστημα βοήθειας θα αναζητά τα αρχεία των καταλόγων αυτών, πριν πραγματοποιήσει αναζήτηση στον προεπιλεγμένο κατάλογο της πρόσθετης λειτουργίας.
 

Δεν απαιτείται κάποιος κωδικός για τη χρήση του συγκεκριμένου σημείου επέκτασης. Το μόνο που χρειάζεται είναι η παροχή των κατάλληλων αρχείων δήλωσης που αναφέρονται στο αρχείο plugin.xml.

Η προεπιλεγμένη υλοποίηση του περιβάλλοντος χρήστη συστήματος βοήθειας που παρέχεται μαζί με την πλατφόρμα Eclipse υποστηρίζει πλήρως το σημείο επέκτασης toc.