plugin:todo
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
plugin:todo [2017-08-28 10:12] – [Assignments (users to tasks)] runout | plugin:todo [2024-03-04 10:59] (current) – einhirn | ||
---|---|---|---|
Line 6: | Line 6: | ||
email : dokuwiki@sprossenwanne.at, | email : dokuwiki@sprossenwanne.at, | ||
type : Syntax, Action | type : Syntax, Action | ||
- | lastupdate : 2017-01-06 | + | lastupdate : 2024-03-04 |
- | compatible : Weatherwax, Adora Belle, Binky, Ponder Stibbons, Hrun, Detritus | + | compatible : Frusterick Manners, Elenor Of Tsort, |
depends | depends | ||
conflicts | conflicts | ||
Line 13: | Line 13: | ||
tags : todo, task, taskmanagement | tags : todo, task, taskmanagement | ||
- | downloadurl: | + | downloadurl: |
sourcerepo : https:// | sourcerepo : https:// | ||
bugtracker : https:// | bugtracker : https:// | ||
Line 25: | Line 25: | ||
===== Download and Installation ===== | ===== Download and Installation ===== | ||
- | Download | + | Search |
- | + | ||
- | **Download URL has changed:** Moved download link to Github " | + | |
- | + | ||
- | **Update Instructions: | + | |
- | + | ||
- | **Update Instructions: | + | |
===== Usage and examples ===== | ===== Usage and examples ===== | ||
- | Mostly deprecated since **// | + | ==== Creating tasks ==== |
- | ====Creating tasks==== | ||
After installing the plugin, simply enter this information on the page you wish to create the todo list: | After installing the plugin, simply enter this information on the page you wish to create the todo list: | ||
- | < | + | |
Each ''< | Each ''< | ||
Line 46: | Line 39: | ||
To create a checkbox that is check by default, create your todo like this: | To create a checkbox that is check by default, create your todo like this: | ||
- | <todo #>Title of todo Action</ | + | |
- | Using bulleted lists (*) is recommended, | + | Using bulleted lists ('' |
- | ====Assign tasks to persons==== | + | ==== Assign tasks to persons ==== |
- | To assign users use the @ symbol like this: | + | To assign users use the '' |
- | <todo @leo> | + | |
- | | + | <todo @leo #> |
The name of the user can use: | The name of the user can use: | ||
- | | + | |
+ | | ||
* No (white)spaces are allowed! | * No (white)spaces are allowed! | ||
So '' | So '' | ||
- | |{{http:// | + | {{http:// |
- | | {{http:// | + | |
+ | {{http:// | ||
Multiple users can be assigned in one todo (separated by space character). This way a todo can show up in todo lists of different users. | Multiple users can be assigned in one todo (separated by space character). This way a todo can show up in todo lists of different users. | ||
- | <todo @leo @runout @somebody> | + | |
==== Render username ==== | ==== Render username ==== | ||
Render the username as id, full name or not at all, allowed values: '' | Render the username as id, full name or not at all, allowed values: '' | ||
+ | |||
<todo @somebody username: | <todo @somebody username: | ||
Line 85: | Line 82: | ||
==== Show/Hide Start/Due Date ==== | ==== Show/Hide Start/Due Date ==== | ||
+ | |||
Do (not) show the Start/Due date, allowed values: '' | Do (not) show the Start/Due date, allowed values: '' | ||
<todo showdate: | <todo showdate: | ||
- | | ||
- | ====Formatting==== | + | ==== Formatting ==== |
- | Formatting is not allowed inside of the ''< | + | Formatting is not allowed inside of the '' |
- | ====QuickButton==== | + | ==== QuickButton ==== |
- | A quickbutton for inserting todo syntax is available in the editor toolbar. You can click the button (which is pictured as a checked-checkbox) or you can use the keyboard shortcut of [T]. | + | A quickbutton for inserting todo syntax is available in the editor toolbar. You can click the button (which is pictured as a checked-checkbox) or you can use the keyboard shortcut of '' |
- | ===== Lightweight Task Management System ===== | + | ==== Uncheck All Button ==== |
+ | Add '' | ||
+ | |||
+ | |||
+ | ===== Lightweight Task Management System | ||
The new version (since version 2014-03-17) of the todo plugin allows to create an easy to use task management system to collect all todos from all pages on a single page. | The new version (since version 2014-03-17) of the todo plugin allows to create an easy to use task management system to collect all todos from all pages on a single page. | ||
- | **First turn off caching** | + | ==== First turn off caching |
- | | + | |
- | Display all open and closed todos from all pages | + | :!: |
- | ~~TODOLIST~~ | + | |
+ | ~~NOCACHE~~ | ||
+ | |||
+ | ==== Omit Pages from TODOLISTs ==== | ||
+ | |||
+ | If you have pages you never want to include in TODOLISTs, you can put following on these pages: | ||
+ | |||
+ | ~~NOTODO~~ | ||
+ | |||
+ | ==== Display all open and closed todos from all pages ==== | ||
+ | |||
+ | ~~TODOLIST~~ | ||
==== Counting todos and checked todos ==== | ==== Counting todos and checked todos ==== | ||
Line 116: | Line 126: | ||
==== Assignments (users to tasks) ==== | ==== Assignments (users to tasks) ==== | ||
+ | |||
Filter the assignments, | Filter the assignments, | ||
+ | |||
~~TODOLIST assigned: | ~~TODOLIST assigned: | ||
~~TODOLIST assigned: | ~~TODOLIST assigned: | ||
Line 125: | Line 137: | ||
==== Show/Hide checkbox ==== | ==== Show/Hide checkbox ==== | ||
Do (not) show the checkbox, allowed values: '' | Do (not) show the checkbox, allowed values: '' | ||
+ | |||
~~TODOLIST checkbox: | ~~TODOLIST checkbox: | ||
| | ||
Line 130: | Line 143: | ||
Render the username as id, full name or not at all, allowed values: '' | Render the username as id, full name or not at all, allowed values: '' | ||
+ | |||
~~TODOLIST username: | ~~TODOLIST username: | ||
| | ||
Line 135: | Line 149: | ||
Render the header as pageID, as the first header of the page or not at all, allowed values: '' | Render the header as pageID, as the first header of the page or not at all, allowed values: '' | ||
+ | |||
~~TODOLIST header: | ~~TODOLIST header: | ||
==== Show/Hide Start/Due Date ==== | ==== Show/Hide Start/Due Date ==== | ||
+ | |||
Do (not) show the Start/Due date, allowed values: '' | Do (not) show the Start/Due date, allowed values: '' | ||
Line 147: | Line 163: | ||
Filter the completion state, allowed values: '' | Filter the completion state, allowed values: '' | ||
+ | |||
~~TODOLIST completed: | ~~TODOLIST completed: | ||
~~TODOLIST completed: | ~~TODOLIST completed: | ||
Line 158: | Line 175: | ||
~~TODOLIST completedat:< | ~~TODOLIST completedat:< | ||
- | < | + | %%< |
Y-m-d like 2014-06-12 | Y-m-d like 2014-06-12 | ||
or a value like +10 or -10 or 0 | or a value like +10 or -10 or 0 | ||
| | ||
- | invalid values will be substituted with todays | + | invalid values will be substituted with today' |
- | ===Completion User (Who checked it)=== | + | === Completion User (Who checked it) === |
- | Filter by user who ckeckded | + | Filter by user who checked |
~~TODOLIST completeduser: | ~~TODOLIST completeduser: | ||
+ | |||
==== Start/Due Date Filter==== | ==== Start/Due Date Filter==== | ||
+ | |||
Filter the TODOLIST by Start/Due Date. Absolute and relative Dates are possible. | Filter the TODOLIST by Start/Due Date. Absolute and relative Dates are possible. | ||
Line 180: | Line 199: | ||
~~TODOLIST dueat:< | ~~TODOLIST dueat:< | ||
- | < | + | %%< |
Y-m-d like 2014-06-12 | Y-m-d like 2014-06-12 | ||
Line 195: | Line 214: | ||
==== Filter the namespace of the task list ==== | ==== Filter the namespace of the task list ==== | ||
+ | |||
[[https:// | [[https:// | ||
Line 200: | Line 220: | ||
It can be used with the following parameters: | It can be used with the following parameters: | ||
- | | + | |
- | * ''/'' | + | |
- | * ''< | + | * ''/'' |
+ | * ''< | ||
+ | * '' | ||
+ | * '' | ||
~~TODOLIST ns:todo~~ | ~~TODOLIST ns:todo~~ | ||
Line 214: | Line 237: | ||
~~TODOLIST ns: | ~~TODOLIST ns: | ||
- | returns all todo's from the namespaces or pages under todo, starting with an r. | + | returns all todo's from the namespaces or pages under todo, starting with an '' |
===Example of 'all todos' | ===Example of 'all todos' | ||
- | |{{http:// | + | |
+ | {{http:// | ||
===Example of 'all todos' from many namespaces=== | ===Example of 'all todos' from many namespaces=== | ||
+ | |||
If you want to display more than one namespace in a single page, you can put a TODOLIST for each : | If you want to display more than one namespace in a single page, you can put a TODOLIST for each : | ||
Line 229: | Line 254: | ||
====Allow actions to also link to pages with the same name?==== | ====Allow actions to also link to pages with the same name?==== | ||
- | Default: Off\\ | + | Default: Off |
This option (when enabled) will allow your actions to also link to a page with the same name. This way, if you have important details about an action, you can place them in this link. | This option (when enabled) will allow your actions to also link to a page with the same name. This way, if you have important details about an action, you can place them in this link. | ||
+ | However, Backlinks to the TODO do not currently work. Also, if you use the [[plugin: | ||
====What namespace should your actions be created in (" | ====What namespace should your actions be created in (" | ||
- | Default: [Empty]\\ | + | Default: [Empty] |
This option allows you specify where actions links should be placed. Using " | This option allows you specify where actions links should be placed. Using " | ||
====Should the actions have strike-through applied when checked? | ====Should the actions have strike-through applied when checked? | ||
- | Default: On\\ | + | Default: On |
This option (when enabled) will place a strike-through in the actions that have been completed. When disabled, an action can be checked, but the text will not have strike-through applied. | This option (when enabled) will place a strike-through in the actions that have been completed. When disabled, an action can be checked, but the text will not have strike-through applied. | ||
===If AllowLinks is disabled, should clicking the actions' | ===If AllowLinks is disabled, should clicking the actions' | ||
- | Default: On\\ | + | Default: On |
When this option is enabled, and the links option is disabled, then clicking on the text of an action will mark that action as being complete. (Added with version 10-14-09) | When this option is enabled, and the links option is disabled, then clicking on the text of an action will mark that action as being complete. (Added with version 10-14-09) | ||
Line 251: | Line 281: | ||
Please request your features and issues in the tracker at https:// | Please request your features and issues in the tracker at https:// | ||
+ | |||
+ | ==== Known Issues ==== | ||
+ | |||
+ | The '' | ||
==== ChangeLog ==== | ==== ChangeLog ==== | ||
Line 256: | Line 290: | ||
For the current default download package (see start of this page) one should refer to its GitHub Atom Feed: | For the current default download package (see start of this page) one should refer to its GitHub Atom Feed: | ||
- | {{rss> | + | {{rss> |
=== Older / by hand === | === Older / by hand === | ||
Line 330: | Line 364: | ||
| | ||
* < | * < | ||
+ | |||
+ | * When TODO links are turned ON per [[#Allow actions to also link to pages with the same name? | ||
* Thank you for this wonderful plugin. I have one request. In TODOLIST, each todos links to the original page where it's located, Since table header does same action, in my opinion, that links are not needed. Instead, when I click the todo, mark as done would be nice. Also, since it's a link, changing text color doesn' | * Thank you for this wonderful plugin. I have one request. In TODOLIST, each todos links to the original page where it's located, Since table header does same action, in my opinion, that links are not needed. Instead, when I click the todo, mark as done would be nice. Also, since it's a link, changing text color doesn' | ||
+ | * This behavior can be changed on the configuration page so that the link points to a page named after the link | ||
- | * absolutely great plugin! thank you! \\ would it be possible to allow also dates formated | + | * absolutely great plugin! thank you! \\ Would it be possible to allow also dates formatted |
* Thank you for this excellent plugin! Would it be possible to augment each to-do item with two more fields: (a) details and (b) action taken? They are useful especially in cases where items are assigned to different people. The fields could be possibly hidden and get displayed only if a spoiler-like button is pressed. The first is needed in order to describe the assignment in detail and (b) should be a description by the person who acted on the assignment. | * Thank you for this excellent plugin! Would it be possible to augment each to-do item with two more fields: (a) details and (b) action taken? They are useful especially in cases where items are assigned to different people. The fields could be possibly hidden and get displayed only if a spoiler-like button is pressed. The first is needed in order to describe the assignment in detail and (b) should be a description by the person who acted on the assignment. | ||
- | * Very nice plugin! Started using it only 5 minutes ago and I already love it. I do have 1 question: is it possible to display tasks, without | + | * Very nice plugin! Started using it only 5 minutes ago and I already love it. I do have 1 question: is it possible to display tasks, without |
- | * I'm looking for a short kind of info string to be displayed after a page link, displaying how many todos the page have and how many of them that are checked, such as " | + | * <del>I'm looking for a short kind of info string to be displayed after a page link, displaying how many todos the page have and how many of them that are checked, such as " |
* Is it possible to show a list of todos filtered by " | * Is it possible to show a list of todos filtered by " | ||
- | * Change link option from "pages with the same name" to "by Attribute" | + | * Change link option from "pages with the same name" to "by Attribute" |
+ | * It would be great to have the option to be able to include wiki formatted links within the task so when I have a task to review another page in the wiki or an external URL I can put a formatted link in with a meaningful label rather than the full and often long URL displaying in the task and in the task list | ||
==== Subpages ==== | ==== Subpages ==== | ||
- | [[plugin: | + | * [[plugin: |
+ | |||
+ | ===== Discussion ===== | ||
+ | Is it possible to see time dedicated between own tasks and colleagues and friends? | ||
plugin/todo.1503907953.txt.gz · Last modified: 2017-08-28 10:12 by runout