Handbuch:Erweiterung/BlueSpiceChecklist

BlueSpiceChecklist ermöglicht das Einfügen von Checkboxen und Checklisten in eine Seite. Benutzer mit Bearbeitungsrechten können den Status/Wert der Checkbox bzw. Checkliste direkt im Ansichtmodus ändern.

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

Content Droplets   v4.3+

Das Checklist-Element ist ab BlueSpice 4.3 als [[Handbuch:Erweiterung/ContentDroplets/Symbol|Content Droplet "Kontrollliste"] verfügbar.

Da sich hierdurch die Syntax geändert hat, müssen existierende Checklist-Einbindungen angepasst werden. Wenn es hier viele Einbindungen gibt, kann dies über die Spezialseite Text ersetzen umgesetzt werden.

Die Einbindung eines Kontrollkästchens als <bs:checklist value="Salami" type="check" /> funktioniert in BlueSpice 4.3 nicht mehr.

• Kontrollkästchen: Muss als <bs:checkbox checked="false" /> bzw. <bs:checkbox checked="false" /> eingebunden sein.

Das magische Wort "checklist"   -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.
   

   Visueller Editor
2. Klicken Sie auf checklist.
   

   Magisches Wort 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 alle Redakteure den ausgewählten Listenwert im Lesemodus ändern.

Tags im Quelltext hinzufügen

Checklisten können auch direkt im Quelltext erzeugt werden.

Checkbox:

 <bs:checklist checked="false" type="check" /> 

Der Wert des Parameters checked kann true oder false sein, abhängig davon, ob die Checkbox im Ausgangszustand ausgewählt (true) oder nicht ausgewählt (false) sein soll.

Liste:

 <bs:checklist type="list" list="Vorlage:Pizza" value="Pizza auswählen" /> 

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

Sobald das Checklisten-Tag auf der Seite gespeichert wurde, können Benutzer beim Lesen der Seite im Lesemodus und die Werte ändern.

Listen definieren

Listen müssen vorab als Seiten im Vorlagennamensraum definiert werden.

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

* Wähle Pizza | #000000
* Margherita | #000000
* Schinken | #000000
* Salami | #000000
* Pilze | #00FF00
* Hawaii | #000000
* Gamberetti | #0000FF
* Diavolo | #000000
* Siziliana | #0000FF
* Quattro Formaggi | #00FF00

Beim Speichern dieser Seite erscheint beim Einfügen der Checkliste die Liste "Pizza" in der "Optionsliste".

Farben können mithilfe des HEX-Codes zugewiesen werden:

 * Quattro Formaggi | #00FF00 

Die Farbe #F00FF00 zeigt den Menüpunkt Quattro Formaggi grün an. Ohne Angabe der Farbe würde der Text standardmäßig schwarz bleiben.

Checkliste als Drop-down-Menü

Konfiguration

Folgende Einstellung kann über die Konfigurationsverwaltung vorgenommen werden:

• Checklistenänderungen als klein 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.

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.

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.

Technische Referenz: BlueSpiceChecklist

---

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