WikiOraApps> Main Web>HelpIndex>HelpChecklist (11 Jan 2010, JimCrum)EditAttach

Checklist Plugin

Tags:
create new tag

Table of Contents

ChecklistPlugin creates simple checklists. It handles the tags %CLI% (CheckList Item), %CHECKLIST%, %CHECKLISTSTART%, %CHECKLISTEND% and depends on the Smilies plugin.

A %CLI% tag creates a image button and a simple click on it changes the state of the image button. The default states are 'todo' (represented by a indifferent image button) and 'done' (represented by a thumbs up image button).

If you put a bullet list or a ordered list between %CHECKLISTSTART% and %CHECKLISTEND% every bullet/ordered list item gets a checklist item.

Every state change will be saved to a topic with name ChecklistItemState. It is possible to define states (default: todo and done) and matching icons. You can also put more than one checklist into a topic.

Syntax Rules

Just type a %CLI% (CheckList Item) into a topic to create a single checklist item. A simple mouse click on it will change the state of this item. If the last state is reached the item state falls back to the first state.

If you put a bullet or ordered list between %CHECKLISTSTART% and %CHECKLISTEND% every bullet/ordered list item gets a checklist item.

To modify the states or state icons you can set it with %CHECKLISTSTART% or %CHECKLIST% tag. This tags can also be used to create "reset" buttons and state legends.

All tags can be used with attributes documented in the Attributes section.

To create a link to the checklist item state topic you can put the following forced link on your checklist topic: 

  [[%TOPIC%ChecklistItemState]]
If you have installed the Spread Sheet Plugin you can find a statistics on this item state topic. And if you have installed the Edit Table Plugin you can edit the states directly on this topic.

Usage Examples

To change the state of a checklist item just click on it.

You type: You get: (simulated)
Example 1: Create a simple checklist:
  • second step icon was clicked one time
  • last step icon was clicked two times 
%CHECKLISTSTART%
   1 first step
   1 second step 
   1 last step 
%CHECKLISTEND%
  1. first step indifferent
  2. second step thumbs up
  3. last step indifferent
Example 2: Create a simple freehand checklist:
  • second step icon was clicked one time
  • last step icon was clicked two times 
   1 first step %CLI% 
   1 second step %CLI% 
   1 last step %CLI%
  1. first step indifferent
  2. second step thumbs up
  3. last step indifferent
Example 3: Create a checklist with three states and own icons:
  • second step icon was clicked one time
  • and third step icon was clicked two times 
%CHECKLISTSTART{states="todo|doing|done" stateicons=":no:|:-I|8-)"}%

   1 first step 
   1 second step
   1 third step 
%CHECKLISTEND%
  1. first step no
  2. second step indifferent
  3. third step cool!
Example 4: Create two checklists on a topic:
(ALERT! every %CHECKLIST% and every %CLI% tag needs a name attribute)
%CHECKLISTSTART{name="first checklist"}%
   1 first step 
   1 second step
%CHECKLISTEND%

%CHECKLIST{name="second checklist"}%

   1 first step %CLI{name="second checklist"}% 
   1 next step %CLI{name="second checklist"}%

  1. first step indifferent
  2. second step indifferent

  1. first step indifferent
  2. next step indifferent
Example 5: Create a checklist in a table: 
| *state* | *todo* |
| %CLI%   | first step |
| %CLI%   | second step |
state todo
indifferent first step
indifferent second step
Example 6: Create multiple lists with tables and hard linked item states to allow add/insert/remove items:
ALERT! The %EDITTABLE% and %CHECKLISTSTART% tag have to stay in the same line. 

ķITTABLE{changerows="on" format="|label,0,#%SERVERTIME{$year$month$day$hour$min$sec}%|text,50|"}%%CHECKLISTSTART{name="list1"}%
| *STATUS<br/>(click to change)* | *Item* | 
| #2007Feb07093710 | testitem |

%CHECKLISTEND%

ķITTABLE{changerows="on" format="|label,0,#%SERVERTIME{$year$month$day$hour$min$sec}%|text,50|"}%%CHECKLISTSTART{name="list2"}%
| *STATUS<br/>(click to change)* | *Item* |
| #2007Feb07093712 | second |

%CHECKLISTEND%

ķITTABLE{changerows="off" format="|label, 0, #2012May22053623 |text, 50|"}%

STATUS
(click to change) 		Item
indifferent testitem

ķITTABLE{changerows="off" format="|label, 0, #2012May22053623 |text, 50| "}%

STATUS
(click to change) 		Item
thumbs up second

Example 7: Create a legend and a reset button:
  • Hint: You can use multiple %CHECKLIST% tags to create more than one reset button or legend at any position of your checklist topic. 
%CHECKLISTSTART{showlegend="on" reset=":-I Reset"}%
   1 first step 
   1 next step
%CHECKLISTEND%
  1. first step indifferent
  2. next step indifferent

( indifferent - todo thumbs up - done ) indifferent Reset

Example 8: Create a button to set all states in a checklist to done:
  • the reset button was clicked
  • Hint: You can use multiple %CHECKLIST% tags to create more than one reset button. 
   1 first step %CLI% 
   1 next step %CLI% 

%CHECKLIST{reset=":ok: set all done @done"}%
  1. first step thumbs up
  2. next step thumbs up

thumbs up set all done

Example 9: Insert new items in an existing checklist without state lost:
  • first step and second step was clicked before new items ( first new inserted item and second new inserted item) were added
  • Hint: You can put a # instead of %CLI{id=""}% into a bullet or ordered list item to add/insert a checklist item with own id. This works only between %CHECKLISTSTART%...%CHECKLISTEND%. 
%CHECKLISTSTART%
   1 first step
      1 first new inserted item #MyFirstInsertedItem
   1 second step  
      1 second new inserted item %CLI{id="MySecondInsertedItem"}%
%CHECKLISTEND%
  1. first step thumbs up
    1. first new inserted item indifferent
  2. next step thumbs up
    1. second new inserted item indifferent

Attributes

Usage:
%CLI{attribute1="value1" attribute2="value2" ...}%
or %CHECKLIST{attribute1="value1" attribute2="value2" ...}%
or %CHECKLISTSTART{attribute1="value1" attribute2="value2" ...}%

Examples: 

%CHECKLIST{showlegend="on" reset=":-I Reset checklist"}%
%CLI{id="i1"}%

Attribute Usable in Tag(s) Comment Example
anchors %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		enables/disables link anchors (default: yes); if enabled a state change will scroll your topic to the clicked checklist item; useful for long checklists (useless if useajax is on) anchors="yes"
clipos %CLI%
%CHECKLISTSTART% 		determines the position of the checklist item icon (default: right); if you use another value than "left" the checklist item icon will be appended to a ordered or bullet list item clipos="left"
descr %CLI% a description for a checklist item used in the [[%TOPIC%ChecklistItemState]] topic; you can use it as a default option (without descr), e.g: %CLI{"my description"}% descr=""
descrcharlimit %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		character limit for a description (useful if no description was given and therefore it is stripped from the text before and after a checklist item) descrcharlimit="100"
id %CLI% unique id of a checklist item (default: autogenerated); useful and recommended if you insert new checklist items in an existing checklist with states id="myfirstownid"
name %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		a naming context (default: _default) - useful and recommended if you define more than one checklist on a topic (ALERT! if you use it in %CHECKLIST% you must use it in all related %CLI% tags too) name="mychecklist1"
notify %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		enables/disables mail notification if a item state was changed notify="off"
pos %CHECKLISTSTART% defines the reset button and legend position (default: bottom); if you use another value than "top" the button position falls back to default pos="bottom"
reset %CHECKLIST%
%CHECKLISTSTART% 		it enables a reset image button with a given text or icon (default: undefined); if you put a @ into the reset value, you can reset a checklist to the given , e.g: reset="@done :ok: set all done"; if you put a @STATESEL into the reset value you get a state selection popup with all states reset="Reset all @STATESEL"
showlegend %CHECKLIST%
%CHECKLISTSTART% 		if you set it to "on" a states legend with icons will be displayed (default: off),
e.g: ( indifferent - todo thumbs up - done) 		showlegend="off"
states %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		all known states (default: todo¦done; a list separated by a '¦') states="todo¦done"
stateicons %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		icons for all states separated by a '¦' (default: :-I¦:ok:); if you use common variables like %Y% in stateicons you have to use the tag after the first %, e.g: %Y% stateicons=":-I¦:ok:"
statesel %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		enables/disables state selection popup (default: off) statesel="on"
statetopic %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		set the checklist item state topic (default: <YourTopicName>ChecklistItemState) statetopic="MyItemStateTopic"
static %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		allow/disallow state changes of checklist items (usefull if you create summary pages of some items of different checklists) static="off"
template %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		template name (see Plugin settings / Templates ) template="patchday"
text %CLI% text will be attached to the item and will be clickable text="my first step"
tooltip %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		sets the tooltip of the state icons (substituted variables: %STATE% - current state; %NEXTSTATE% - next state; %STATEICON% - state icon; %NEXTSTATEICON% - next state icon; %STATES% - comma separated list of all states; %STATECOUNT% - number of states; %LEGEND% - a legend of all states and state icons) tooltip="%STATE%"
tooltipbgcolor %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		tooltip background color ( statesel popup background color is also effected) tooltipbgcolor="%WEBBGCOLOR%"
tooltipfixleft %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		offset to fix horizontal tooltip position tooltipfixleft="-163"
tooltipfixtop %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		offset to fix vertical tooltip position tooltipfixtop="0"
useajax %CLI%
%CHECKLIST%
%CHECKLISTSTART% 		enables/disables JavaScript/AJAX based item state changes (default: on) useajax="1"

Examples

Use this examples to check your installation:

  1. first step
  2. next step

State TODO
first step
next step

  • System 1
  • System 2

This Topic Is Referenced By These Topics:
Related Links: HelpChecklistChecklistItemState, HelpIndex

Was This Topic Useful to You?

Others rated this topic as shown. Please include your rating.
Choice
leftbarmainbarrightbar Very Useful (2)
-- JimCrum - 20 Feb 2008
Edit | Attach | Print version | History: r4 < r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r4 - 11 Jan 2010 - 00:06:09 - JimCrum
 
This site is powered by the TWiki collaboration platformCopyright © 2012 by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Permission to copy, distribute and/or modify is granted for this document under the GNU Free Documentation License.
Ideas, requests, problems regarding WikiOraApps? Send feedback