Difference between revisions of "Manual:Extension/BlueSpiceChecklist"

__HIDETITLE__
            
            
            <bs:bookshelf src="Book:User manual" />
            
            
            
            __TOC__
            
            
            
            ==What is Checklist?==
            
            
            
            '''Checklist''' gives you the ability to create {{DISPLAYTITLE:Checklists}}
            
            
            
            '''BlueSpiceChecklist''' allows inserting checklists and checkboxes for to-do lists or task lists with responsibilities and status queries.
            
            
            
            ==Background==
            
            Checklist inserts wiki code elements which, depending on the mode chosen, appear as check or combo boxes.
            
            
            
            ==Where to find Checklist?==
            
            Checklist is a page editor menu item. ''Edit'' opens the page editor and [[File:Btn-WYSIWYG-Checklist.png|none|none]] opens the checklist dropdown.
            
            
            
            ==CheckList Functions==
            
            The checklist dropdown inserts
            
            
            
            * Recently used lists
            
            * Single checkbox elements
            
            * Newly created lists
            
            
            
            Multiple checkboxes and/or checklists can be inserted into an article.
            
            
            
            ==Create Checkboxes==
            
            {|
            
            |-
            
            ||
            
            [[File:BlueSpice-CheckList-Example_Checkbox.png|left|frame|alt=With checkboxes you can create simple to-do lists|With checkboxes you can create simple to-do lists]]
            
            
            
            ||'''Insert Checkbox''' : A checkbox is a single checkbox element. You insert a checkbox by clicking the Menu Icon [[File:Btn-Wikicode-Checkbox.png]] 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 <code>value=""</code> unchecked states table below or the color hex codes further below. Clicking the [[File:Btn-Wikicode-Checkbox.png]]inserts <bs:checklist value="false" /> only. You need to add the Prepare Mail identifier.
            
            
            
            |-
            
            | colspan="2"|
            
            
            <pre><bs:checklist value="checked" /> Prepare Mail
            
            
            <bs:checklist value="false" /> Book Hotel
            
            
            </pre>
            
            |}
            
            ==Creating Lists==
            
            {|
            
            |-
            
            ||[[File:BlueSpice-CheckList-List_creation.png|left|frame|alt=Screenshot : Prepare article list in seperate template|Screenshot : Prepare article list in seperate template]]
            
            ||'''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.
            
            
            
            |-
            
            | colspan="2"|
            
            
            <pre>* Prepare Mail| #FF9900
            
            * Book Hotel| #00FF00
            
            
            </pre>
            
            |}
            
            ===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. <br data-attributes="%20/"><br data-attributes="%20/">
            
            
            
            '''Typical colors;'''
            
            
            
            {| class="contenttable" style="width: 700px;"
            
            |-
            
            !|'''Colour'''
            
            !|'''Name'''
            
            !|'''HEX-Code'''
            
            |-
            
            | style="background-color: #000000;"| 
            
            ||black
            
            ||#000000
            
            |-
            
            | style="background-color: #888888;"| 
            
            ||grey
            
            ||#888888
            
            |-
            
            | style="background-color: #ff0000;"| 
            
            ||red
            
            ||#FF0000
            
            |-
            
            | style="background-color: #ff8800;"| 
            
            ||orange
            
            ||#FF8800
            
            |-
            
            | style="background-color: #00ff00;"| 
            
            ||green
            
            ||#00FF00
            
            |-
            
            | style="background-color: #0000ff;"| 
            
            ||blue
            
            ||#0000FF
            
            |-
            
            | style="background-color: #ff00ff;"| 
            
            ||magenta
            
            ||#FF00FF
            
            |}
            
            
            
            
            
            {|
            
            |-
            
            ||[[File:BlueSpice-Check-List-WYSIWYG.png|none|frame|alt=Screenshot Checklist WYSIWYG|Screenshot Checklist WYSIWYG]]
            
            ||
            
            '''Insert checklist''' : The WYSIWYG Editor checklist dropdown arrow[[File:Btn-WYSIWYG-Checklist.png|none|none]]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.
            
            
            
            |}
            
            
            
            {|
            
            |-
            
            ||
            
            [[File:BlueSpice-CheckList-Example.png|left|frame|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.
            
            
            
            
            
            
            
            {| class="contenttable sortable"
            
            |-
            
            !|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 <bs:checklist/> creates a single form field, which depending on the mode is a checkbox or select box. It has the following parameters:<br /><br />
            
            
            
            {| class="contenttable sortable"
            
            |-
            
            !|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 functionality.<br data-attributes="%20/"><br data-attributes="%20/"><br data-attributes="%20/"><br data-attributes="%20/"><br data-attributes="%20/">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 ''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.}}
            
            
            
            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 #00FF00 shows green text.
            
            
            <pre>* Quattro Formaggi|#00FF00</pre>
            
            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==
            
            Checklists can also be added to a page using wikitext.
            
            The syntax for adding the tag is:
            
            
            
            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]]
            
            [[Category:Content]]