Konfiguration - Hilfetexte erstellen

Beim erstellen der Hilfetexte zur Konfiguration sind einige Punkte zu beachten:

• Die Sektion für die die Hilfe geschrieben wird, ist eine Level 1 Überschrift und ist genau die Überschrift, die in der Konfiguration angezeigt wird.
• Der Name des Feldes das beschrieben wird muss exakt dem Namen auf der Konfigurationsseite entsprechen und ist eine Level 2 Überschrift.
• Auswahllisten Parameter die beschrieben werden, müssen exakt dem Namen des Parameters entsprechen und sind Level 3 Überschrift.

Im Hilfe Bereich der Konfiguration werden nur die Teile der Beschreibung angezeigt, welche auch gerade in der Konfiguration zu sehen sind. Dafür ist es wichtig, dass die gewählten Überschriften exakt den Namen in der Konfiguration entsprechen.

Hier nun ein Beispiel, wie so eine Beschreibung aufgebaut ist:

====== Konfiguration - Sektionsname ======

===== Feld Name =====
Beschreibung des Feldes

==== Auswahllisten Parameter ====
Beschreibung des Parameters