plugin:todo
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
plugin:todo [2019-03-10 21:10] – [Download and Installation] runout | plugin:todo [2020-08-21 23:52] – Incompatible with Hogfather bmolitor | ||
---|---|---|---|
Line 6: | Line 6: | ||
email : dokuwiki@sprossenwanne.at, | email : dokuwiki@sprossenwanne.at, | ||
type : Syntax, Action | type : Syntax, Action | ||
- | lastupdate : 2019-03-10 | + | lastupdate : 2020-06-17 |
- | compatible : Frusterick Manners, Elenor Of Tsort, Weatherwax, Adora Belle, Binky, Ponder Stibbons, Hrun, Detritus, Greebo | + | compatible : Frusterick Manners, Elenor Of Tsort, Weatherwax, Adora Belle, Binky, Ponder Stibbons, Hrun, Detritus, Greebo, !Hogfather |
depends | depends | ||
conflicts | conflicts | ||
Line 26: | Line 26: | ||
Search and install the plugin using the [[plugin: | Search and install the plugin using the [[plugin: | ||
- | |||
- | < | ||
- | |||
- | **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 48: | 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 87: | 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 - Lists ===== | ===== Lightweight Task Management System - Lists ===== | ||
Line 108: | Line 103: | ||
:!: | :!: | ||
- | ~~NOCACHE~~ | + | |
==== Omit Pages from TODOLISTs ==== | ==== Omit Pages from TODOLISTs ==== | ||
Line 119: | Line 114: | ||
~~TODOLIST~~ | ~~TODOLIST~~ | ||
- | |||
==== Counting todos and checked todos ==== | ==== Counting todos and checked todos ==== | ||
Line 128: | Line 122: | ||
==== Assignments (users to tasks) ==== | ==== Assignments (users to tasks) ==== | ||
+ | |||
Filter the assignments, | Filter the assignments, | ||
+ | |||
~~TODOLIST assigned: | ~~TODOLIST assigned: | ||
~~TODOLIST assigned: | ~~TODOLIST assigned: | ||
Line 137: | Line 133: | ||
==== 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 142: | Line 139: | ||
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 147: | Line 145: | ||
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 159: | Line 159: | ||
Filter the completion state, allowed values: '' | Filter the completion state, allowed values: '' | ||
+ | |||
~~TODOLIST completed: | ~~TODOLIST completed: | ||
~~TODOLIST completed: | ~~TODOLIST completed: | ||
Line 170: | Line 171: | ||
~~TODOLIST completedat:< | ~~TODOLIST completedat:< | ||
- | < | + | %%< |
Y-m-d like 2014-06-12 | Y-m-d like 2014-06-12 | ||
Line 177: | Line 178: | ||
invalid values will be substituted with today' | invalid values will be substituted with today' | ||
- | ===Completion User (Who checked it)=== | + | === Completion User (Who checked it) === |
Filter by user who checked the box. Comma separated list. | Filter by user who checked the box. Comma separated list. | ||
~~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 192: | Line 195: | ||
~~TODOLIST dueat:< | ~~TODOLIST dueat:< | ||
- | < | + | %%< |
Y-m-d like 2014-06-12 | Y-m-d like 2014-06-12 | ||
Line 207: | Line 210: | ||
==== Filter the namespace of the task list ==== | ==== Filter the namespace of the task list ==== | ||
+ | |||
[[https:// | [[https:// | ||
Line 213: | Line 217: | ||
It can be used with the following parameters: | It can be used with the following parameters: | ||
- | * '' | + | * '' |
- | * ''/'' | + | * ''/'' |
- | * ''< | + | * ''< |
- | * '' | + | * '' |
- | * '' | + | * '' |
~~TODOLIST ns:todo~~ | ~~TODOLIST ns:todo~~ | ||
Line 229: | Line 233: | ||
~~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 244: | Line 250: | ||
====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. | ||
====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 266: | Line 276: | ||
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 ==== |
plugin/todo.txt · Last modified: 2024-03-04 10:59 by einhirn