ChecklistTablePlugin

This plugin helps you to create a checklist with tables. A HTML form for a quick add of new entries and a table editor are also available.

ChecklistTablePlugin depends on the ChecklistPlugin if you use the item table cell format type.

Features

• table based checklists with persistent item states: you can add or remove items without state lost
• table row editor: a simple way to add, insert or (re)move table entries (rows)
• various table cell formats are supported (item, text, textarea, date, ...)
• automatic table format detection: simply put the %CHECKLISTTABLE% tag before an existing TWiki table to get a table editor

Syntax Rules

Simply put a %CHECKLISTTABLE% tag to a topic. You get a HTML form to create a checklist table.

You can use the %CHECKLIST% tag to customize the checklist states, icons ... (see ChecklistPlugin)

Usage Examples

1. a simple checklist table:

   %CHECKLISTTABLE%
        

2. a checklist table with your own table format:

   %CHECKLISTTABLE{format="|text,20|item|" header="|*Item*|*State*|"}%
        

3. a checklist table with special states and icons:

   %CHECKLIST{states="todo|doing|done" stateicons=":-(|:-I|%<nop>Y%"}%
   %CHECKLISTTABLE%
        

4. multiple checklist tables on the same topic with special states and icons:
   attend to the name attribute:

   ---++ Checklist Table ONE
   %CHECKLIST{name="checklist one" states="not ok|ok" stateicons=":-(|:ok:"}%
   %CHECKLISTTABLE{name="checklist one"}%
   
   ---++ Checklist Table TWO
   %CHECKLIST{name="checklist two" states="todo|doing|done" stateicons=":-(|:-I|%<nop>Y%"}%
   %CHECKLISTTABLE{name="checklist two"}%
         

Attributes

Example: %CHECKLISTTABLE{name="test"}%

Attribute	Description	Example/Default
allowmove	enables/disables buttons for move a entry (row) up or down	allowmove="off"
buttonpos	defines the button position of the row actions (edit, insert, move up/down, delete), allowed values: left, right (default), both	buttonpos="right"
changerows	enables/disables row changes (add/insert/remove); allowed values: on, off, add (= allows only add not remove)	changerows="on"
defaultcellformat	if the format attribute does not match with a given TWiki table the format of a table cell will be changed to this default	defaultcellformat="textarea,3x30"
format	table format (see Table Format section)	format="|item|text,30|textarea,3x30|"
header	table header: a TWiki table like header or 'off' to disable header	header="|*State*|*Item*|*Comment*|"
headerislabel	table headers are read-only (labels) if set to 'on'	headerislabel="on"
initdirection	initial sorting direction for initsort, set to "up" or "down"	initdirection="up"
initsort	column to sort initially ("1" to number of columns)	initsort="1"
name	name of the checklist	name="_default"
sort	switch table sort feature 'on' or 'off'	sort="on"
template	use template configuration; see template attribute of ChecklistPlugin topic	template="patchday"
quickadd	enables/disables the quick add formular below the table	quickadd="on"
quickinsert	enables/disables the quick insert formular if the mouse is over the insert button ()	quickinsert="on"
quietsave	enables/disables Quiet Save button (Quiet Save disables email notification)	quietsave="on"
Icons
deleterowicon	delete icon ()	deleterowicon="%ICONURL{choice-no}%"
dummyicon	placeholder if a action is not available	dummyicon="%ICONURL{empty}%"
editrowicon	edit row icon ()	editrowicon="%ICONURL{pencil}%"
edittableicon	edit table icon ()	edittableicon="%ICONURL{edittopic}%"
insertrowicon	insert row icon ()	insertrowicon="%ICONURL{plus}%"
moverowdownicon	move row down icon ()	moverowdownicon="%ICONURL{down}%"
moverowupicon	move row up icon ()	moverowupicon="%ICONURL{up}%"

Table Format

Attribute Syntax: format="| Type , Parameter , Default | ..."

Example: format="|label,0,#|row|item|text,20|textarea,2x20|select,1,0,1,2,3,4,5|radio,3,a,b,c,d,e,f|checkbox,3,A,B,C,D,E,F|date,20,,%Y/%d/%m|"

Per Cell Format

Examples

State	Item	Comment
Click me to change my state from 'todo' to 'doing' t: 2024-03-12 - 02:45 - Main.TWikiGuest, last state: todo	my first item	for test only
Click me to change my state from 'doing' to 'done' t: 2024-03-12 - 02:45 - Main.TWikiGuest, last state: todo	sdfsdf	asdfasdf
Click me to change my state from 'todo' to 'doing' t: 2024-03-12 - 02:45 - Main.TWikiGuest, last state: todo	my second item	for test too
Click me to change my state from 'todo' to 'doing' t: 2024-03-12 - 02:45 - Main.TWikiGuest, last state: todo

[x]  Insert a new entry (row)

|

Click me to change my state from 'todo' to 'doing'
t: 2024-03-12 - 02:45 - Main.TWikiGuest, last state: todo

| | |    |

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %CHECKLISTTABLEPLUGIN_SHORTDESCRIPTION%

Hints:

• You can setup every attribute of the %CHECKLISTTABLE% tag. You only have to use capital letters, e.g:
     * Set ALLOWMOVE = on
• Please use your Main.TWikiPreferences or TWiki.TWikiPreferences to setup plugin defaults. This prevents you from overwriting settings on plugin updates. E.g. put the following to your global preferences:
     * Set CHECKLISTTABLEPLUGIN_ALLOWMOVE = on

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Create a checklist table

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• Install (or upgrade to) the latest TWiki:Plugins.ChecklistPlugin plugin
• Download the ZIP file from the Plugin web (see below)
• Unzip ChecklistTablePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/ChecklistTablePlugin.txt	Plugin topic
  data/TWiki/VarCHECKLISTTABLE.txt	Plugin tag documentation
  lib/TWiki/Plugins/ChecklistTablePlugin.pm	Plugin Perl module
  lib/TWiki/Plugins/ChecklistTablePlugin/Core.pm	Perl module
  pub/TWiki/ChecklistTablePlugin/cltpinsertform.js	JavaScript module
  pub/TWiki/ChecklistTablePlugin/example.png	example image

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed
• Test if the installation was successful:
  • see Examples section

Plugin Info

Plugin Author:	TWiki:Main.DanielRohde
Copyright:	© 2007, TWiki:Main.DanielRohde
License:	GPL (GNU General Public License)
Plugin Version:	V1.005 (19 Aug 2010)
Change History:
V1.005 (19 Aug 2010)	TWiki:Main.DanielRohde: fixed changerows - quickadd combination bug; fixed TWiki 5 problems
V1.004 (16 Jan 2008)	TWiki:Main.DanielRohde: added initsort and initdirection feature; fixed numeric eq error; fixed missing default value rendering of 'date' format type;
V1.003 (22 Oct 2007)	TWiki:Main.DanielRohde: added quick insert feature; added new attributes (quickadd, quickinsert, buttonpos); fixed typos; fixed whitespaces in format bug; fixed (forced) link in text(area) bug;
V1.002 (30 Aug 2007):	TWiki:Main.DanielRohde: fixed major pre/verbatim bug; fixed and added documentation; added sort feature; added changerows attribute; added EDITCELL feature; fixed Opera bug; fixed topic lock bug
V1.001 (28 Aug 2007):	TWiki:Main.DanielRohde Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1 ChecklistPlugin, JSCalendarContrib
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Benchmarks:	GoodStyle 97%, FormattedSearch 99%, ChecklistTablePlugin 92%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/ChecklistTablePlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/ChecklistTablePluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/ChecklistTablePluginAppraisal

Related Topics: TWikiPlugins, ChecklistPlugin

-- TWiki:Main.DanielRohde - 20 Aug 2007