Plugin: add new todo plugin
authorjoel <joel@web>
Tue, 27 May 2014 10:03:36 +0000 (06:03 -0400)
committeradmin <admin@branchable.com>
Tue, 27 May 2014 10:03:36 +0000 (06:03 -0400)
doc/plugins/contrib/todo.mdwn [new file with mode: 0644]

diff --git a/doc/plugins/contrib/todo.mdwn b/doc/plugins/contrib/todo.mdwn
new file mode 100644 (file)
index 0000000..d8ba056
--- /dev/null
@@ -0,0 +1,17 @@
+[[!template id=plugin name=todo author="Joël Porquet"]]
+[[!tag type/widget]]
+
+This plugin provides the todo [[ikiwiki/directive]], which enables a page to be marked as a todo page. Additionally a deadline date can be provided.
+
+An example of a page marked as todo could be:
+
+    \[[!todo deadline="3 April 1982"]]
+    # Title of what should be done for April 3, 1982
+    blabla
+
+This plugin also provides ways to display pages marked as todo, and can even sort those pages by deadline dates:
+
+    \[[!inline pages="* and todo() and !todo(done)" archive="yes" sort="todo(deadline)"]]
+
+The full documentation and source code can be found here:
+<https://joel.porquet.org/wiki/hacking/ikiwiki_todo/>