Vorlage für Einträge in der Kategorie Befehlsreferenz

Aus goLaTeX

Kurzbeschreibung

Verwendung

Syntax

\befehl[Optionen]{Parameter}

Parameter

[Optionen]
Besitzt der Befehl lediglich ein einfaches optionales Argument kann dieses auch in der Verwendung mit behandelt werden. Bei komplexeren optionalen Möglichkeiten, beispielsweise key=value-Optionen ist es sinnvoll, die Optionen hier getrennt zu dokumentieren. Dies gilt auch bei Optionen zu Paketen.
{Parameter}
Es wird empfohlen, Parameter einzeln kurz zu erläutern. In vielen Fällen genügt es, die Art des Parameters anzugeben, beispielsweise eine ganze Zahl zwischen -10000 und 10000. Der Rest kann in der [#Beschreibung] erklärt werden.

Beschreibung

Hier ist möglichst genau zu erklären, was der Befehl tut.

Beispiele

Beispiele sollten sich auf das Thema des Wiki-Eintrags konzentrieren und beschränken

Verwandte Befehle

Interner Link auf den Befehl, allenfalls minimale Erklärung des verwandten Befehls außerhalb des Links

Links

CTAN-Katalog-Eintrag für ... (bei Paketen, die auf CTAN zu finden sind)

Nicht vergessen: während dieser Beitrag in der Kategorie goLaTeX-Wiki eingetragen ist, gehört der Befehls-Beitrag nach [[Kategorie:Befehlsreferenz|Befehlsname]]. Dabei ist der Befehlsname ohne vorangestellten Backslash anzugeben, damit er in der Übersicht beim richtigen Buchstaben und nicht beim Backslash eingeordnet wird!