Zur Dokumentation: Unterschied zwischen den Versionen

Aus SSV Wiki
Wechseln zu: Navigation, Suche
[unmarkierte Version][unmarkierte Version]
(Konventionen)
(Konventionen)
Zeile 87: Zeile 87:
 
|-
 
|-
 
|<center>♦</center>
 
|<center>♦</center>
|Handlungsanweisungen, die optional sind
+
|optionale Handlungsschritte
 
|-
 
|-
 
|<center>✔</center>
 
|<center>✔</center>

Version vom 19. Mai 2016, 13:58 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


Aufbau der Benutzeroberfläche


GUI Elemente

Aufbau der Benutzeroberfläche


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

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
ssvadmin
Inhalte für Eingabefelder, z.B. Passwörter oder IP-Adressen
Auswahlmöglichkeiten bei Dropdown-Menüs
Hauptseite
Interner Link
SSV Embedded
Externer Link
Aufzählung
Nummerierte Handlungsschritte
optionale Handlungsschritte
Ergebnis einer Handlungsanweisung
Info.svg.png Lorem ipsum

dolor sit amet

Hinweise und Tipps, die die Arbeit erleichtern
Achtung.svg.png Vorsicht

Lorem ipsum

Das Ausführen einer Handlung hat unerwünschte Folgen, wie zum Beispiel Datenverlust.