TodoEntryPlugin and TodoListPlugin work together to provide a crude way to manage a todo list on the wiki. These plugins are modeled (plagiarized) from Janne's weblog plugin. #

Note

These plugins are very much a work in progress. They are very crude.

This page descibes the TodoListPlugin.

Syntax:#

[{INSERT com.hurlbert.jspwiki.plugin.TodoListPlugin show=UNDONE}]

Parameters#

show (optional)

Default: UNDONE
This determines which tasks are displayed in the task list. Valid values are: UNDONE, DONE, or ALL

undoneicon (optional)

Default: '<img src="attach?page=pic/cb_off.png" />'
"UnDoneIcon" This is the html necessary to display whatever icon you would like in the first column of the list for tasks which are uncompleted. The default attempts to display a small unchecked checkbox icon (an unfilled square) that has been attached to the page 'pic' - as it is on the jspwiki.

doneicon (optional)

Default: '<img src="attach?page=pic/cb_on.png" />'
"DoneIcon" This is the html necessary to display whatever icon you would like in the first column of the list for tasks which have been completed. The default attempts to display a small checkbox icon (an unfilled square) with a checkmark in the center. It looks for this icon as an attachment to the page 'pic' - as it is on the jspwiki.

donetext (optional)

Default: done
This is the text used to determine whether the task has been completed or not. The default is the word, "done" - if a task begins with "done," such as "done: Buy Dog Food," then it will be considered as completed. If the task just says "Buy Dog Food" it will be concidered as uncompleted.

Using TodoListPlugin#

Display uncompleted tasks#

[{INSERT com.hurlbert.jspwiki.plugin.TodoListPlugin show=UNDONE}]

Display completed tasks#

[{INSERT com.hurlbert.jspwiki.plugin.TodoListPlugin show=DONE}]

Display uncompleted tasks preceded by smiley faces#

[{INSERT TodoListPlugin undoneicon='<img src=\"attach?page=pic/smile.png\" />'}]

The attached screenshot, 'TodoSample.jpg,' was created with this content:

[{INSERT com.hurlbert.jspwiki.plugin.TodoEntryPlugin}]

[{INSERT com.hurlbert.jspwiki.plugin.TodoListPlugin show=UNDONE}]
----
!Completed Items
[{INSERT com.hurlbert.jspwiki.plugin.TodoListPlugin show=DONE}]

Enjoy - Scott Hurlbert