|
Den tmdoc Stil benutzen |
|
Neben den Makros über die Urheberrechtsinformationen
und den Leit-Makros, die bereits dokumentiert wurden,
kommt der tmdoc Stil noch mit
einigen anderen Makros, die sie benutzen sollten, wann immer es
angebracht erscheint:
-
key
-
Dieses Makro wird benutzt, um Keyboard-Eingaben zu kennzeichnen, wie
C-x C-s.
-
menu
-
Dieses Makro kennzeichnet ein Hauptmenü, wie Datei.
-
submenu
-
Dieses Makro kennzeichnet ein Untermenü oder einen
Menü-Eintrag, wie Dokument→Sprache.
-
subsubmenu
-
Dieses Makro kennzeichnet ein Unteruntermenü oder ein
Untermenü-Eintrag, wie Text→Farbe→Weiß.
-
tmstyle
-
Dieses Makro kennzeichnet den Namen einer TeXmacs Stil-Datei oder
eines Paketes, wie article.
-
markup
-
Dieses Makro wird benutzt um ein Makro oder eine Funktion zu
kennzeichnen, wie section.
Die folgenden Makros und Funktionen werden für Links und
Indizierungen benutzt, auch wenn sie in der Zukunft noch verbessert
werden sollten:
-
simple-link
-
Dieses Makro nimmt eine URL x als Argument entgegen und
ist dann ein Hyperlink mit Namen und Ziel x.
-
hyper-link
-
Dieses Makro ist ein normaler Hyperlink.
-
concept-link
-
Dieses Makro nimmt ein Konzept als Argument. Später könnte
dann ein entsprechender Hyperlink automatisch erstellt werden von
dieser und anderer Dokumentation.
-
only-index
-
Eine einfache Zeichenkette indizieren.
-
def-index
-
Definition eines neuen Konzeptes; der Text wird kursiv angezeigt und
indiziert.
-
re-index
-
Wiederauftauchen eines schon definierten Konzepts; der Text wird in
Romanisch angezeigt und indiziert.
Der tmdoc Stil leitet sich aus
dem Brief Stil ab und sollte
Makros wie em, verbatim, itemize,
usw. dieses Stils benutzen, wann immer es passend
erscheint.
© 1998–2002 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".