Table of Contents
Do Plugin
Compatible with DokuWiki
- 2024-02-06 "Kaos" unknown
- 2023-04-04 "Jack Jackrum" yes
- 2022-07-31 "Igor" yes
- 2020-07-29 "Hogfather" yes
Similar to agenda, structtasks, todo
The do plugin allows users to create simple tasks in wiki pages. Those tasks may be assigned to other users and have a due date. Tasks can be listed in pages as well.
Syntax
There are two syntax elements:
do
for creating a taskdolist
for listing tasks
Both of them provide several options as described below.
Task
<do USER DATE>TEXT</do>
Create a new task TEXT, optionally assign it to USER or mark it as due on DATE; there is a toolbar button for this as well.
Part | Details |
---|---|
USER | User id as accepted by current authentication backend |
DATE | Date in format yyyy-mm-dd |
TEXT | Description of task. Task texts needs to be unique at a page. Duplicates are seen as same task. |
Listing
{{dolist>NAMESPACE?id=ID&status=(DONE|UNDONE)&limit=COUNT&md5=MD5&user=ASSIGNEE&creator=CREATOR&from=YYYY-MM-DD&to=YYYY-MM-DD}}
List tasks in NAMESPACE with optional additional filtering
Part | Details |
---|---|
NAMESPACE | Namespace to search for tasks |
id | Page to search for tasks |
status | Can have value DONE or UNDONE . Case insensitive. |
limit | Maximum number of items to display. |
md5 | Show only task with this MD5 value |
user | User id of assigned person or @USER@ |
creator | User id of creator |
from | Date YYYY-MM-DD |
to | Date YYYY-MM-DD |
Show the user’s open tasks in template
Several templates (like e.g., sprintdoc) support this plugin right out of the box.
In other cases you can show an icon with the current user's open tasks by adding the following code to your template:
/** @var helper_plugin_do $do */ $do = plugin_load('helper', 'do'); if ($do) { echo $do->tpl_getUserTasksIconHTML(); }
If the user has open tasks and they click on the icon, then a table with all their open tasks is shown as an overlay.
Toolbar
The toolbar button access a dialog for input of assignees and due date. Due date will show a date picker. If the Bureaucracy Plugin is installed, the toolbar dialog will give assignees suggestions as well.
Demo
See for demo at ICKEwiki.de.
Legacy Greebo and Hogfather compatibility
In 2019 the legacy version of this plugin was no longer compatible with Greebo. If you do not run Hogfather yet, get the 2019-09-26 compatible release and install it manually.
Development
The source code of the plugin is available at GitHub: cosmocode/do.
Changes
- Merge pull request #83 from dokuwiki-translate/lang_update_696_169240… (2023-08-21 10:28)
- translation update (2023-08-19 03:55)
- Merge pull request #82 from dokuwiki-translate/lang_update_652_168581… (2023-06-05 09:09)
- translation update (2023-06-03 21:15)
- Version upped (2023-02-13 23:50)
- Merge pull request #81 from nerun/master (2023-02-13 14:34)
- Added brazilian portuguese (pt-br) translation. (2022-11-20 18:34)
- Version upped (2021-03-16 23:50)
Bug reports and feature requests
Please refer to the Issue Tracker for reporting issues.