How to create TodoLists without the TodoListPlugin#

What you need#

In 2.2.x versions of JSPWiki the QueryPlugin was part of the McKessonApsWikiPlugins package. Currently the QueryPlugin is part of the CeryleWikiPlugins package, now maintained by Murray Altheim.


How to create the alternate TodoList#

Create a normal page, say SomePage.

Add the following commentbox at the top of the page:

%%commentbox
[TASK]\\[TODO]
%%
to identify the page as a task that you want to do.
It is not necessary to create pages named TASK and TODO, but it does no harm if you do.

Create your TodoListPage any way you wish.

To show a List of the tasks to be done on the TodoListPage, put the following command into the page:

[{Query pages='TO ([TASK] AND [TODO])'}]

To show a List of the tasks done on the TodoListPage, put the following command into the page:

[{Query pages='TO ([TASK] AND [DONE])'}]

To show a List of all tasks on the TodoListPage, put the following command into the page:

[{Query pages='TO [TASK]'}]

To change the status of a task from TODO to DONE, just click on the task name, edit the page, change [TODO] in the commentbox into [DONE], and save the page.

That's it.

Comments#

You don't need to put [TASK], [TODO], and [DONE] into a commentbox; you can put them into any place where you normally put your categories. The commentbox makes these 'Markers' just stand out.

You can easily extend this technique to differentiate different projects if you include a project name and/or priorities into the commentbox and into the Query command. Example:

%%commentbox
[TASK]\\[TODO]\\[MyProject]\\[TOP]
%%
[{Query pages='TO ([TASK] AND [TODO] AND [MyProject] AND [TOP])'}]

Advantages#

  • Task lists are created dynamically. No need to create a task page artificially and then insert an existing page into it.
  • Task are easily deleted: Just remove [TASK] from the page in question. This does not remove the page. You can keep it for whichever purpose you want.
  • Creates no artifical page names.
  • Uses commonly used terms like DONE and TODO) in a prominent place.
  • Everything can easily become task, just by adding Task into the commentbox, even if the pages already exist in your wiki.
  • If you use the McKessonApsWikiPlugins.jar, everything you need is already in place.

Disadvantages#

  • Still one page per task; if you don't like this write up a page manually.
  • You don't have checkmark boxes in front of the task items but only simple list bullets.
  • You need another plugin: the McKessonApsWikiPlugins.jar, but that is useful in other ways too.

-- ReinhardEngel


How about a Screenshot ?

--Anonymous, 10-Jun-2007

Add new attachment

Only authorized users are allowed to upload new attachments.
« This page (revision-5) was last changed on 10-Oct-2007 00:58 by MurrayAltheim