Styleguide: Beschreibung der Oberfläche
Allgemeines
Zu jeder Maske wird ein Hilfe-Artikel erstellt, in dem die Oberfläche beschrieben wird.
Die Oberfläche wird abgebildet, und nicht nur beschrieben. Dabei wird – wann immer möglich – Originalgröße verwendet. Die Abbildungen werden auf der rechten Seite angezeigt, z.B:
[[Bild:IntrahandelsstatistikEinstellungenDialog.png|right]]
Sollte die Abbildung zu groß sein und muss diese deshalb verkleinert dargestellt werden, dann wird neben der allgemeinen Beschreibung der Oberfläche diese verkleinerte Ansicht dargestellt. Als sinnvolle Größe hat sich hier 500px ergeben, also z.B.
[[Bild:Abbildung.png|500px|right]]
Die einzelnen logischen Bereiche dieser komplexen Oberfläche werden dann einzeln behandelt, dabei sind Ausschnittsbilder in Originalgröße anzuzeigen.
Einfache Darstellung
Die Abbildung des Oberflächenelements wird als erstes Element eingetragen:
[[Bild:Abbildung.png|right]]
Einleitendes Element
Jeder Oberflächenartikel beginnt mit einem einleitenden Text. Dieser umfasst:
- Eine Ein-Satz-Beschreibung der Funktion des Dialogs
- Wie man zu diesem Dialog gelangt. Wird dazu der Menüpfad angegeben, so wird dieser fett formatiert, die einzelnen Menüebenen werden durch Schrägstricht getrennt, z.B. Hauptmenü/Menü1/Menü2.
'''Hauptmenü/Menü1/Menü2''' - Wenn das Oberflächenelement nur zur Verfügung steht, wenn ein bestimmtes Modul freigeschaltet ist, muss das erwähnt werden. Dazu ist das Modul zu verlinken:
Dieser Dialog steht nur zur Verfügung, wenn [[Modul]] freigeschaltet ist.
Doku der einzelnen Oberflächenelemente
Links neben den Abbildungen werden die einzelnen Oberflächenelemente als Aufzählungsliste dokumentiert, z.B:
- Groupbox Beschreibung der Funktion der Elemente in der GroupBox
- Element eins Beschreibung der Funktion des ersten Elements
- Element zwei Beschreibung der Funktion des zweiten Elements
* '''Groupbox''' Beschreibung der Funktion der Elemente in der GroupBox
** '''Element eins''' Beschreibung der Funktion des ersten Elements
** '''Element zwei''' Beschreibung der Funktion des zweiten Elements
Beschrieben werden alle Oberflächenelemente, bis auf die Buttons OK, Abbrechen und Hilfe.
Unterhalb der Beschreibung der Elemente einer einzelnen Abbildung muss um einen Überlauf des Bildes zu verhindern ein Trenner eingefügt werden:
<br style="clear:both" />
Fußzeilen
Unterhalb des Artikels werden – abgetrennt durch eine Linie – Links angegeben:
- Zu dem zugehörigen Modul
- Falls von einem Prozess-Artikel auf diesen Artikel verlinkt wird der Link zu dem Prozessartikel, am besten ein Deeplink zu dem entsprechenden Abschnitt
- Falls der Artikel die Beschreibung eines Unterdialogs ist, der Link zu der Beschreibung des übergeordneten Oberflächenelements
- Falls der Artikel sich auf Fremdsoftware oder Hersteller bezieht ein externer Link zu dem Hersteller
Beispiel:
----
:''Siehe auch
:*''[[Link zum Modul]]
:*''[externer Link]
Des Weiteren müssen hier auch die Kategorien angegeben werden, z.B:
[[Category:Module]]
Einfache Darstellung: Übersichtsbeispiel
[[Bild:Abbildung.png|right]]
Dieses Element dient zur Demonstration des Hilfe-Beispiels.
Sie erreichen diese Funktion über den Menüpunkt '''Hauptmenü/Menü1/Menü2'''.
Dieser Dialog steht nur zur Verfügung, wenn [[Modul]] freigeschaltet ist.
* '''Groupbox1''' Beschreibung der Funktion der Elemente in der GroupBox1
** '''Element eins''' Beschreibung der Funktion des ersten Elements
** '''Element zwei''' Beschreibung der Funktion des zweiten Elements
* '''Groupbox2''' Beschreibung der Funktion der Elemente in der GroupBox2
** '''Element eins''' Beschreibung der Funktion des ersten Elements
** '''Element zwei''' Beschreibung der Funktion des zweiten Elements
<br style="clear:both" />
----
:''Siehe auch
:''[[Link zum Modul]]
:''[externer Link]
[[Category:Module]]
Komplexes Layout: Dokumentation von Unterbereichen
Besitzen Oberflächen deutlich abgetrennte Unterelemente (z.B. einzelne Tabs oder GroupBoxen) dann ist der Artikel entsprechend zu gliedern.
Dazu ist eine Table of Contents einzubauen. Die einzelnen Bereiche werden mit Unterüberschriften eingeleitet und entsprechend der Einfachen Darstellung gegliedert.
Beispiel:
[[Bild:Uebersichtsbild.png|right|Bildtitel]]
__TOC__
=Einführung=
Einleitender Text wie unter Einfache Darstellung/Einleitendes Element beschrieben.
<br style="clear:both" />
=Bereich1=
[[Bild:Bereich1.png|right]
GGf. Modulhinweise (wie unter Einfache Darstellung/Einleitendes Element beschrieben)
Oberflächenelemente als Aufzählungsliste (wie unter Einfache Darstellung/Doku der einzelnen Oberflächenelemente beschrieben)
<br style="clear:both" />
=Bereich2=
[[Bild:Bereich2.png|right]
GGf. Modulhinweise (wie unter Einfache Darstellung/Einleitendes Element beschrieben)
Oberflächenelemente als Aufzählungsliste (wie unter Einfache Darstellung/Doku der einzelnen Oberflächenelemente beschrieben)
<br style="clear:both" />
[…]
Fußzeile des Artikels (wie unter Einfache Darstellung/Fußzeilen beschrieben)
Ausnahme: Sind die Unterbereiche alle gleichzeitig sichtbar (GroupBoxen) und ist die Maske insgesamt so klein, dass diese ohne Verkleinerung darstellbar ist, sollte die einfache Darstellung gewählt werden (siehe oben).
Wird der Artikel zu lang (z.B. bei der Beschreibung der einzelnen Tabs des Dialogs Globale Einstellungen), dann müssen die einzelnen Bereiche in eigene Artikel ausgelagert werden.
Die so erzeugten Artikel werden wie unter einfache Darstellung beschrieben formatiert.
Im Hauptartikel werden die Bereiche dann wie folgt dargestellt:
=Bereich1=
[[Bild:Bereich1.png|thumb]
Ein-Satz-Beschreibung der Funktion des Bereichs.
:''Hauptartikel: [[Bereich1]]
<br style="clear:both" />
- Siehe auch