Handbuch:Erweiterung/BlueSpiceChecklist

BlueSpiceChecklist ermöglicht das Einfügen einer Kontrollliste sowie eines Kontrollkästchens. Benutzer mit Bearbeitungsrechten können den Status oder den Wert direkt im Ansichtmodus ändern.

Hinweis:Checkboxen, die als Aufgaben definiert werden sollen, werden im Gegensatz hierzu über eine Aufgabenliste erstellt.

Kontrollliste

Die Kontrollliste wird als Content Droplet eingefügt. Der ausgewählte Listenwert kann nur im Lesemodus der Seite geändert werden. Dies erzeugt eine neue Seitenversion.

Droplet Kontrollliste

Listenwerte definieren

Die Listenwerte müssen vorab als Seite im Vorlagennamensraum definiert werden. Die Elemente müssen als ungeordnete Liste angelegt werden. Im Quelltext der Seite werden Listenpunkte mit einem * am Zeilenanfang erstellt.

Wenn Sie beispielsweise eine Liste von Pizzas erstellen möchten, in der eine bestimmte Pizza ausgewählt werden kann, können Sie die Seite Vorlage:Pizza mit folgendem Inhalt anlegen:

* Wähle Pizza... 
* Margherita
* Schinken 
* Salami
* Pilze
* Hawaii 
* Gamberetti
* Diavolo
* Siziliana
* Quattro Formaggi

Zusätzlich kann pro Eintrag eine Schriftfarbe (über HEX-Codes Schreibweise) angegeben werden:

 * Quattro Formaggi | #00FF00 

Liste einfügen

Die Liste kann nun im Auswahlmenü der Kontrollliste ausgewählt werden:

Liste auswählen

Quelltextansicht

Im Quelltext wird folgende Syntax erzeugt:

 <bs:checklist type="list" list="Vorlage:Pizza" value="Wähle Pizza..." />

Der Parameter list legt die Seite fest, auf der sich die vordefinierte Liste befindet; value legt den Wert fest, der voreingestellt sein soll.

Kontrollkästchen (nur im Quelltext)

Zusätzlich ist es möglich, im Quelltext Kontrollkästchen zu erstellen:

<bs:checkbox checked="false" /> Margherita
<bs:checkbox checked="true" /> Siziliana

Unterschiede der Kontrollkästchen zur Aufgabenliste

Funktion	Kontrollkästchen (BlueSpiceChecklist)	Aufgabenliste (Checklists)
Einfügen	im Quelltext	als Content Droplet über Tastaturkürzel [] im Quelltextmodus
Auswahl	im Lesemodus	im Lesemodus (Tracking der Statusänderung in der Versionsgeschichte) im visuellen Editor (kein Status-Tracking)
Statusanzeige	Kontrollkästchen zeigt Häckchen	Kontrollkästchen zeigt Häckchen geschlossene Aufgabe wird durchgestrichen
Übersicht	keine Übersicht	gefilterte Übersicht aller Aufgabenmöglich als Seiteneigenschaft gespeichert
Bearbeitungsrecht	Rollen: editor, author, maintenanceadmin, bot	Berechtigung "edit"

• 

  Kontrollkästchen

• 

  Aufgaben

Kompatibilität von Kontrollkästchen   v4.3+

Das Content Droplet Kontrollliste ist ab BlueSpice 4.3 verfügbar. Da sich hierdurch die Syntax geändert hat, müssen Kontrollkästchen, die mit dem Tag <bs:checklist /> erstellt wurden, entsprechend angepasst werden. Wenn es hier viele Einbindungen gibt, kann dies über die Spezialseite Text ersetzen umgesetzt werden.

Die Syntax <bs:checklist value="Salami" type="check" /> funktioniert ab BlueSpice 4.3 nicht mehr.

Neue Einbindung:

<bs:checkbox checked="false" /> Margherita
<bs:checkbox checked="true" /> Siziliana

Wichtig!Kontrolllisten und Kontrollkästchen können nicht gleichzeitig in eine Seite eingebunden werden.

Wenn Sie eine Kontrollliste auf einer Seite nutzen, können Sie zusätzlich eine Aufgabenliste einbinden.

Konfiguration

Folgende Einstellung kann über die Konfigurationsverwaltung vorgenommen werden:

• Checklistenänderungen als geringfügige Änderungen markieren: Wenn diese Einstellung aktiviert ist, werden Änderungen an einer Checkliste (z.B. Aktivieren eines Kontrollkästchens) im Ansichtsmodus als geringfügige Änderungen protokolliert. Wenn diese Einstellung inaktiv ist, wird eine Änderung der Checkliste als normale Version aufgezeichnet.
  
  

  kleinere Bearbeitung

Berechtigungen

Wenn eine Wiki-Seite eine Checkliste enthält, kann jeder Benutzer mit dem Recht checklistmodify die Checklistenwerte aktualisieren. Diese Aktion erfolgt im Ansichtsmodus der Seite. Standardmäßig können dies Benutzer in den Rollen editor, author, maintenanceadmin und bot.

Das magische Wort "checklist" (obsolet)   -v4.2

Hinweis:Wenn ein Benutzer mit Leseberechtigungen den Wert eines Kontrollkästchens oder einer Dropdown-Liste ändert, wird der Wert nicht gespeichert. Beim Aktualisieren der Seite wird der zuletzt gespeicherte Wert wieder angezeigt.

Um eine Checkbox (Kontrollkästchen) oder eine Checkliste auf einer Seite einzufügen:

1. Klicken Sie im visuellen Editor auf Einfügen > Mehr > Magisches Wort.
2. Klicken Sie auf checklist.
3. Klicken Sie auf Fertig. Es erscheint ein Dialogfenster.
   

   Dialogfenster für Checklisten

Anschließend wechseln Sie die Reiter, um den gewünschten Typ auszuwählen:

• Checkbox: Fügt ein einzelnes Kontollkästchen auf der Seite ein.
• Liste: Fügt ein Drop-down Menü auf der Seite ein. Die Liste muss als Vorlage bereits vordefiniert worden sein. (Siehe "Listen definieren")

Einer Seite können mehrere Checkboxen und Listen hinzugefügt werden.

1. Unter Gewählte Option legen Sie den angezeigten Standardwert fest.
2. Klicken Sie auf Fertig.

Nach dem Speichern der Seite können Benutzer mit Bearbeitungsrechten den ausgewählten Listenwert im Lesemodus ändern.

Ein Bot ist ein Computerprogramm, das automatisch Wikiseiten wiederherstellt oder updated, wenn es ausgeführt wird. Im Normalfall übernehmen Bots wiederkehrende Aufgaben, die zu groß sind, um sie händisch auszuführen.

Tag: XML-Tags, welche beliebig parametrisiert werden können und eine vom Programmierer gewünschte Ausgabe produzieren. Fügt man beispielsweise das <bs:bookshelf>-Tag ein, dann erhält der Artikel die Kapitelnavigation des PDF-Buches, in dem der Artikel verlinkt ist.

Technische Referenz: BlueSpiceChecklist

---

Feedback zur Dokumentation ist im Community-Forum möglich.