Zur Dokumentation: Unterschied zwischen den Versionen
Aus SSV Wiki
[unmarkierte Version] | [unmarkierte Version] |
Mho (Diskussion | Beiträge) (→Konventionen) |
Mho (Diskussion | Beiträge) |
||
Zeile 2: | Zeile 2: | ||
Sie erfahren, | Sie erfahren, | ||
− | |||
* wie die einzelnen Elemente der Benutzeroberfläche heißen | * wie die einzelnen Elemente der Benutzeroberfläche heißen | ||
+ | * welche Auszeichnungen verwendet werden | ||
+ | |||
+ | |||
+ | |||
+ | == Aufbau der Benutzeroberfläche == | ||
+ | <br /> | ||
+ | |||
+ | === GUI Elemente === | ||
+ | |||
+ | |||
+ | |||
+ | [[File:Oberfläche GUI 2.0.png|800px|thumb|left|Aufbau der Benutzeroberfläche]] | ||
+ | |||
+ | <br clear=all> | ||
+ | |||
+ | {|style="width:700px;" | ||
+ | |- | ||
+ | |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 === | ||
+ | |||
+ | [[File:Schaltflächen.JPG|mini|right|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. | ||
Zeile 52: | Zeile 99: | ||
| Das Ausführen einer Handlung hat unerwünschte Folgen, wie zum Beispiel Datenverlust. | | Das Ausführen einer Handlung hat unerwünschte Folgen, wie zum Beispiel Datenverlust. | ||
|} | |} | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Version vom 11. Mai 2016, 09:17 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ü [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.