UI-Elemente und Interaktionen¶
Für die Dokumentation des User Interfaces und dessen Interaktionen stellt Sphinx
drei verschiedene Rollen bereit: guilabel
, kbd
und menuselection
:
Eingabe |
Ausgabe |
Anmerkungen |
---|---|---|
:guilabel:`Cancel`
|
Cancel |
Jede im User Interface verwendete Beschriftung kann mit dieser Rolle gekennzeichnet werden, einschließlich der Beschriftung von Schaltflächen, Fenstertiteln, Feld-, Menü- und Menüauswahl-Namen und Werten in Auswahllisten. |
:guilabel:`&Cancel`
|
Cancel |
Tastenkürzel für die GUI-Beschriftung können mit einem et-Zeichen ( Bemerkung Wenn ihr ein et-Zeichen einfügen wollt, könnt ihr es einfach verdoppeln. |
:kbd:`Ctrl-s`
|
Ctrl-s |
Dies stellt eine Folge von Tasteneingaben dar. Welche Form die Tastenfolge hat, kann von plattform- oder anwendungsspezifischen Konventionen abhängen. Dabei sollten die Namen von Modifikatortasten ausgeschrieben werden, um die Zugänglichkeit zu verbessern. Tastaturbeschriftung referenziert werden. |
:menuselection:`File --> Save`
|
Eine Menüauswahl wird mit der Rolle
|