Difference between revisions of "Manual:Extension/BlueSpiceChecklist"

[quality revision][quality revision]
(Tag: 2017 source edit)
 


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

About checklistsMagic word "checklist"[edit | edit source]

It is easy to insert simple checklists into any wiki page. When a wiki page has a checklist, any user with

edit

checklistmodify rights can update the checklist values without switching into edit mode.

Checklist examples (checkbox and select menu) Checklist examples (checkbox and select menu)

Creating a checkbox[edit | edit source]

Checklist items can be inserted 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 Magic wordChecklist2.png Checklist3.png Checklist4.png

Multiple checkboxes/comboboxes can be added to a pageThese 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
    The visual editor

  • Click checklist in the dialog window.
    Magic word checklist
    Magic word checklist
  • Click Done. Another dialog window appears.
    Dialog window for checklists
    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[edit | edit source]

  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[edit | edit source]

Selecting a checklist template
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[edit | edit source]

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
* Margherita
* Prosciutto
* Salami
* Fungi|#00FF00
* Hawaii
* Gamberetti|#0000FF
* Diavolo
* Siziliana|#0000FF
* Quattro Formaggi|#00FF00

After saving this page, the list "Pizza" appears in the select menu Option list.

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

                * Quattro Formaggi|#FF8800#00FF00
            
Without specifying the color, text inherits the text color of the wiki page.
Checklist examples (checkbox and select menu)
Checklist examples (checkbox and select menu)

Adding checklists in source editing mode[edit | edit source]

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

for checkboxes Checkbox:
                    <bs:checklist type="check" checked="true" />
                
for lists:
                    

                
The value of the paramter checked can be true or false, depending on whether the checkbox should initially be selected (true) or deselected (false). List:
                    <bs:checklist type="list" list="Template:Pizza" value="Choose pizza" />
                

BlueSpiceChecklist when viewing pages[edit | edit source]

                    

                
The 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[edit | edit source]

Every user with edit permission can insert and edit checkboxes and select menus. Users with "checklistmodify" permission can set the value of a 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 not recorded in the page history.
    minor edit
    minor edit


Related info

{{DISPLAYTITLE:Checklists}}
        __TOC__
            

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

            ==Magic word "checklist"==
        

        It is easy to insert simple checklists into any wiki page. When a wiki page has a checklist, any user with edit''checklistmodify'' rights can update the checklist values without switching into edit mode.[[File:Checklist5.png|alt=Checklist examples (checkbox and select menu)|center|650x650px|link=https://en.wiki.bluespice.com/wiki/File:Checklist5.png|thumb|Checklist examples (checkbox and select menu)]]
            
            ==Creating a checkbox==
            

            '''Checklist items can be inserted with VisualEditor:'''
            

            # '''Click''' ''Insert'' in VisualEditor.
            
            # '''Click''' ''More''.
            
            # '''Click''' ''Magic word.''
            
            # '''Select''' ''checklist''.
            
            # '''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. 
            
<br />
            
            {|
            
            |[[File:Manual:ve-magicword.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:ve-magicword.png|alt=Magic word|center|thumb|201x201px|Magic word]]
            
            |[[File:Checklist2.png|thumb]]
            
            |}
            

            {|
            
            |[[File:Checklist3.png|thumb]]
            
            |[[File:Checklist4.png|thumb]]
            
            |}
            

            Multiple checkboxes/comboboxes can be added to a page These are by default users in the role ''editor'', ''author,'' ''maintenanceadmin'' and ''bot''.
            
            {{Box Note|boxtype=note|Note text=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.[[File:Manual:ve-magicword.png|alt=The visual editor|center|thumb|222x222px|The visual editor]]<br />
            
            *'''Click''' c''hecklist'' in the dialog window.<br />[[File:Checklist2.png|thumb|link=https://en.wiki.bluespice.com/wiki/File:Checklist2.png|alt=Magic word checklist|center|450x450px|Magic word ''checklist'']]
            
            *'''Click''' ''Done''. Another dialog window appears.[[File:Manual:magicword-dialog-EN.png|alt=Dialog window for checklists|center|thumb|250x250px|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===
            

            #'''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.
            
            #'''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 ===
            
            [[File:Manual:Checklist4-EN.png|alt=Selecting a checklist template|center|thumb|400x400px|Selecting a checklist template]]
            <br />
            

            # '''Select''' an [[#Defining an option list|existing option list]] in the ''List'' tab.
            
            # Under Selected option, choose the default value.
            
            # '''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: 
        
<pre>
        
        * Choose pizza
        
        * Margherita
        
        * Prosciutto
        
        * Salami
        
        * Fungi|#00FF00
        
        * Hawaii
        
        * Gamberetti|#0000FF
        
        * Diavolo
        
        * Siziliana|#0000FF
        
        * Quattro Formaggi|#00FF00
        </pre>
        

        After saving this page, the list "Pizza" appears in the select menu ''Option list''.
        

        Colors can be assigned to each option using the color's [[wikipedia:Web_colors|HEX code]]. The color value #FF8800#00FF00 shows orangegreen text.
        <pre>* Quattro Formaggi|#FF8800#00FF00</pre>
        
        Without specifying the color, text inherits the text color of the wiki page.
            
            ==Adding checklists in source editing mode==
            
            In addition to using VisualEditor to add and edit the checklist tag, it [[File:Checklist5.png|alt=Checklist examples (checkbox and select menu)|center|650x650px|link=https://en.wiki.bluespice.com/wiki/File:Checklist5.png|thumb|Checklist examples (checkbox and select menu)]]
            
            ==Adding checklists in source editing mode==
            
            Checklists can also be added to a page using wikitext.
        
        The syntax for adding the tag is:
        
*for checkboxes: <code><nowiki><bs:checklist type="check" checked="true" /></nowiki></code>
            

            *for lists: <code><nowiki><bs:checklist type="list" list="Template:Pizza" value="Choose pizza" /></nowiki></code>
            

            ==BlueSpiceChecklist when viewing pages==
            <br />
            

            ==Configuration==
            

            Every user with edit permission can insert and edit checkboxes and select menus. Users with "checklistmodify" permission can set the value of a checkbox or select menu (by default users). Checkbox: <syntaxhighlight lang="text">
            <bs:checklist type="check" checked="true" />
            </syntaxhighlight>The value of the paramter ''checked'' can be ''true'' or ''false'', depending on whether the checkbox should initially be selected (true) or deselected (false).
            

            List:<syntaxhighlight lang="text">
            <bs:checklist type="list" list="Template:Pizza" value="Choose pizza" />
            </syntaxhighlight>The 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==
            
The following configuration can be changed in the [[Manual:Extension/BlueSpiceConfigManager|Config manager]]:
        

        {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceChecklist}}
        

        {{Box Links-en|Topic1=[[Reference:BlueSpiceChecklist]]}}
        

        [[en:{{FULLPAGENAME}}]]
        
        [[de:Handbuch:Erweiterung/BlueSpiceCheckList]]
Line 1: Line 1:
 
{{DISPLAYTITLE:Checklists}}
 
{{DISPLAYTITLE:Checklists}}
__TOC__
 
  
==About checklists==
+
'''BlueSpiceChecklist''' allows inserting checklists and checkboxes for to-do lists with responsibilities and status settings.
  
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.[[File:Checklist5.png|alt=Checklist examples (checkbox and select menu)|center|650x650px|link=https://en.wiki.bluespice.com/wiki/File:Checklist5.png|thumb|Checklist examples (checkbox and select menu)]]
+
==Magic word "checklist"==
==Creating a checkbox==
 
  
'''Checklist items can be inserted with VisualEditor:'''
+
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''.
 +
{{Box Note|boxtype=note|Note text=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.}}
  
# '''Click''' ''Insert'' in VisualEditor.
+
To create a checklist item:
# '''Click''' ''More''.
 
# '''Click''' ''Magic word.''
 
# '''Select''' ''checklist''.
 
# '''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.
 
  
 +
*'''Click''' ''Insert > More > Magic word'' in the visual editor.[[File:Manual:ve-magicword.png|alt=The visual editor|center|thumb|222x222px|The visual editor]]<br />
 +
*'''Click''' c''hecklist'' in the dialog window.<br />[[File:Checklist2.png|thumb|link=https://en.wiki.bluespice.com/wiki/File:Checklist2.png|alt=Magic word checklist|center|450x450px|Magic word ''checklist'']]
 +
*'''Click''' ''Done''. Another dialog window appears.[[File:Manual:magicword-dialog-EN.png|alt=Dialog window for checklists|center|thumb|250x250px|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===
 +
 +
#'''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.
 +
#'''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 ===
 +
[[File:Manual:Checklist4-EN.png|alt=Selecting a checklist template|center|thumb|400x400px|Selecting a checklist template]]
 
<br />
 
<br />
{|
 
|[[File:Manual:ve-magicword.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:ve-magicword.png|alt=Magic word|center|thumb|201x201px|Magic word]]
 
|[[File:Checklist2.png|thumb]]
 
|}
 
  
{|
+
# '''Select''' an [[#Defining an option list|existing option list]] in the ''List'' tab.
|[[File:Checklist3.png|thumb]]
+
# Under Selected option, choose the default value.
|[[File:Checklist4.png|thumb]]
+
# '''Click''' Done.
|}
 
  
Multiple checkboxes/comboboxes can be added to a page.
+
After saving the page, all users can change the selected list value in read mode.
  
 
===Defining an option list===
 
===Defining an option list===
Line 48: Line 56:
 
After saving this page, the list "Pizza" appears in the select menu ''Option list''.
 
After saving this page, the list "Pizza" appears in the select menu ''Option list''.
  
Colors can be assigned to each option using the color's [[wikipedia:Web_colors|HEX code]]. The color value #FF8800 shows orange text.
+
Colors can be assigned to each option using the color's [[wikipedia:Web_colors|HEX code]]. The color value #00FF00 shows green text.
<pre>* Quattro Formaggi|#FF8800</pre>
+
<pre>* Quattro Formaggi|#00FF00</pre>
Without specifying the color, text inherits the text color of the wiki page.
+
Without specifying the color, text inherits the text color of the wiki page.[[File:Checklist5.png|alt=Checklist examples (checkbox and select menu)|center|650x650px|link=https://en.wiki.bluespice.com/wiki/File:Checklist5.png|thumb|Checklist examples (checkbox and select menu)]]
 
==Adding checklists in source editing mode==
 
==Adding checklists in source editing mode==
In addition to using VisualEditor to add and edit the checklist tag, it can also be added to a page using wikitext.
+
Checklists can also be added to a page using wikitext.
 
The syntax for adding the tag is:
 
The syntax for adding the tag is:
  
*for checkboxes: <code><nowiki><bs:checklist type="check" checked="true" /></nowiki></code>
+
Checkbox: <syntaxhighlight lang="text">
 +
<bs:checklist type="check" checked="true" />
 +
</syntaxhighlight>The value of the paramter ''checked'' can be ''true'' or ''false'', depending on whether the checkbox should initially be selected (true) or deselected (false).
  
*for lists: <code><nowiki><bs:checklist type="list" list="Template:Pizza" value="Choose pizza" /></nowiki></code>
+
List:<syntaxhighlight lang="text">
 
+
<bs:checklist type="list" list="Template:Pizza" value="Choose pizza" />
==BlueSpiceChecklist when viewing pages==
+
</syntaxhighlight>The parameter ''list'' defines the template page that contains the list, ''value'' defines the initial selection.
<br />
 
  
 +
Once a checklist tag has been saved on a page, users can change its value in read mode.
  
 
==Configuration==
 
==Configuration==
  
 
+
The following configuration can be changed in the [[Manual:Extension/BlueSpiceConfigManager|Config manager]]:
Every user with edit permission can insert and edit checkboxes and select menus. Users with "checklistmodify" permission can set the value of a checkbox or select menu (by default users). The following configuration can be changed in the [[Manual:Extension/BlueSpiceConfigManager|Config manager]]:
 
  
 
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceChecklist}}
 
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceChecklist}}

Attachments

Discussions