Zur Dokumentation: Unterschied zwischen den Versionen
Aus SSV Wiki
| [unmarkierte Version] | [unmarkierte Version] |
Mho (Diskussion | Beiträge) (→Konventionen) |
Mho (Diskussion | Beiträge) (→Konventionen) |
||
| (12 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 2: | Zeile 2: | ||
Sie erfahren, | Sie erfahren, | ||
| + | * wie die einzelnen Elemente der Benutzeroberfläche heißen | ||
* welche Auszeichnungen verwendet werden | * welche Auszeichnungen verwendet werden | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
== Aufbau der Benutzeroberfläche == | == Aufbau der Benutzeroberfläche == | ||
| Zeile 71: | Zeile 14: | ||
| − | [[File:Oberfläche GUI 2.0. | + | [[File:Oberfläche GUI 2.0.png|800px|thumb|left|Aufbau der Benutzeroberfläche]] |
<br clear=all> | <br clear=all> | ||
| Zeile 94: | Zeile 37: | ||
|Checkbox | |Checkbox | ||
|6 | |6 | ||
| − | |Upload | + | |Upload-Schaltfläche |
|9 | |9 | ||
|Hauptschaltflächen | |Hauptschaltflächen | ||
|} | |} | ||
| − | |||
=== Hauptschaltflächen === | === Hauptschaltflächen === | ||
| Zeile 109: | Zeile 51: | ||
* '''[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. | * '''[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. | * '''[Cancel]''': Nicht gespeicherte Änderungen werden zurückgesetzt. Der Ausgangszustand wird wiederhergestellt. | ||
| + | |||
| + | |||
| + | == Konventionen == | ||
| + | |||
| + | Im Hilfe-Wiki werden die folgenden Konventionen verwendet: | ||
| + | |||
| + | : {| class="wikitable"; style= "background-color:white; border: 1px solid gray;" cellpadding="5" | ||
| + | ! style="text-align:left;" |<center><big>Symbol</big></center> | ||
| + | ! style="text-align:left;" |<big>Bedeutung</big> | ||
| + | |- | ||
| + | |<center><span style="font-variant:small-caps;">'''Status'''</span></center> | ||
| + | |Begriff im Menü oder Untermenü, | ||
| + | Beschriftungen für Abschnitte und Zeilen | ||
| + | |- | ||
| + | |<center>'''[Apply]'''</center> | ||
| + | |Schaltfläche | ||
| + | |- | ||
| + | |<center><code>ssvadmin</code></center> | ||
| + | |Inhalte für Eingabefelder, z.B. Passwörter oder IP-Adressen <br/>Auswahlmöglichkeiten bei Dropdown-Menüs | ||
| + | |- | ||
| + | |<center>[[Hauptseite]]</center> | ||
| + | |Interner Link | ||
| + | |- | ||
| + | |<center>[http://ssv-embedded.de/ SSV Embedded]</center> | ||
| + | |Externer Link | ||
| + | |- | ||
| + | | | ||
| + | :::* | ||
| + | |Aufzählung | ||
| + | |- | ||
| + | | | ||
| + | ::# | ||
| + | ::# | ||
| + | |Nummerierte Handlungsschritte | ||
| + | |- | ||
| + | |<center>♦</center> | ||
| + | |optionale Handlungsschritte | ||
| + | |- | ||
| + | |<center>✔</center> | ||
| + | |Ergebnis einer Handlungsanweisung | ||
| + | |- | ||
| + | | | ||
| + | {{Hinweis}} | ||
| + | | Hinweise und Tipps, die die Arbeit erleichtern | ||
| + | |- | ||
| + | | | ||
| + | {{Vorsicht}} | ||
| + | | Das Ausführen einer Handlung hat unerwünschte Folgen, wie zum Beispiel Datenverlust | ||
| + | |} | ||
Aktuelle Version vom 19. Mai 2016, 15:05 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
[Apply] Schaltfläche ssvadminInhalte 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 ♦ optionale Handlungsschritte ✔ 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
