xref: /plugin/todomover/README.md (revision 04b1da3789b6d07104d2cf804afd571d57195d24)
1*04b1da37SPedro Lopes# Todo Done Mover for DokuWiki
2*04b1da37SPedro Lopes
3*04b1da37SPedro LopesAdds a page action named **Move tagged todos**. When clicked, it rewrites the current page source by moving whole-line todo items whose opening tag contains a hashtag token to a bottom `## done` section.
4*04b1da37SPedro Lopes
5*04b1da37SPedro Lopes## Example
6*04b1da37SPedro Lopes
7*04b1da37SPedro LopesBefore:
8*04b1da37SPedro Lopes
9*04b1da37SPedro Lopes```text
10*04b1da37SPedro Lopes<todo>first thing</todo>
11*04b1da37SPedro Lopes<todo #plopes>second thing</todo>
12*04b1da37SPedro Lopes<todo due:monday>third thing</todo>
13*04b1da37SPedro Lopes```
14*04b1da37SPedro Lopes
15*04b1da37SPedro LopesAfter clicking **Move tagged todos**:
16*04b1da37SPedro Lopes
17*04b1da37SPedro Lopes```text
18*04b1da37SPedro Lopes<todo>first thing</todo>
19*04b1da37SPedro Lopes<todo due:monday>third thing</todo>
20*04b1da37SPedro Lopes
21*04b1da37SPedro Lopes## done
22*04b1da37SPedro Lopes<todo #plopes>second thing</todo>
23*04b1da37SPedro Lopes```
24*04b1da37SPedro Lopes
25*04b1da37SPedro Lopes## Install
26*04b1da37SPedro Lopes
27*04b1da37SPedro LopesCopy this folder to:
28*04b1da37SPedro Lopes
29*04b1da37SPedro Lopes```text
30*04b1da37SPedro Lopeslib/plugins/tododone/
31*04b1da37SPedro Lopes```
32*04b1da37SPedro Lopes
33*04b1da37SPedro LopesThen visit a DokuWiki page where you have edit permission and click **Move tagged todos** in the page tools/menu.
34*04b1da37SPedro Lopes
35*04b1da37SPedro Lopes## Notes
36*04b1da37SPedro Lopes
37*04b1da37SPedro Lopes- It only moves whole-line todo items, optionally preceded by a simple list marker such as `* ` or `- `.
38*04b1da37SPedro Lopes- It detects a hashtag token in the opening tag, e.g. `<todo #done>...</todo>`.
39*04b1da37SPedro Lopes- It does not move `<todo due:monday>...</todo>`.
40*04b1da37SPedro Lopes- It intentionally requires DokuWiki edit permission and a security token.
41*04b1da37SPedro Lopes- DokuWiki's native heading syntax is equals-sign based, not Markdown `##`. This plugin writes `## done` because that is the requested output. If your wiki does not use Markdown-style headings, change `DONE_HEADING` in `action.php` to something like `===== done =====` and adjust `finalLevelTwoSectionIsDone()` accordingly.
42