Vorlage für Einträge in der Kategorie Pakete
Kurzbeschreibung
Inhaltsverzeichnis
Installation
Benötigt ein Paket eine besondere Installation, so ist dies hier zu erwähnen. Bei Paketen, die über die Paketmanager verschiedener Distributionen installierbar sind, entfällt dieser Abschnitt hingegen komplett.
Verwendung
Syntax:
\usepackage[OPTIONEN]{Paketname}
Beschreibung
Besitzt ein Paket keine Optionen, entfällt der Teil [OPTIONEN]. Besitzt ein Paket weitere Initialisierungsanweisungen, so können diese hier ebenfalls aufgeführt werden.
Optionen
Hier gibt man sinnvollerweise ein Übersicht über die wichtigsten Optionen in Form einer Liste. Die Liste muss nicht vollständig sein. In diesem Fall sollte jedoch ausdrücklich auf die Anleitung verwiesen werden, etwa:
Für weitere Optionen siehe die Anleitung zum Paket.
Befehle
Hier kann eine Übersicht über die wichtigsten Befehle und Umgebungen erfolgen. Besteht der Zweck eines Pakets nur in der Bereitstellung von einigen wenigen Anweisungen (Beispielsweise \captionof
beim Paket capt-of), so kann diese Anweisung auch bei der Verwendung angegeben werden.
Besonderheiten und bekannte Probleme
Sind zu einem Paket besondere Dinge anzumerken oder Probleme bekannt, so können diese hier genannt werden. Bei Paketen mit funktionierendem Support sollten die Fehler jedoch auch an den Maintainer des Pakets gemeldet sein. Ggf. ist die Paketversion anzugeben, für die das Problem relevant ist. Ein Eintrag hier kann und soll keinen Bugreport ersetzen!
Beispiele
Beispiele sollten sich auf das Thema des Wiki-Eintrags konzentrieren und beschränken. Für die Beispiele sollte <source lang=latex>...</source> verwendet werden.
Verwandte Pakete
Interne Links auf die Pakete mit einer allenfalls minimale Erklärung des verwandten Pakets außerhalb des Links. Bei mehreren Paketen am besten in Form einer Liste.
Links
CTAN-Katalog-Eintrag für ... (bei Paketen, die auf CTAN zu finden sind)