Vorlagen Download/TOClimit und Handbuch:Erweiterung/BlueSpiceChecklist: Unterschied zwischen den Seiten

Version vom 16. August 2023, 13:24 Uhr

BlueSpiceChecklist ermöglicht das Einfügen von Checkboxen und Checklisten in eine Seite z.B. für Aufgabenlisten mit Verantwortlichkeiten und Statusangaben.

Das magische Wort "checklist"[Bearbeiten | Quelltext bearbeiten]

Es ist einfach, eine Checkbox oder Checklisten in eine Wiki-Seite einzufügen. Wenn eine Wiki-Seite eine Checkliste enthält, kann jeder Benutzer mit dem Recht checklistmodify die Checklistenwerte aktualisieren, ohne in den Bearbeitungsmodus zu wechseln. Dies sind standardmäßig Benutzer in den Rollen editor, author, maintenanceadmin und bot.

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:

Klicken Sie im visuellen Editor auf Einfügen > Mehr > Magisches Wort.

Visueller Editor
1. Klicken Sie auf checklist.
  
  Magisches Wort checklist
  #'''Klicken''' Sie '''auf''' ''Fertig''. Es erscheint ein Dialogfenster.

Listen definieren[Bearbeiten | Quelltext bearbeiten]

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ü

Tags im Quelltext hinzufügen[Bearbeiten | Quelltext bearbeiten]

Checklisten können auch direkt im Quelltext erzeugt werden.

Checkbox:

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

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.

Konfiguration[Bearbeiten | Quelltext bearbeiten]

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

Weiterführende Links

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

@@ Zeile 1: / Zeile 1: @@
-<div class="downloadarea">
+'''BlueSpiceChecklist''' ermöglicht das Einfügen von Checkboxen und Checklisten in eine Seite z.B. für Aufgabenlisten mit Verantwortlichkeiten und Statusangaben.
-<span class="getButton">[[Medium:HW-TOClimit.zip|Download]]</span>
+==Das magische Wort "checklist"==
+Es ist einfach, eine Checkbox oder Checklisten in eine Wiki-Seite einzufügen. Wenn eine Wiki-Seite eine Checkliste enthält, kann jeder Benutzer mit dem Recht ''checklistmodify'' die Checklistenwerte aktualisieren, ohne in den Bearbeitungsmodus zu wechseln. Dies sind standardmäßig Benutzer in den Rollen ''editor'', ''author'', ''maintenanceadmin'' und ''bot''.
+{{Hinweisbox|boxtype=note|Note text=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:
+#'''Klicken''' Sie im visuellen Editor '''auf''' ''Einfügen > Mehr > Magisches Wort''.[[Datei:Handbuch:VE-insert-magicwordDE.png|alternativtext=Visueller Editor|zentriert|mini|220x220px|Visueller Editor]]
+##'''Klicken''' Sie '''auf''' ''checklist''.[[Datei:Handbuch:Checklist2.png|alternativtext=|zentriert|mini|Magisches Wort ''checklist'']]#<nowiki>'''</nowiki>Klicken<nowiki>'''</nowiki> Sie <nowiki>'''</nowiki>auf<nowiki>'''</nowiki> <nowiki>''</nowiki>Fertig<nowiki>''</nowiki>. Es erscheint ein Dialogfenster.
-[[Datei:template-download-TOClimit.png|450x450px]]</div>
+==Listen definieren==
-Diese Vorlage kann über die Editorleiste im Wiki in eine Seite eingebunden werden. Sie ermöglicht es, die Ebenen des Inhaltsverzeichnisses einer Seite zu begrenzen.
+Listen müssen vorab als Seiten im Vorlagennamensraum definiert werden.
-==Import der Vorlage==
-Die benötigte Import-Datei befindet sich im Archiv ''HW-TOClimit.zip''. Sie enthält die Datei ''HW-TOClimit.xml''.
-Führen Sie auf der Seite '''''Spezial:Import''''' in Ihrem Wiki folgende Schritte durch:
+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:
-#'''Entpacken''' Sie die zip-Datei.
+<pre>
-#'''Klicken''' Sie ''Browse...'' und wählen Sie die Datei ''HW-TOClimit.xml''.
+* Wähle Pizza | #000000
-#'''Geben''' Sie ein Interwiki-Präfix '''an'''. Da dieses Feld erforderlich ist, geben Sie hier einfach ''hw'' (für hallowelt) ein.
+* Margherita | #000000
-#Belassen Sie die Vorauswahl ''Zu den Standard-Speicherorten'' importieren.
+* Schinken | #000000
-#'''Klicken''' Sie ''Datei hochladen...'' .
+* Salami | #000000
+* Pilze | #00FF00
+* Hawaii | #000000
+* Gamberetti | #0000FF
+* Diavolo | #000000
+* Siziliana | #0000FF
+* Quattro Formaggi | #00FF00
+</pre>
-Die Vorlage ist nun in Ihrem Wiki verfügbar.
+Beim Speichern dieser Seite erscheint beim Einfügen der Checkliste die Liste "Pizza" in der "Optionsliste".
-==Enthaltene Importdateien ==
+Farben können mithilfe des [https://de.wikipedia.org/wiki/Hexadezimale_Farbdefinition HEX-Codes] zugewiesen werden:
-Der xml-Import erstellt folgende Dateien in Ihrem Wiki:
+<pre> * Quattro Formaggi | #00FF00 </pre>
+Die  Farbe #F00FF00 zeigt den Menüpunkt Quattro Formaggi  grün an.
+Ohne Angabe der Farbe würde der Text standardmäßig schwarz bleiben.
+[[Datei:Handbuch:Checklist5.png|alternativtext=|zentriert|mini|Checkliste als Drop-down-Menü]]
-* Vorlage:TOClimit
+==Tags im Quelltext hinzufügen==
-* Vorlage:TOClimit/styles.css
+Checklisten können auch direkt im Quelltext erzeugt werden.
-==Verwendung==
+Checkbox:<pre> <bs:checklist type="check" checked="true" /> </pre>
+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.
-#'''Fügen''' Sie die Vorlage über den visuellen Editor ein.[[Datei:TOClimit 1.png|alternativtext=Vorlage TOClimit einfügen|zentriert|mini|350x350px|Vorlage TOClimit einfügen]]
+Liste:<pre> <bs:checklist type="list" list="Vorlage:Pizza" value="Pizza auswählen" /> </pre>
-#'''Geben''' Sie die Anzahl der gewünschten Überschriften-Ebenen ein (z.B. <code>1</code>).[[Datei:TOClimit 2.png|alternativtext=Überschriften-Ebenen begrenzen|zentriert|mini|350x350px|Überschriften-Ebenen begrenzen]]
+Der Parameter ''list'' legt die Seite fest, auf der sich die vordefinierte Liste befindet, ''value'' legt den Wert fest, der voreingestellt sein soll.
-#'''Speichern''' Sie die Seite. Das Inhaltsverzeichnis ist nun angepasst.
-{{Hinweisbox|boxtype=Hinweis|icon=|Note text=Wenn Sie nach dem Speichern der Vorlage Anpassungen an den Parametern vornehmen möchten, wechseln Sie in den Quellbearbeitungsmodus. Da das Inhaltsverzeichnis im visuellen Bearbeitungsmodus nicht angezeigt wird, wird die Vorlage in diesem Modus nicht angezeigt.|bgcolor=}}
-=== Parameter ===
+Sobald das Checklisten-Tag auf der Seite gespeichert wurde, können Benutzer beim Lesen der Seite im Lesemodus und die Werte ändern.
-Folgende Anpassungen sind möglich:
-{| class="wikitable" style=""
-|+
-!Parameter
-!Möglicher Wert
-!Beschreibung
-|-
-|limit
-|1, 2, 3, 4
-|<span style="color: rgb(32, 33, 34)">Ermöglicht die Tiefe des Inhaltsverzeichnisses zu bestimmen (bis Level 4)</span>
-|-
-|nonum
-|1
-|<span style="color: rgb(32, 33, 34)">Nummerierung wird nicht angezeigt bei Wert 1</span>
-|-
-|notitle
-|1
-|<span style="color: rgb(32, 33, 34)">Titel nicht angezeigt bei Wert 1</span>
-|-
-|noborder
-|1
-|<span style="color: rgb(32, 33, 34)">Rahmen wird nicht angezeigt bei Wert 1</span>
-|-
-|fontlarge
-|1
-|<span style="color: rgb(32, 33, 34)">Schriftgröße wird dem Seiteninhalt angepasst</span>
-|}
-=== Beispiele ===
+==Konfiguration==
-Begrenzung der Darstellung der Hauptebenen:<syntaxhighlight lang="text">
+Folgende Einstellung kann über die Konfigurationsverwaltung vorgenommen werden:
-{{TOClimit|limit=1|nonum=|notitle=1|noborder=1|fontlarge=1}}
+{{#dpl:title=Handbuch:Erweiterung/BlueSpiceConfigManager|include=#BlueSpiceChecklist}}
-</syntaxhighlight>
+{{Box Links|Thema1=[[Referenz:BlueSpiceChecklist]]}}
-'''Ausgabe vorher und nachher:'''
+[[en:Manual:Extension/BlueSpiceChecklist]]
+[[Category:Inhalt]]
-<gallery widths="250" heights="250">
-Datei:TOClimit vorher.png|alt=Standard-Darstellung eines Inhaltsverzeichnisses mit zwei Ebenen|Vorher
-Datei:TOClimit nachher.png|alt=Darstellung des Inhalstverzeichnisses mit der Hauptebene|Nachher
-</gallery>Hauptebenen in einer Reihe dargestellt:<syntaxhighlight lang="text">
-{{TOClimit|limit=1|nonum=1|notitle=1|noborder=0|fontlarge=0|inline=1}}
-</syntaxhighlight>
-[[Datei:TOClimit inline.png|alternativtext=Darstellung der Hauptebenen des Inhaltsverzeichnisses auf einer Reihe|zentriert|mini|650x650px|Inline-Inhaltsverzeichnis]]
-__NOTOC__