Darstellungskonventionen
Hervorhebungen
Innerhalb der Dokumentation werden manche Wörter besonders hervorgehoben. Die Hervorhebung hat folgende Bedeutung:
- Befehle oder Menüeinträge, die Sie anwählen können, sind fett anthrazit gekennzeichnet.
Dies sind also durchgängig Texte, die Sie in der Programmoberfläche wiederfinden müssen. - Variablennamen, Eingaben in der Kommandozeile, Datei-Listings oder Pfadangaben sind fett schwarz gekennzeichnet.
Dies sind also durchgängig Dateinamen- und Inhalte oder Texte und Werte, die Sie selbst eingeben müssen. - Allgemeine Hervorhebungen im Text sind dagegen fett schwarz kursiv dargestellt.
- Menüeinträge, bei denen nacheinander Menüs, Untermenüs und Befehle ausgewählt werden müssen, werden in der Reihenfolge nacheinander aufgelistet und durch einen senkrechten Strich getrennt.
Z.B. würde der Befehl "Einstellungen" unter "Programm" im Start-Menü folgendermaßen dargestellt:
"Wählen Sie im Start-MenüProgramm |
Einstellungen."
Ähnliches gilt auch, wenn Sie in einem Browser-Fenster nacheinander verschiedene Ordner aufklappen müssen, wie z.B. im Windows-Explorer.
Schritt-für-Schritt-Anleitungen
Aufeinanderfolgende Arbeitsschritte und andere sortierte Listen werden jeweils durch einen eingerückten Einleitungstext gekennzeichnet, unter dem folgende Aufzählungszeichen folgen:
- Sortierte Aufzählungen werden als nummerierte Liste dargestellt
- Das Ergebnis eines Arbeitsschritts ist durch ein Pfeilsymbol gekennzeichnet
- usw.
Aufzählungen
Unsortierte Aufzählungen werden jeweils durch einen eingerückten Einleitungstext gekennzeichnet, unter dem folgende Aufzählungszeichen folgen:
- Unsortierte Aufzählungen werden durch ein schwarzes Viereck gekennzeichnet
- usw.
Zusatzinformationen
Ausführliche Zusatzinformationen verbergen sich hinter Aufklapptexten:

Genau so!
Markierte Texte
Manche Absätze sind besonders durch ein einleitendes Symbol gekennzeichnet. Die Kennzeichnung hat folgende Bedeutung:
- Ein Text, der mit einem roten Ausrufezeichen gekennzeichnet ist, sollte als Warnung besonders beachtet werden, weil anderenfalls die ordnungsgemäße Funktion des Programms nicht gewährleistet ist!
- Ein Text, der so markiert ist, soll als Tipp oder Hinweis auf Besonderheiten aufmerksam machen und die Arbeit erleichtern, oder das zuvor Erläuterte verdeutlichen. Dieses Symbol kann auch vor einer Abbildung stehen.