Zur Dokumentation: Unterschied zwischen den Versionen

Aus SSV Wiki
Wechseln zu: Navigation, Suche
[unmarkierte Version][unmarkierte Version]
(Konventionen)
 
(38 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
== Konventionen ==
+
Auf dieser Seite erhalten Sie Informationen über die Gestaltung der Dokumentationen im Wiki.
  
Im Hilfe-Wiki werden die folgenden Konventionen verwendet:
+
Sie erfahren,
 +
* wie die einzelnen Elemente der Benutzeroberfläche heißen
 +
* welche Auszeichnungen verwendet werden
  
: {| 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><small>'''Status'''</small></center>
 
|Begriff im Menü
 
Begriff im Untermenü
 
|-
 
|<center><code>Button</code></center>
 
|Schaltfläche
 
|-
 
|<center><span style="font-variant:small-caps;">Manually</span></center>
 
|Begriff innerhalb eines Dropdown-Menüs
 
|-
 
|<center><tt>ssvadmin</tt></center>
 
|Inhalte für Eingabefelder, z.B. Passwörter oder IP-Adressen
 
|-
 
|<center>[[Hauptseite]]</center>
 
|Interner Link
 
|-
 
|<center>[http://ssv-embedded.de/ SSV Embedded]</center>
 
|Externer Link
 
|-
 
|
 
:::*
 
|Aufzählung
 
|-
 
|<center>✘</center>
 
|Voraussetzung für eine Handlung
 
|-
 
|<center>►</center>
 
|Einfacher Handlungsschritt
 
|-
 
|
 
::#
 
::#
 
|Nummerierte Handlungsschritte
 
|-
 
|<center>◆</center>
 
|Optionale Handlungsschritte
 
|-
 
|<center>✔</center>
 
|Ergebnis eines Handlungsschritts
 
|-
 
|
 
{| class="wikitable"; style= "border-left: 1px solid blue"
 
|[[File:Hinweis.jpg|50px|link=]]
 
|Lorem ipsum
 
dolor sit amet
 
|}
 
| Hinweise und Tipps zur erleichterten Bedienung
 
|-
 
|
 
{| class="wikitable"; style= "background-color:#FBEFF2; border-left: 1px solid red;"
 
|[[File:Vorsicht.jpg|60px|link=]]
 
|'''Vorsicht'''
 
Lorem ipsum
 
|}
 
| Das Ausführen einer Handlung hat unerwünschte Folgen, wie zum Beispiel Datenverlust.
 
|}
 
  
  
== Wie ist die Benutzeroberfläche aufgebaut? ==
+
== Aufbau der Benutzeroberfläche ==
 +
<br />
  
<br>
+
=== GUI Elemente ===
  
=== GUI Elemente ===
 
  
<br>
 
  
[[File:Oberfläche GUI 2.0.jpg|700px|left|Benutzeroberfläche]]
+
[[File:Oberfläche GUI 2.0.png|800px|thumb|left|Aufbau der Benutzeroberfläche]]
  
 
<br clear=all>
 
<br clear=all>
Zeile 87: Zeile 28:
 
|-
 
|-
 
|2
 
|2
|Optionsschaltfläche  
+
|Radiobutton  
 
|5
 
|5
 
|Dropdown-Menü
 
|Dropdown-Menü
Zeile 96: Zeile 37:
 
|Checkbox
 
|Checkbox
 
|6
 
|6
|Upload
+
|Upload-Schaltfläche
 
|9
 
|9
 
|Hauptschaltflächen
 
|Hauptschaltflächen
 
|}
 
|}
 
  
 
=== Hauptschaltflächen ===
 
=== Hauptschaltflächen ===
Zeile 106: Zeile 46:
 
[[File:Schaltflächen.JPG|mini|right|Hauptschaltflächen]]
 
[[File:Schaltflächen.JPG|mini|right|Hauptschaltflächen]]
  
Auf allen Seiten, auf denen Einstellungen möglich sind, befinden sich in der unteren, rechten Ecke die drei Hauptschaltflächen mit den folgenden Funktionen:
+
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:
  
* <code>OK</code>: Die veränderten Einstellungen werden gespeichert. Damit sie wirksam werden, ist ein Neustart erforderlich.
+
* '''[OK]''': Die veränderten Einstellungen werden gespeichert. Damit sie wirksam werden, ist ein Neustart erforderlich.
* <code>Apply</code>: 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.
* <code>Cancel</code>: 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, 14: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


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