Vorlage für Einträge in der Kategorie Befehlsreferenz: Unterschied zwischen den Versionen
| Zeile 2: | Zeile 2: | ||
== Verwendung == | == Verwendung == | ||
| + | |||
| + | ===Voraussetzung=== | ||
| + | <code>\usepackage{xyz}</code> | ||
| + | |||
| + | ''Wenn ein Befehl nur unter bestimmten Voraussetzungen verfügbar ist, sollten diese hier angegeben werden. Beispielsweise kann hier das Laden eines Pakets (vorzugsweise als Paketladebefehl) angegeben werden. Wenn dabei bestimmte Optionen Voraussetzung sind, können diese direkt mit angegeben werden. | ||
===Syntax=== | ===Syntax=== | ||
| Zeile 11: | Zeile 16: | ||
::''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.'' | ::''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.'' | ||
;<code>{''Parameter''}</code> | ;<code>{''Parameter''}</code> | ||
| − | ::''Es wird empfohlen, ''Parameter'' einzeln kurz zu erläutern. In vielen Fällen genügt es, die Art des Parameters anzugeben, beispielsweise <q>eine ganze Zahl zwischen -10000 und 10000</q>. Der Rest kann in der [#Beschreibung] erklärt werden. | + | ::''Es wird empfohlen, ''Parameter'' einzeln kurz zu erläutern. In vielen Fällen genügt es, die Art des Parameters anzugeben, beispielsweise <q>eine ganze Zahl zwischen -10000 und 10000</q>. Der Rest kann in der [[#Beschreibung]] erklärt werden. |
===Beschreibung=== | ===Beschreibung=== | ||
Aktuelle Version vom 14. Mai 2020, 12:22 Uhr
Kurzbeschreibung
Inhaltsverzeichnis
Verwendung
Voraussetzung
\usepackage{xyz}
Wenn ein Befehl nur unter bestimmten Voraussetzungen verfügbar ist, sollten diese hier angegeben werden. Beispielsweise kann hier das Laden eines Pakets (vorzugsweise als Paketladebefehl) angegeben werden. Wenn dabei bestimmte Optionen Voraussetzung sind, können diese direkt mit angegeben werden.
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.
- Es wird empfohlen, Parameter einzeln kurz zu erläutern. In vielen Fällen genügt es, die Art des Parameters anzugeben, beispielsweise
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!
