Zur Dokumentation: Unterschied zwischen den Versionen
Aus SSV Wiki
[unmarkierte Version] | [unmarkierte Version] |
Mho (Diskussion | Beiträge) |
Mho (Diskussion | Beiträge) (→Konventionen) |
||
Zeile 62: | Zeile 62: | ||
|- | |- | ||
|<center><span style="font-variant:small-caps;">'''Status'''</span></center> | |<center><span style="font-variant:small-caps;">'''Status'''</span></center> | ||
− | |Begriff im Menü oder Untermenü | + | |Begriff im Menü oder Untermenü, |
+ | Beschriftungen für Abschnitte und Zeilen | ||
|- | |- | ||
|<center>'''[Button]'''</center> | |<center>'''[Button]'''</center> |
Version vom 19. Mai 2016, 13:28 Uhr
Auf dieser Seite erhalten Sie Informationen über die Gestaltung der Dokumentationen im Wiki.
Sie erfahren,
- wie die einzelnen Elemente der Benutzeroberfläche heißen
- welche Auszeichnungen verwendet werden
Inhaltsverzeichnis
Aufbau der Benutzeroberfläche
GUI Elemente
1 | Menü | 4 | Textfeld | 7 | Kurzbeschreibung |
2 | Radiobutton | 5 | Dropdown-Menü | 8 | Schaltfläche |
3 | Checkbox | 6 | Upload-Schaltfläche | 9 | Hauptschaltflächen |
Hauptschaltflächen
Unter allen Menüpunkten im WebConfigTool, unter denen Einstellungen möglich sind, befinden sich in der unteren, rechten Ecke drei Hauptschaltflächen. Die Hauptschaltflächen haben die folgenden Funktionen:
- [OK]: Die veränderten Einstellungen werden gespeichert. Damit sie wirksam werden, ist ein Neustart erforderlich.
- [Apply]: Die veränderten Einstellungen werden gespeichert und sofort übernommen. Änderungen können nicht mehr rückgängig gemacht werden. Ein Neustart ist nicht erforderlich.
- [Cancel]: Nicht gespeicherte Änderungen werden zurückgesetzt. Der Ausgangszustand wird wiederhergestellt.
Konventionen
Im Hilfe-Wiki werden die folgenden Konventionen verwendet:
Symbol Bedeutung Status Begriff im Menü oder Untermenü, Beschriftungen für Abschnitte und Zeilen
[Button] Schaltfläche ssvadmin
Inhalte für Eingabefelder, z.B. Passwörter oder IP-Adressen
Auswahlmöglichkeiten bei Dropdown-MenüsHauptseite Interner Link SSV Embedded Externer Link Aufzählung Nummerierte Handlungsschritte ♦ Handlungsanweisungen, die optional sind ✔ Ergebnis einer Handlungsanweisung Lorem ipsum dolor sit amet
Hinweise und Tipps, die die Arbeit erleichtern Vorsicht Lorem ipsum
Das Ausführen einer Handlung hat unerwünschte Folgen, wie zum Beispiel Datenverlust.