TeXmacs-Dokumente

TeXmacs-Dokumente sind natürlich TeXmacs-Bäume, diese haben allerdings eine spezielle Form, die im folgenden beschrieben wird. Unter einem TeXmacs-Dokument wird hier eine Datei bezeichnet, die unter TeXmacs erstellt, sich im Speicher (Puffer) befindet oder auf einem Speichermedium gespeichert wurde. Textstücke, also Teile von Dokumenten, sind zwar auch TeXmacs-Bäume, aber normalerweise keine Dokumente.

Die Wurzel eines Dokuments muss der Standard-Operator document sein. Er hat notwendigerweise die beiden Kinder

<TeXmacs|Version>
(TeXmacs Version)

Dieser Operator ist notwendig und spezifiziert die Version von TeXmacs, die zum abspeichern des Dokuments benutzt wurde.

<body|Inhalt>
(Dokumenten-Rumpf )

Dieser notwendige Operator spezifiziert den Rumpf des Dokuments, also im Endeffekt den Inhalt.

Zu diesen beiden notwendigen Operatoren können weitere Operatoren/Kinder hinzutreten, sofern diese aus den folgenden ausgewählt werden:

<style|Version>

<style|<tuple|style|pack-1|⋯|pack-n>>
(Stil und Stilpakete)

Ein Stil und zusätzliche Stilpakete.

<project|Verweis>
(Projekthinweis)

Damit kann ein Verweis auf ein Projekt hinzugefügt werden, zu dem das Dokument gehört.

<initial|Tabelle>
(Start-Kontext)

Hiermit kann ein Kontext festgelegt werden, mit dem das Dokument gestartet wird: z.B. Seitengröße, Randmaße, usw.. Die Tabelle hat die Form <collection|Bindung-1|⋯|Bindung-n>. Jede Bindung-i hat die Form <associate|Variable-i|Wert-i> und setzt die Kontextvariable Variable-i auf den Startwert Wert-i. Startwerte für Kontextvariable, die nicht in der Tabelle enthalten sind, werden durch den Basis-Stil und die Stilpakete festgelegt.

<references|Tabelle>
(Verweise)

Wahlweise eine Liste aller gültigen Verweise auf eine Marke „Label” in dem Dokument. Auch wenn diese Information von TeXmacs automatisch erzeugt werden kann, ist es sinnvoll eine solche Tabelle abzuspeichern, denn es braucht mehrere Durchgänge, um eine solche Tabelle automatisch zu erzeugen. Um anwenderfreundliches Verhalten des Editors zu erreichen, werden Verweise zusammen mit dem Dokument gespeichert.

Die Tabelle hat eine ähnliche Form wie in der vorgehenden Operation. Hier wird ein „Tuple“ mit jedem Verweis verbunden. Dieses Tuple hat entweder die Form <tuple|Inhalt|Seiten-Nr> oder <tuple|Inhalt|Seiten-Nr|Datei>. Der Inhalt enthält den Text, der gezeigt wird, wenn der Verweis angesprochen wird, und Seiten-Nr enthält die dazugehörige Nummer der Seite. Die Option „Datei” gibt die Datei an, in welcher die Marke „Label” definiert wurde. Das ist nur notwendig, wenn das Dokumente zu einem Projekt gehört, das aus mehreren Dateien besteht.

<auxiliary|Tabelle>
(zusätzliche Hilfsdaten zu einem Dokument)

Dies ist eine wahlweise Tabelle, die zusätzliche Hilfsdaten abspeichert. Wie oben können diese Daten automatisch aus dem Dokument selbst berechnet werden, diese Berechnungen können aber aufwändig sein und unter Umständen auch Werkzeuge benötigen, die möglicherweise auf Ihrem System nicht vorhanden sind. Die Tabelle, wird ähnlich wie oben definiert, assoziiert die Hilfsdaten mit einem Schlüssel. Standard-Schlüssel sind u.a. bib, toc, idx, gly usw..

Beispiel 1. Ein Beispiel für ein Dokument, das nur den einfachen Text „Hallo Welt!” enthält, liefert den folgenden Baum,

Wie Sie sehen, kann unterhalb der Dokument-Wurzel mit Standard-Operator document der Standard-Operator document erneut auftreten. Diese Äste sind in der Regel keine Dokumente, das die Kinder <TeXmacs|Version> und <body|Inhalt> fehlen.

© 2004 Joris van der Hoeven
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".