Allgemeine Softwareelemente
Auch wenn Sie kaum Code dokumentieren, müssen Sie bei der Dokumentation von Software häufig auf Teile des Softwareprodukts verweisen, wie z. B. UI-Komponenten, Dateinamen, Tags, Tastaturkürzel usw. Hier sind einige gängige Elemente, die verwendet werden können:
Die einfachste Art, auf UI-Komponenten (Schaltflächen, Menüs, Symbolleisten usw.) zu verweisen, ist die Verwendung eines Elements als generisches UI-Element: guilabel. Hier ein Beispiel:
Klicken Sie auf die Schaltfläche OK.
Da dies so weit verbreitet ist (und empfohlene Praxis, statt solche Begriffe fett oder kursiv hervorzuheben), gibt es auch ein Tastaturkürzel dafür: AltG.
Wenn Sie differenzierter vorgehen möchten, können Sie stattdessen die Elemente noch spezifischer verwenden, z. B. guilabel nur für Etiketts, guibutton für Schaltflächen, guimenu und dessen Unterelemente für
Menüs usw.
Ein häufiger Arbeitsschritt ist die Erstellung von Dateinamen und -pfaden: Hierfür kommt das Element filename zum Einsatz.
Für das richtige Erstellen von Tastaturkürzeln, entweder sofort oder im späteren Verlauf Ihrer Arbeit, sowie deren unterschiedliche Ausgestaltung für verschiedene Ausgaben verwenden Sie das keycap-Element:
Drücken Sie AltK, um ein keycap-Element hinzuzufügen.
Wie Sie sehen, kann dieses Element gestaltet werden – hier als Tasten der Tastatur. Im vorliegenden Beispiel verfügt dieses Element selbst über ein Tastaturkürzel, um die Bedienung zu erleichtern.
Wenn Sie möchten, können Sie es einzeln oder in Kombination mit dem keycombo-Element verwenden. Wenn keycap-Elemente in ein keycombo-Element eingebettet sind, wird standardmäßig ein „+“-Symbol zwischen den Tasten
ausgegeben (was bei Bedarf in Stylesheets angepasst werden kann).