3.1.5 Inhaltsverzeichnis

Ist eine Agora-Dokumente in sich strukturiert, kann das System diese Struktur als HTML-Inhaltsverzeichnis ausgeben. Hierfür wird das sog. 'TableOfContents'-Template (content-toc.html) verwendet. Das Inhaltsverzeichnis gibt die interne Struktur des Dokuments wieder. Üblicherweise wird nur das Inhaltsverzeichnis der obersten Struktur eines Dokuments erzeugt, für tiefere Schichten ist ein Inhaltsverzeichnis meist nicht sinnvoll. Eine Ausnahme wäre aber z. B. das Inhaltsverzeichnis eines Zeitschriftenbandes, das die einzelnen Zeitschriftenausgaben auflistet, das Inhaltsverzeichnis der einzelnen Zeitschriftenausgabe den Inhalt der Zeitschrift ausgibt. Mit Hilfe des Inhaltsverzeichnisses kann man innerhalb des Dokuments navigieren. Jedes Strukturelement kann per Klick aktiviert werden.

Normalerweise wird zum Erzeugen des Inhaltsverzeichnisses die Dokumentstruktur einmal durchlaufen. Hierfür wird das Kontextobjekt 'toc.descendant' verwendet.

 

• Funktion: $toc.descendant

  Datentyp: Iterator

  '$toc.descendant' geht durch alle Strukturelemente eines Agora-Dokuments.

  Beispiel:

  ...
  <table cellpadding="5" cellspacing="0" border="0" width="100%">
    #set $i =1
    #foreach $doc in $toc.descendant()
      <tr>
      #if ($doc)
        <td>
           <nobr>#count $i from 1 to $doc.level { . }- $doc.label </nobr>
       #end
        </td>
        <td><a href="$link.doc("view", $doc)">
              #set $author = $doc.attribute("Author")
              #set $title = $doc.attribute("Title")
              $author.value<br>>
              $title.value
        </td>
        ...
      </tr>
     #set $i = $i + 1
    #end
  </table>
   ...     
  

   

Folgender Ausschnitt eines Inhaltsverzeichnisses könnte das Ergebnis dieser Sequenz sein:

...

...