Mit dem Bureaucracy-Plugin können in DokuWiki Eingabeformulare erstellt werden.

Diese Formulare ermöglichen es, neue Wiki-Seiten nach einer einheitlichen Struktur anzulegen.

Das Plugin BureaucracyToolbar ergänzt die Formulare um eine Werkzeugleiste zur Eingabe von DokuWiki-Formatierungen.

Dieses Handbuch beschreibt die Einrichtung, Verwendung und Verwaltung solcher Formulare in RoWaWiki (RWW).

Die Erstellung einer neuen Seite erfolgt über drei voneinander getrennte Bestandteile:

1. Formular: Erfasst die benötigten Informationen.
2. Seitenvorlage: Definiert den Aufbau der neuen Seite.
3. Zielseite: Enthält die aus Formular und Vorlage erzeugten Informationen.

Die drei Bestandteile können in unterschiedlichen Namensräumen liegen.

Für RoWaWiki gelten folgende zentrale Namensräume:

Die Übersichtsseiten lauten:

• Formularverzeichnis
• Vorlagenverzeichnis

Jedes Formular und jede Seitenvorlage erhält eine eigene Wiki-Seite.

Das Bureaucracy-Plugin ermöglicht die Erstellung und Verarbeitung von Formularen.

Es unterstützt unter anderem:

• Eingabefelder
• Pflichtfelder
• Mehrzeilige Textfelder
• Feldvalidierung
• Automatische Seitenerstellung anhand einer Vorlage

Weitere Informationen:

https://www.dokuwiki.org/plugin:bureaucracy

Das Plugin BureaucracyToolbar ergänzt Formulare um eine Werkzeugleiste.

Unterstützte Funktionen sind:

• Fettschrift
• Kursivschrift
• Unterstreichung
• Code
• Aufzählungen
• Links

Die Werkzeugleiste wird mit folgender Anweisung eingebunden:

<bureaucracytoolbar>

Die Anweisung steht oberhalb des Formularblocks.

Weitere Informationen:

https://github.com/edwardcodelab/bureaucracytoolbar

Im Namensraum formulare: wird eine neue Seite erstellt.

Beispiel:

formulare:beispiel

Jedes Formular erhält einen eindeutigen, aussagekräftigen Seitennamen.

Ein einfaches Formular sieht folgendermaßen aus:

====== Neue Beispielseite ======

<bureaucracytoolbar>

%%<form>%%
action template vorlagen:beispiel beispiele:@@Kennung@@

fieldset "Stammdaten"

textbox "Kennung" !
textbox "Bezeichnung" !

fieldset "Beschreibung"

textarea "Beschreibung" x5

submit "Seite erstellen"
</form>

Das Zeichen ! kennzeichnet ein Pflichtfeld.

Mit x5 wird bei einem Textfeld die sichtbare Höhe festgelegt.

Im Namensraum vorlagen: wird eine eigene Seite angelegt.

Beispiel:

vorlagen:beispiel

====== @@Kennung@@ – @@Bezeichnung@@ ======

===== Stammdaten =====

^ Merkmal ^ Angabe ^
| Kennung | @@Kennung@@ |
| Bezeichnung | @@Bezeichnung@@ |

===== Beschreibung =====

@@Beschreibung@@

Platzhalter verbinden Formularfelder mit den entsprechenden Stellen der Seitenvorlage.

Sie werden durch doppelte @-Zeichen eingeschlossen.

Beispiel:

@@Bezeichnung@@

Der Platzhaltername muss exakt zur Bezeichnung des Formularfeldes passen.

Der Speicherort der erzeugten Seite wird in der Anweisung action template definiert.

Beispiel:

action template vorlagen:beispiel beispiele:@@Kennung@@

Die Anweisung besteht aus:

1. vorlagen:beispiel – verwendete Seitenvorlage
2. beispiele:@@Kennung@@ – Zielnamensraum und Seitenname

Das Formular kann sich unabhängig davon unter formulare:beispiel befinden.

Damit lassen sich zentral verwaltete Formulare für unterschiedliche Fachbereiche verwenden.

Für RoWaWiki wird empfohlen, den Zielnamensraum je Formular fest vorzugeben.

textbox "Bezeichnung" !

Das Feld ist verpflichtend.

textarea "Beschreibung" x5

Das Feld ist optional und besitzt eine sichtbare Höhe von fünf Zeilen.

Eingaben können durch reguläre Ausdrücke überprüft werden.

Beispiel für eine Kennung mit dem Format DG-001:

textbox "Kennung" /^DG-[0-9]{3}$/ !

Zulässige Beispiele:

• DG-001
• DG-025
• DG-999

Nicht zulässig sind beispielsweise DG-1 oder AB-001.

In mehrzeiligen Formularfeldern kann DokuWiki-Syntax verwendet werden.

==== Medikamente ====

  * Erster Eintrag
  * Zweiter Eintrag

[[gesundheit:medikamente:med-001|MED-001 – Relvar]]

Vor dem senkrechten Strich steht das Seitenziel, dahinter die sichtbare Beschriftung.

Die BureaucracyToolbar unterstützt das Einfügen der Syntax. Der korrekte Seitenpfad muss gegebenenfalls manuell ergänzt werden.

Vor der produktiven Verwendung sollte jedes neue Formular getestet werden.

Empfohlene Vorgehensweise:

1. Formularseite speichern und Darstellung prüfen.
2. Kontrollieren, ob alle Eingabefelder vorhanden sind.
3. Testdaten eingeben.
4. Eine Testseite erstellen.
5. Zielnamensraum und Seitennamen prüfen.
6. Übernahme aller Platzhalter kontrollieren.
7. Überschriften, Listen und Links überprüfen.
8. Testseite nach erfolgreicher Prüfung entfernen.

Bereits vorhandene Seiten dürfen nicht unbeabsichtigt überschrieben werden.

Die Erstellung neuer Seiten unterliegt den DokuWiki-Zugriffsrechten (ACL).

Für RoWaWiki gelten folgende Empfehlungen:

• Formulare dürfen nur berechtigten Personen zugänglich sein.
• Änderungen an Formularen und Vorlagen bleiben autorisierten Bearbeitern vorbehalten.
• Für die Zielnamensräume müssen die erforderlichen Erstellungsrechte vorhanden sein.
• Ein Formular darf keine Berechtigungen auf geschützte Fachseiten umgehen.

Änderungen an Formularen und Seitenvorlagen sollten aufeinander abgestimmt werden.

Dabei ist zu beachten:

• Feldnamen und Platzhalter müssen übereinstimmen.
• Änderungen an Vorlagen wirken sich auf künftig erzeugte Seiten aus.
• Bereits erstellte Seiten werden durch eine Vorlagenänderung nicht automatisch aktualisiert.
• Nach strukturellen Änderungen ist ein erneuter Funktionstest sinnvoll.

Das Formular zur Erstellung medizinischer Diagnoseseiten ist unter folgendem Pfad gespeichert:

Neue Diagnose (DG)

Die zugehörige Seitenvorlage:

Seitenvorlage Diagnose (DG)

Erzeugte Diagnoseseiten werden im Namensraum

gesundheit:medizinische-themen:

abgelegt.

• Bureaucracy-Plugin
• BureaucracyToolbar
• DokuWiki-Syntax
• DokuWiki-Zugriffsrechte