Manual:Extension/BlueSpiceChecklist

What is BlueSpiceChecklist?

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.

CheckList Functions

The checklist dropdown inserts:

• Recently used lists.
• Single checkbox elements.
• Newly created lists.

Multiple checkboxes and/or checklists comboboxes can be inserted into an articleadded to a page.

Create Checkboxes

Defining lists

Insert Checkbox : A checkbox is a single checkbox element. You insert a checkbox by clicking the Menu Icon or the 'Checklist elements' dropdown item. Ticking the checkbox in view mode alternates the checkbox hook between false and checked and updates the article's version history, edit mode doesn't update the history. Wikicode: The Code Editor (i.e. not the WYSIWYG Editor) edits checklist tags. i.e. the value="" unchecked states table below or the color hex codes further below. Clicking the inserts only. You need to add the Prepare Mail identifier.

                        <bs:checklist value="" /> Prepare Mail
<bs:checklist value="false" /> Book Hotel

                    

Creating Lists

Prepare Checklist : In order to insert a checklist in an article, you must first create a checklist template that contains the necessary check list elements. This is done by creating a new article in the Template namespace. For example create a new article named 'Template:Status'. Then in the Code Editor (i.e. not the WYSIWYG Editor) ad the check list items as exampled above, as a list. Save the Template and remember the Template's name as you need to add this name to Insert list dialogue below. Assign colors : To facilitate visibility, you can assign list element colors. This is done by entering the pipe symbol ( straight line ) after the item identifier followed by a HEX color code.

* Prepare Mail| #FF9900 * Book Hotel| #00FF00

Assign colors

To support element status visibility color codes can be linked to the list elements. This is done by adding the pipe symbol (straight line) after the list element name followed by the HEX color Code.

Typical colors;

Colour	Name	HEX-Code
	black	#000000
	grey	#888888
	red	#FF0000
	orange	#FF8800
	green	#00FF00
	blue	#0000FF
	magenta	#FF00FF

Screenshot Checklist WYSIWYG

Insert checklist : The WYSIWYG Editor checklist dropdown arrow enables you to insert checklists into your articles. You simply click a previously used template or as in this case add a new checklist. To insert a new checklist, select the Insert list item in the dropdown. Then in the popup click on the + sign to add a new template. You must now enter the exact template title created above. Clicking " Ok " inserts the template's checklist items into your current article.

Example of Checklist being used for employee and status allocations.

As and example, you can add in multiple table row lists to show a tasks status of tasks , this might look like this.

Authorisation

• Anyone who has write permissions can use the Checklist tag.
• Anyone who has the checklistmodify permission can modify a checklist.

Designation	Description	Standard group
checklistmodify	Allows you to change a checklist item	user

CheckList-Tag Paramaters

You can off course also use Wikicode to insert check boxes and checklists. A Checklist-Tag creates a single form field, which depending on the mode is a checkbox or select box. It has the following parameters:

Name	Description	Type / Value range	Default value
type	Modus: If the checklist item as a list or as	check, list	check
value	Current value	str	-
list	Contains the name of the page in the MediaWiki namespace of the list entries. Mandatory when type is 'list'	str	-
id	Optional indication of ID that can be used to identify the items	str	-

Classic MediaWiki

Classic MediaWiki does not provide checklist functionalityLists 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 create a page Template:Pizza with 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 saving this page, list "Pizza" would appear in "Option list" when inserting checklist.

            

Colors can be assigned to options using color's HEX code:

                * Quattro Formaggi|#FF8800
            

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

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

Our reference page.