Manual:Extension/BlueSpiceChecklist

What is BlueSpiceChecklist?About checklists

BlueSpiceChecklist enabled inserting checkboxes and comboboxes to the page. These can be changed without the need to edit the page.

Using BlueSpiceChecklist It is easy to insert simple checklists into any wiki page. When a wiki page has a checklist, any user with edit rights can update the checklist values without switching into edit mode.

Checklist examples (checkbox and select menu)

Creating a checkbox

Checkbox will be inserted to page and, below it, a configuration panel will appear.

Here user can choose one of two tabs:

• Checkbox - only configuration for checkbox is marking it as selected or not selected

List - for lists (combobox), a

Checklist items can be inserted from "Insert" menu, by clicking on "Insert magic" button, while editing the page. In the list of tags available, choose "checklist" and click "Done".

with VisualEditor:

1. Click Insert in VisualEditor.
2. Click More.
3. Click Magic word.
4. Select checklist.
5. Choose checkbox or list in the configuration box.
   • Checkbox: creates a single checkbox. It can be pre-selected or not selected.
   • List: creates a combo box. A predefined list of options as well as the current status can be selected.

Magic word

Multiple checkboxes/comboboxes can be added to a page.

Defining listsan option list

Lists that Before a combobox can be selected when adding a checklist tag to the page are defined as pages in Template namespace. For example created, a template for the list items needs to be available. For example, to create a list of pizzas that can be selected one would , you need to create a page Template:Pizza with the following content:

                * Choose pizza|#000000
* Margherita|#000000
* Prosciutto|#000000
* Salami|#000000
* Fungi|#00FF00
* Hawaii|#000000
* Gamberetti|#0000FF
* Diavolo|#000000
* Siziliana|#0000FF
* Quattro Formaggi|#00FF00

            

Upon After saving this page, the list "Pizza" would appear in "appears in the select menu Option list" when inserting checklist.

Colors can be assigned to options each option using the color's HEX code: . The color value #FF8800 shows orange text.

* Quattro Formaggi|#FF8800

would show orange text. Without specifying the color text would remain default black.

Manually adding BlueSpiceChecklist tags

, text inherits the text color of the wiki page.

Adding checklists in source editing mode

In addition to using UI VisualEditor to add and edit the checklist tag, it can also be added to a page using wikitext. Syntax The syntax for adding the tag is:

• for checkboxes: <bs:checklist

• type="check"

• checked="true"

• />

Value of "checked" parameter can be "true" or "false", depending on whether checkbox is checked or not.

• for lists: <bs:checklist

• type="list"

• list="Template:Pizza"

• value="Choose

• pizza"

• />

Parameter "list" sets the page where predefined list is located, "value" sets current value selected.

BlueSpiceChecklist when viewing pages

Once checklist tag is inserted on page, users, while reading the page, without entering the edit mode, would be able to change values of check- and combo boxes.

Configuration

Every user with edit permission can change value of comboboxes, while only users insert and edit checkboxes and select menus. Users with "checklistmodify" permission would be able to modify can set the value of a combobox. checkbox or select menu (by default users). The following configuration can be changed in the Config manager:

• Mark checklist changes as minor edit: If this setting is active, changes to a checklist (for example, checking a checkbox) in view mode are logged as minor edits. If this setting is inactive, a change to the checklist is recorded as a regular version in the page history.
  
  

  minor edit

Related info

• Reference:BlueSpiceChecklist