Manual:Extension/BlueSpiceChecklist

BlueSpiceChecklist allows inserting checklists and checkboxes for to-do lists with responsibilities and status settings.

What is BlueSpiceChecklist?

Magic word "checklist"

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

Using BlueSpiceChecklist

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".

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 predefined list of options as well as current status can be selected.

Multiple checkboxes/comboboxes can be added to a page.

Defining lists

Lists that can be selected when adding a checklist tag to the page are defined as pages in Template namespace.

For example to create a list of pizzas that can be selected one would It is easy to insert simple checklists into any wiki page. When a wiki page has a checklist, any user with checklistmodify rights can update the checklist values without switching into edit mode. These are by default users in the role editor, author, maintenanceadmin and bot.

Note: If a user with read permissions changes the value of a checkbox or drop-down list, the value will not be saved. Refreshing the page will show the last value that has been saved before.

To create a checklist item:

• Click Insert > More > Magic word in the visual editor.
  

  The visual editor
  
  
• Click checklist in the dialog window.
  
  

  Magic word checklist
• Click Done. Another dialog window appears.
  

  Dialog window for checklists

Now select the tab to select your checklist type:

• Checkbox: creates an individual checkbox.
• List: creates a drop-down menu.

A page can contain multiple checkboxes and lists.

Creating a checkbox

1. Toggle the switch in the dialog window on the checkbox tab to create an unselected checkbox. When this toggle is blue, the checkbox is pre-selected.
2. Select insert. The checkbox is now visible on the page. Write the text for a label or for an instruction next to the checkbox

After the page has been saved, all users can activate and deactivate the checkbox.

Creating a drop-down list

Selecting a checklist template

1. Select an existing option list in the List tab.
2. Under Selected option, choose the default value.
3. Click Done.

After saving the page, all users can change the selected list value in read mode.

Defining an option list

Before a combobox can be created, a template for the list items needs to be available. For example, to create a list of pizzas, 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 #00FF00 shows green text.

                * Quattro Formaggi|#FF8800#00FF00
            

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.

Checklist examples (checkbox and select menu)

Adding checklists in source editing mode

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

for checkboxes Checkbox:

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

                

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

• for lists

the checkbox should initially be selected (true) or deselected (false). List:

                    <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 pagesThe parameter list defines the template page that contains the list, value defines the initial selection.

Once a checklist tag has been saved on a page, users can change its value in read mode.

Configuration

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.

Every user with edit permission can change value of comboboxes, while only users with "checklistmodify" permission would be able to modify value of a combobox.

See also

Reference page for this extension. 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