Differences

This shows you the differences between two versions of the page.

--- plugin:todo [2023-07-14 10:40] – einhirn
+++ plugin:todo [2024-08-29 19:04] (current) – [Render username] minor format change 108.249.172.5
@@ Line 6: / Line 6: @@
 email      : dokuwiki@sprossenwanne.at, marg@rz.tu-clausthal.de
 type       : Syntax, Action
-lastupdate : 2023-07-14
+lastupdate : 2024-05-10
-compatible : Frusterick Manners, Elenor Of Tsort, Weatherwax, Adora Belle, Binky, Ponder Stibbons, Hrun, Detritus, Greebo, Hogfather, Igor
+compatible : Frusterick Manners, Elenor Of Tsort, Weatherwax, Adora Belle, Binky, Ponder Stibbons, Hrun, Detritus, Greebo, Hogfather, Igor, Jack Jackrum, Kaos
 depends    :
 conflicts  :
@@ Line 67: / Line 67: @@
 ==== Render username ====
-Render the username as id, full name or not at all, allowed values: ''user'' or ''real'' or ''none''
+The ''username'' option can be added to the ''<todo ..>'' tag to select how the user name will be displayed. The available options are ''user'', ''real'', or ''none''.
+----
+=== ''user'' option ===
+  <todo @leo username:user>Task with username shown</todo>
+displays as
+  ☐ [leo]Task with username shown
+//**NOTE: ''user'' is the default render option.**//
+----
+=== ''real'' option ===
+  <todo @leo username:real>Task with users real name shown</todo>
+displays as
+  ☐ [Leo Eibler]Task with user's real name shown
+----
+=== ''none'' option ===
+  <todo @leo username:none>Task with no username shown</todo>
-  <todo @somebody username:real>Task with real username of somebody shown</todo>
+displays as
+  ☐ Task with no username shown
+//**NOTE: When a task is marked complete and the ''username'' is set to ''none'' the username is not displayed but is recorded in the ''<todo ..>'' tag.**//
 ==== Start and Due date ====
@@ Line 81: / Line 112: @@
 Colors,... can be set in the style.css file in the plugin directory (lib/plugin/todo)
-==== Show/Hide Start/Due Date ====
+==== Set task priority ====
+To set priority for to-do item add 1-3 exclamation marks in the opening tag:
-Do (not) show the Start/Due date, allowed values: ''yes'' or ''no''
+| ''!'' | low priority |
+| ''!!'' | medium priority |
+| ''!!!'' | high priority |
-  <todo showdate:yes start:YYYY-MM-DD>Text</todo>
+More than 3 exclamation marks are parsed as high priority.
+  <todo !!!>Text</todo>
 ==== Formatting ====
@@ Line 94: / Line 130: @@
 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]''.
+==== Uncheck All Button ====
+Add ''~~TODO:UNCHECKALL~~'' to the page. This generates a button with the label "Uncheck all todos". Once clicked, all ToDos of this page are reset. A minor edit with the summary "Unchecked all ToDos" is created.
 ===== Lightweight Task Management System - Lists =====
-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. This feature deprecates the previous 'searchpattern' plugin integration.
 ==== First turn off caching ====
@@ Line 286: / Line 326: @@
 For the current default download package (see start of this page) one should refer to its GitHub Atom Feed:
-{{rss>https://github.com/leibler/dokuwiki-plugin-todo/commits/master.atom date}}
+{{rss>https://github.com/leibler/dokuwiki-plugin-todo/commits/main.atom date}}
-=== Older / by hand ===
-Version 05/14/2014 (by [[user>runout|Markus Gschwendt]]):
-<del>[[https://github.com/runout-at/dokuwiki-plugin-todo/archive/master.zip|zip version 2014-05-14]]
-  * :!: This is no part (yet) of the "officicial" distribution but Markus' own version of the plugin, if you are installing Markus' ZIP, there may be some (but mainly harmless) confusion in the [[plugin:extension |Extension Manager]]</del>
-  * new option ''~~TODOLIST checkbox:yes|no~~''
-  * new option ''~~TODOLIST username:user|real|none~~''
-  * new option ''~~TODOLIST header:id|firstheader|none~~''
-  * Configuration of default values for above option in the Configuration Manager.
-  * If AllowLinks is off, render the TodoText as a link to the page where the todo is located
-  * new option: start and due date. (css) colored output when todo is started or due
-  * Assign multiple users to a todo
-Version 03/17/2014 (by [[user>leibler|Leo Eibler]]):
-[[http://www.eibler.at/dokuwiki-todo/download/dokuwiki-todo_20140317.zip|zip version 2014-03-17]] (eibler.at) (by [[user>leibler]]):
-  * if a todo is checked or unchecked a descriptive summary (text in todo) will be used for history
-  * todos can be assigned to email address
-  * @@MAIL@@ and @@USER@@ matches both for logged in users email address
-  * @@USER@@ matches logged in users username
-Additional changes in 03/17/2014 (by [[user>Klap-in]]):
-  * New listing syntax: ''~~TODOLIST~~'' with simplified filter options.
-  * Refactoring of code breaks the compatibility with current version (2013-06-16c) of searchpattern plugin
-  * **Not fixed issue with searchpatterns**: checking/unchecking of todos in searchpatterns listing don't work correct
-  * Checks modification dates, to protect against overwriting
-  * Locking in javascript, so only one request is done simultaneously
-  * Update javascript, refactor and reformat php
-  * Some other translatable texts
-Version 04/13/2013 (by Christian Marg and [[user>leibler|Leo Eibler]]):
-  * Bugfix script.js chk.attr('checked') by Christian Marg
-  * Bugfix configuration option Strikethrough
-Version 04/11/2013 (by [[user>leibler|Leo Eibler]]):
-  * add user assignment for todos (with @username syntax in todo tag e.g. <todo @leo>do something</todo>)
-  * add handler method _searchpatternHandler() for dokuwiki searchpattern extension.
-  * bugfix: encoding html code (security risk <todo><script>alert('hi')</script></todo>) - bug reported by Andreas
-  * bugfix: use correct <todo> tag if there are more than 1 in the same line - migrate changes made by Christian to current version of plugin (changed behaviour - when multiple todo-items have the same text, only the clicked one is checked)
-  * add description / comments and syntax howto about integration with searchpattern
-  * check compatibility with dokuwiki release 2012-10-13 "Adora Belle"
-  * remove getInfo() call because it's done by plugin.info.txt (since dokuwiki 2009-12-25 "Lemming")
-Version 04/05/2013 (by Leo Eibler/[[user>leibler]]):
-  * migrate to new dokuwiki version (use jQuery.post instead of sack()).
-  * add german language file.
-Version 08/16/2010 (by Babbage):
-  *  Fixed another bug where javascript would not decode the action text properly (replaced unescape with decodeURIComponent).
-For a full changelog, please visit http://www.digitalbrink.com/programs/dokuwiki_plugin_todo/?page=vhistory (up to v2010-08-16) and http://www.eibler.at/dokuwiki-todo/index_en.php#download (since v2013-04-05)
-==== Possible features for a next release ====
-Please post your ** feature requests ** on [[https://github.com/leibler/dokuwiki-plugin-todo/labels/enhancement|GitHub]]
-  * <del>Implement time management by using square brackets // [<startdate> // for latest starttime and // ]<enddate> // for latest finish time.</del> done: 2014-05-14 on github (missing feature: filter by dates) see [[https://github.com/leibler/dokuwiki-plugin-todo/issues/16|bug #16]]
-  * <del>Additional Option to render a list without ckeckboxes: \\ ~~TODOLIST checkbox:no|yes~~ \\ interesting to put the list in the sidebar: \\ ~~TODOLIST assigned:@@USER@@ checkbox:no completed:no~~</del> done: 2014-05-11 on github
-  * <del>Headers of the list with the first Header of the Page instead of the namespaces: \\ ~~TODOLIST header:firstheader~~</del> done: 2014-05-11 on github
-  * <del>Assign multiple users to a todo <todo @user1 @user2>task</todo></del> done: 2014-05-15 on github
-  * <del>Additional option to render the real name of the user instead of the username or nothing (e.g. useful when using @@USER@@): \\ <todo username:user|real|none> \\ ~~TODOLIST assigned:@@USER@@ username:none~~</del> done: 2014-05-11 on github
-  * <del>Can we have a filter of tasks "completedon", completedbefore and completedafter (similar to duebefore etc) so that we can see when tasks were completed.  Would be good to be able to list tasks by completed date (got to keep those minions working somehow</del>
-  * make it possible to have more than one todo tag in the same line (e.g. separated by %%\\%%) \\ this might be useful to have more than one todo in a box in a table (workaround to assign a task to multiple users)
-  * Would be cool to have tags , display single page of tagged tasks, formatting inside task, quick links to the  page, and priority of the task!! thanks:!
-  * <del>Can we have the list of tasks filtered on the start and due dates?  Allow filtering of jobs to show just those due in the next 7 days, or jobs starting in the next 7 days. Full examples in the [[https://github.com/leibler/dokuwiki-plugin-todo/issues/23|GIT page]] for how it might work. Update : I think this might now work using the duebefore and due after with the +10 -10 relative references only I can't get this to work myself. \\ Should work, only issue: then only tasks with given dates will be shown. We need an 'start-/due-ignore' option to solve this.</del>
-  * When TODO links are turned ON per [[#Allow actions to also link to pages with the same name?|here]], could Backlinks to the original TODO be made to work? That way, when TODO details are entered, it's easy to get back to the TODO item and check the box complete. :-)
-  * 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't work on the TODOLIST. Thanks for reading.
-    * 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 formatted DD.MM.YYYY (which is very common in Austria ;-)) \\ \\ I'm from Austria too ;) but the only useful order in the date format is YMD - especially for sorting. \\ Things are possible but don't make sense in some way.
-  * 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 having it in a list-like format (under each other) instead of on 1 lineing to use an actual list or paragraphs? I guess I might be able to achieve this by using %%\\%% \\ Also, it would be nice to allow links inside the todo, now I have to put a link after the todo or place it outside the todo, resulting in a line being half todo half link
-  * <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 "(5/10)"</del>  \\ \\ See the //short// option.  --- [[user>runout|runout]] //2017-08-28 10:12//
-  * Is it possible to show a list of todos filtered by "completed by" and "when" depending on who checked the checkbox?  Again its to keep the minions working.  I'd like to add a section for each tech to my "dashboard" page that shows me who has completed what tasks and when.  I currently have an outstanding task list for each tech but not a list of the work they say they've completed.  Something along the lines of ~~TODOLIST completedby:tech1 showcompleteddate:yes showcompletedtime:yes completedafter:-1~~ will show me the work they have completed today(no matter who it was assigned to).  Also something like ~~TODOLIST assigned:tech1 completed:yes showcompletedby:yes showcompleteddate:yes showcompletedtime:yes completedafter:-1~~ will show me their own tasks completed in the last day, when completed and by whom. \\  \\ try the option //completeduser// for filtering which user has checked the box. Showing the completed-date is not implemented.  --- [[user>runout|runout]] //2017-08-28 09:35//
-  * Change link option from "pages with the same name" to "by Attribute". For Example "@link:T0012" if a automatic naming scheme could be implemented, otherwise "@link:wiki:test:start" or external target like phone NR "@link:tel:+1356465654" or Websites "@link:https://www.dokuwiki.org".
-  * 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 ====
@@ Line 383: / Line 332: @@
   * [[plugin:todo:customisations|Customizations]]
-===== Discussion =====
-Is it possible to see time dedicated between own tasks and colleagues and friends?