dokuwiki:ToDo, dokuwiki:Searchpattern

Description

This Plugin was created by Babbage:

• https://www.dokuwiki.org/plugin:todo
• http://www.digitalbrink.com/programs/dokuwiki_plugin_todo/
• GIT Repository on github: https://github.com/leibler/dokuwiki-plugin-todo (.git)

This Plugin was upgraded to work with the new version Release 2013-03-06 "Weatherwax RC1" of Dokuwiki and was successfully tested.
Attention: searchpattern plugin integration is deprecated since version 2014-03-17 - use new built-in ~~TODOLIST~~ syntax instead
Siehe ~~TODOLIST~~

Up to version 2013-04-13 this plugin in combination with my modified Dokuwiki searchpattern Plugin (http://www.eibler.at/dokuwiki-todo/download/dokuwiki-searchpattern_latest.zip) can be used to show and track all tasks on a single page.

Installation

Download the Plugin from download.
Unzip the ZIP file in your Dokuwiki Plugin Directory (usually DOKUWIKI-INSTALLATIONS-ORDNER/lib/plugins).

Activate the Plugin in the Administrator Panel.

Usage

Mark a text within the page and click to the Todo Symbol .

After the ToDo Symbol was clicked, the highlighted text will be surrounded by <todo&rt; Tags.

The ToDos can now be marked as done or already done todos can be marked as open.
ATTENTION: The function to mark the todo as done uses Javascript/AJAX!.

User assignment with @

With the new user-assignment function (since version 2013-04-11) can tasks be assigned to users.
This is done with the control character @ (at): <todo @person>:

Overview about all todos from all subpages with new ~~TODOLIST~~ syntax

The new (since version 2014-03-17) built-in ~~TODOLIST~~ syntax is a replacement for the ~~SEARCHPATTERN~~ integration.
Features:

• ~~TODOLIST~~ will display all open and closed todos from all pages
• ~~TODOLIST completed:no~~ will display all open todos from all pages
• ~~TODOLIST completed:yes~~ will display all closed todos from all pages
• ~~TODOLIST assigned:User1,User2~~ will display all open and closed todos from all pages assigned to User1 or User2
• ~~TODOLIST assigned:@@USER@@~~ will display all open and closed todos from all pages assigned to current logged in user
• ~~TODOLIST assigned:@@USER@@ completed:yes~~ will display all closed todos from all pages assigned to current logged in user
• ~~TODOLIST assigned:Gerrit,leo completed:no ~~ will display all closed todos from all pages assigned to user Gerrit or leo

Overview about all todos from all subpages

It is possible to show (collect) all tasks from all (sub-)pages on a single page and they can be completed on this page with the integration of the new version of dokuwiki searchpattern plugin.
To use this integration the searchpattern Plugin (at least version 2013-04-11) must be installed.
After the installation it can be activated by using this documentation:

• First turn off the cache with ~~NOCACHE~~
• All open (uncompleted) tasks will be displayed using ~~SEARCHPATTERN#'/<todo[^#>]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~
• All completed tasks will be displayed using ~~SEARCHPATTERN#'/<todo[^#>]*#[^>]*>.*?<\/todo[\W]*?>/'?? _ToDo ??~~
• It looks like this:
  
• All user assigned tasks will be displayed using ~~SEARCHPATTERN#'/<todo[^@>]*@([^\W]+)[^#>]*(#)?[^>]*>(.*?)<\/todo[\W]*?>/'?? $2,1,3 ??~~
  
• The number of all assigned tasks will be displayed using ~~SEARCHPATTERN#'/<todo[^@>]*@([^\W]+)[^#>]*(#)?[^>]*>(.*?)<\/todo[\W]*?>/'~~
  
• All tasks (without filtering) will be displayed using ~~SEARCHPATTERN#'/<todo[^>]*>.*?<\/todo[\W]*?>/'?? _todo ??~~
  
• The amount of all tasks (without filtering) can be displayed using ~~SEARCHPATTERN#'/<todo[^>]*>.*?<\/todo[\W]*?>/'~~
  

Searchpattern Plugin Examples

• Use the $ (dollar) option without additional list shows all matches
  ~~SEARCHPATTERN#'/FIXME[ \t]+([^ \t\n\r]+)([ \t]*)?([^ \t\n\r]+)?/i'?? $ ??~~
  
• Use the $ (dollar) option with comma separated list of matches which should be displayed (in this example 3rd bracket and 1st bracket)
  ~~SEARCHPATTERN#'/FIXME[ \t]+([^ \t\n\r]+)([ \t]*)?([^ \t\n\r]+)?/i'?? $3,1 ??~~
  

Settings

• The settings file of this plugin can be found in the plugin directory /conf/default.php or in the Administration Panel:
  
  
  

Download current version

• Plugin: todo 2014-03-17 - Public Release http://www.eibler.at/dokuwiki-todo/download/dokuwiki-todo_latest.zip
  testeted with Release 2013-12-08 "Binky" and Release 2013-05-10 "Weatherwax"
  
• Plugin searchpattern 2013-06-16c - Public Release http://www.eibler.at/dokuwiki-todo/download/dokuwiki-searchpattern_latest.zip
  testeted with Release 2013-05-10 "Weatherwax", Release 2013-03-06 "Weatherwax RC1" and Release 2012-10-13 "Adora Belle""
  

Versionhistory

• 2014-03-17 - Public Release http://www.eibler.at/dokuwiki-todo/download/dokuwiki-todo_20140317.zip testeted with Release 2013-12-08 "Binky" and Release 2013-03-06 "Weatherwax RC1"
  
  • Complete refactoring by Klap-In: better ajax and lock support, code cleanup
  • Add ~~TODOLIST~~ syntax to replace complex searchpattern statements by built-in method by Klap-In
  • Add @@USER@@ syntax to filter tasks/todos assigned to current logged user by Klap-In
  • Add support to assign todos for email address and @@MAIL@@ syntax to filter tasks/todos assigned to email address by Leo
  • @@USER@@ also searches for tasks assigned to email address of current logged in user by Leo
  • Use descriptive summary (todo text) on checking or unchecking todos by Leo
• 2013-04-13 - Public Release http://www.eibler.at/dokuwiki-todo/download/dokuwiki-todo_20130413.zip testeted with Release 2013-03-06 "Weatherwax RC1" and Release 2012-10-13 "Adora Belle""
  
  • Bugfix script.js chk.attr('checked') by Christian Marg
  • Bugfix configuration option Strikethrough
• 2013-04-11 - Public Release http://www.eibler.at/dokuwiki-todo/download/dokuwiki-todo_20130411.zip tested with Release 2013-03-06 "Weatherwax RC1" und Release 2012-10-13 "Adora Belle""
  Modified searchpattern plugin version 2013-04-12: http://www.eibler.at/dokuwiki-todo/download/dokuwiki-searchpattern_20130412.zip
  • Integration with Dokuwiki searchpattern Plugin
  • User assignment is now possible using <todo @leo>Task for Leo</todo>
  • Replaced getInfo() method with plugin.info.txt file
  • Check compatiblity with Dokuwiki Release 2012-10-13 "Adora Belle""
  • Description of the syntax in the comments and in plugin.info.txt file
  • Bugfix: changed behaviour - when multiple todo-items have the same text, only the clicked one is checked. Integration of solution from Andreas
  • Security-Bugfix: HTML and Javascript Codes will not be executed anymore.
• 2013-04-05 - Public Release http://www.eibler.at/dokuwiki-todo/download/dokuwiki-todo_20130405.zip tested with Release 2013-03-06 "Weatherwax RC1"
  • Uses jQuery.post instead of sack()
  • German Language-File added
• 2010-08-16 - Public Release https://www.dokuwiki.org/plugin:todo

Author

Ing. Leo Eibler

• http://www.eibler.at
• Send a message to Leo Eibler:
  
  Please check the numbers 6,8,9:
  0   1   2   3   4   5   6   7   8   9  
  Your e-mail address:
  
  Your message:
  
  

License

  Copyright Babbage (http://www.digitalbrink.com/programs/dokuwiki_plugin_todo/)

   GPL 2 (http://www.gnu.org/licenses/gpl.html)

source: www.eibler.at // 2013 Leo Eibler