Layout-Vorgaben: Unterschied zwischen den Versionen

Version vom 28. März 2017, 08:48 Uhr

Damit alle Seiten im Wiki eine einheitliche Struktur bekommen, haben wir uns zur Darstellung von Inhalten für diverse Vorlagen entschieden. Nachstehend erfolgt eine Erläuterung zu den einzelnen Vorlagen, sowie die Angabe des Quellcodes wie diese Vorgabe korrekt implementiert wird. Dabei muss der grün-kursiv markierte Code entsprechend angepasst werden. Zusätzlich erfolgt außerdem ein Beispiel in Form eines Bildes, wie das Ergebnis der Vorlage auf einer Seite letztendlich aussieht.

Breadcrumbs

Ergebnis: Breadcrumb einer vendit-Seite

Mit den Breadcrumbs wird in erster Linie die Menüstruktur des vendit-Clienten aufgegriffen. Sie deutet dem Bearbeiter aber auch an, wo genau er sich gerade befindet. Breadcrumbs werden ganz oben auf einer Seite mit mit Hilfe des nachstehenden Code eingefügt. Dabei ist zu beachten, dass die Zeile mit einem Leerschritt beginnen muss, wodurch ein Rahmen um den Breadcrumb erzeugt wird.

Quellcode für die Breadcrumb-Erzeugung:

 [[Hauptseite]] > [[vendit Client|''vendit''-Client]] > [[Menüpunkt]] > [[Untermenüpunkt]] > Seitentitel

Reiter-Struktur

Um die Struktur des vendit-Clienten beizubehalten, wird auch im Wiki die Reiter-Struktur beibehalten. Diese werden genau wie in vendit angelegt. Dabei werden für die einzelnen Reiter eigene Unterseiten angelegt werden, welche dann entsprechend eingebunden werden. Hierbei muss zunächst geprüft werden, ob sich der jeweilige Reiter in vendit ablösen lässt. Ist dies der Fall, kann die korrekte Seite über die "F1"-Taste ermittelt werden. Ist der Reiter nicht ablösbar, wir die Seite mit dem Menüpunkt vorweg betitelt, gefolgt von einem Unterstrich und der Bezeichnung des jeweiligen Reiters (Beispiel: Kunden_Bestellung/Lieferung). Die Reiterstruktur wird dabei wie folgt auf der Seite implementiert:

Quellcode zur Implementierung der Reiterstruktur sowie Einbindung von Unterseiten:

<tabber>
Reitername(fest) = {{:Menüpunkt_Reitername(fest)}} |-|
Reitername(ablösbar) = {{:Reitername(ablösbar)}}
</tabber>

Damit eine spätere Bearbeitung der eingebundenen Seiten auf einfache Art und Weise gewährleistet werden kann, muss nachstehender Quellcode um den Text eingefügt werden. Dadurch erscheint innerhalb eines Reiters eine Zeile mit der der Möglichkeit die eingebundene Seite direkt bearbeiten zu können. Befindet sich der Bearbeiter auf der eingebundenen Seite, ist die Zeile nicht länger sichtbar. Statt dessen erscheint eine Auflistung der Seiten, die diese Seite eingebunden haben. So kann nach der Bearbeitung einer eingebundenen Seite direkt wieder auf die gewünschte übergeordnete Seite navigiert werden.

Quellcode für Unterseiten, welche über in einer Reiterstruktur eingebunden werden sollen:

<includeonly><div align="right"> [ <span class="plainlinks">[{{fullurl:Seitenname|veaction=edit}} Bearbeiten]</span> 
| <span class="plainlinks">[{{fullurl:Seitenname|action=edit}} Quelltext bearbeiten]</span> ]</div>
----</includeonly>

Seiteninhalt

<br style="clear:both;"/><noinclude>
----
{| class="wikitable" align="left"
|'''Navigation:'''
{{Spezial:Linkliste/Seitenname|hidelinks=1|hideredirs=1}}
|}</noinclude>

Bilder

Ergebnis: Eingefügtes Bild

Bilder werden rechtsbündig als Vorschaubild eingefügt. Dieser verfügt über einen Rahmen und eine kurze Beschreibung. Um ein Bild dem Wiki hinzuzufügen, muss dieses zunächst über die Option "Datei hochladen" im Wiki gespeichert werden. Diese befindet sich unter den Werkzeugen auf der linken Seite. Hierbei ist nur das Hochladen folgender Bildformate erlaubt: png, gif, jpg, jpeg.

Quellcode zur Bildimplementierung:

[[ Datei:Bild.png | border | right | mini | Bildbeschreibung ]]

Feld- und Tabellenbeschreibungen

Ergebnis: Feldbeschreibungen

Werden die einzelnen Felder einer Maske bzw. die Spalten einer Tabelle beschrieben, so werden diese in Form einer Wiki-Tabelle mit den Spaltenüberschriften "Attribute" sowie "Beschreibung" aufgeführt. Die Tabelle wird dabei einmal eingerückt.

Quellcode für die Tabellenstruktur:

:{|class="wikitable" 
! Attribute
! Beschreibung
|-
| Feld
| Feldbeschreibung
|}

Ergebnis: Feldbeschreibungen mit Gruppierungen

Wurden die Felder einer Maske dabei in mehrere Gruppierungen aufgeteilt, so wird für jede Gruppierung eine eigene Tabelle angelegt. Dabei wird der Titel der jeweiligen Rahmen in Klammern gesetzt als Zusatz der Überschrift "Attribute" angehängt (z. B. Attribute (Allgemein)). Damit die verschiedenen Tabellen einheitlich aussehen, werden diese mit einer einheitlichen Größe implementiert, wobei die Spalte "Attribute" ebenfalls einen angepassten Größenwert erhält. Dieser wird nach eigenem Ermessen ausgewählt, muss aber für alle Tabellen gleich sein.

Quellcode für die Tabellenstruktur mit Größenangaben:

:{|class="wikitable" style="width:75em"
! style="width:10em" | Attribute
! Beschreibung
|-
| Feld
| Feldbeschreibung
|}

Anwender-Aktionen

Ergebnis: Anwender-Aktionen

Anwender-Aktionen werden in Form einer Aufzählung beschrieben. Dabei wird die Unterteilung der Aktionen wie in vendit übernommen. Zusätzlich wird eine weitere Unterteilung in Kontextmenü hinzugefügt, sofern weitere Anwender-Aktionen im Kontextmenü vorhanden sind. Die Anwender-Aktionen werden dabei wie folgt dargestellt.

Quellcode für das Aufzählungslayout

==== Anwender-Aktionen ====
----
'''Aktionsüberschrift 1'''
* '''Aktion''' Aktionsbeschreibung
* '''Aktion''' Aktionsbeschreibung


'''Aktionsüberschrift 2'''
* '''Aktion''' Aktionsbeschreibung


'''Kontextmenü'''
* '''Aktion''' Aktionsbeschreibung

Programm-Parameter

Ergebnis: Beschreibung von Parametern

Programm-Parameter werden als zusätzlicher Abschnitt in Form einer Tabelle mit einer Beschreibung aller möglichen Einstellungen dargestellt. Hierbei wird zunächst ein standardisierter Text eingebunden, welcher kurz die Bedeutung von Programm-Parametern erläutert. Programm-Parameter sollten nur von MDSI-Mitarbeitern angelegt bzw. umgesetzt werden, da dies sonst möglicherweise zu unerwünschten Ergebnissen führen kann. Die Beschreibung von Programm-Parametern wird daher ebenfalls von MDSI-Mitarbeitern vorgenommen. Zusätzlich zur Beschreibung der einzelnen Parameter wird bei der Beschreibung von Formularen oder Funktionen darauf explizit auf einen Programm-Parameter hingewiesen.

Beispiel zum Hinweis auf Parameter:

Die Vorbelegung für dieses Feld kann über den Parameter [programm > feld] gesteuert werden.

Quellcode zur Tabellenstruktur für die Programm-Parameter-Beschreibungen:

==== Programm-Parameter ====
----
{{Programm-Parameter}}
:{|class="wikitable" 
! Programm 
! Feld
! Einstellung
|-
| Programmname
| Feldname
| Beschreibung aller möglichen Einstellungen
* '''0''' : Beschreibung für Einstellung 0 
* '''1''' : Beschreibung für Einstellung 1
|}

Zusätzliche Dokumente

Ergebnis: Implementierung eines PDF-Dokumentes

Stehen für die Beschreibung bspw. eines neuen Moduls weitere Dokumente zur Verfügung, können diese als letzten Punkt der aktuellen Wiki-Seite hinzugefügt werden. Diese werden dabei so eingebunden, dass sich bei einem Klick darauf das jeweilige Dokument direkt öffnet und anschließend heruntergeladen werden kann. Um ein Dokument mit in die Seite einbinden zu können, muss dieses - ebenso wie bei einem Bild - zuvor über die Option "Datei hochladen" im Wiki gespeichert werden. Diese Option befindet sich unter den Werkzeugen auf der linken Seite und erlaubt nur das Hochladen des Dokumentenformates: pdf.

Quellcode zur Einbindung von PDF-Dokumenten

==== Dokumente ====
----
* [[Medium:Dokument.pdf|'''Dokumentenbezeichnung''']] Kurze Beschreibung zu dem Dokument