DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:do

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

plugin The do plugin allows users to create simple tasks in wiki pages

Last updated on
2022-11-20
Provides
Syntax, Helper, Action
Repository
Source
Requires
sqlite

Similar to agenda, structtasks, todo

Tagged with list, task, 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.

A CosmoCode Plugin

Greebo and Hogfather compatibility

The current version is no longer compatible with Greebo. If you do not run Hogfather yet, get the last compatible release and install it manually.

Syntax

There are two syntax elements.

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

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 button icon 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.

Development

The source code of the plugin is available at GitHub: cosmocode/do.

Changes

Bug reports and feature requests

Please refer to the Issue Tracker for reporting issues.

plugin/do.txt · Last modified: 2024-01-08 16:52 by Aleksandr

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki