Struktur-Layout der TeXmacs Dokumentation

Als grundsätzliche Regel gilt, daß sie keine Unterstrukturierungsbefehle innerhalb der TeXmacs Dokumentation benutzen sollten. Versuchen sie statt dessen lieber kleine Hilfe-Seiten zu schreiben, die auf gut abgegrenzte kleine Themen zugeschnitten sind. Auf einer übergeordneten Ebene sollten sie rekursive "Meta-Hilfe-Dateien" schreiben, die anzeigen, wie man die Dokumentation auf automatische Weise durchqueren soll. Dies erlaubt die Wiederverwendung einer Hilfe-Seite für vielfache Zwecke (eine gedruckte Anleitung, ein Tutorial im Internet, etc.).

Der tmdoc Stil enthält drei Markup-Makros, mit denen man anzeigen kann, wie die Dokumentation zu durchlaufen ist. Das traverse Makro wird benutzt um Bereiche mit Durchlaufsinformationen zusammenzufassen. Das branch Makro indiziert eine Hilfe-Seite als Unterabschnitt und das continue Makro eine Folge-Seite. Beide, das branch und das continue Makro haben zwei Argumente. Das erste Argument beschreibt den Link und das zweite Argument enthält schließlich die Pfadadresse der verknüpften Datei.

Typischerweise werden sie am Ende einer Meta-Hilfs-Datei mehrere branch oder continue Makros finden, innerhalb eines traverse Makros. Am Anfang des Dokuments sollten sie außerdem einen Titel für das Dokument definieren, dies gesschieht mit Hilfe des tmdoc-title Makros. Wenn man dann eine gedruckte Version der Anleitung erstellt, kann man automatisch eine Kapitel/Abschitt/Unterabschnitt-Struktur mit dieser Information erzeugen. Alternativ könnte man auch zusätzliche Knöpfe für eine Navigation mittels eines Browsers innerhalb der Dokumentation erzeugen.