xref: /plugin/todomover/README.md (revision 7d73518ef18365bbc0ab4394fbba4037e544a0b3)
104b1da37SPedro Lopes# Todo Done Mover for DokuWiki
204b1da37SPedro Lopes
304b1da37SPedro 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.
404b1da37SPedro Lopes
504b1da37SPedro Lopes## Example
604b1da37SPedro Lopes
704b1da37SPedro LopesBefore:
804b1da37SPedro Lopes
904b1da37SPedro Lopes```text
1004b1da37SPedro Lopes<todo>first thing</todo>
1104b1da37SPedro Lopes<todo #plopes>second thing</todo>
1204b1da37SPedro Lopes<todo due:monday>third thing</todo>
1304b1da37SPedro Lopes```
1404b1da37SPedro Lopes
1504b1da37SPedro LopesAfter clicking **Move tagged todos**:
1604b1da37SPedro Lopes
1704b1da37SPedro Lopes```text
1804b1da37SPedro Lopes<todo>first thing</todo>
1904b1da37SPedro Lopes<todo due:monday>third thing</todo>
2004b1da37SPedro Lopes
2104b1da37SPedro Lopes## done
2204b1da37SPedro Lopes<todo #plopes>second thing</todo>
2304b1da37SPedro Lopes```
2404b1da37SPedro Lopes
2504b1da37SPedro Lopes## Install
2604b1da37SPedro Lopes
2704b1da37SPedro LopesCopy this folder to:
2804b1da37SPedro Lopes
2904b1da37SPedro Lopes```text
30*7d73518eSPedro Lopeslib/plugins/todomover/
3104b1da37SPedro Lopes```
3204b1da37SPedro Lopes
3304b1da37SPedro LopesThen visit a DokuWiki page where you have edit permission and click **Move tagged todos** in the page tools/menu.
3404b1da37SPedro Lopes
3504b1da37SPedro Lopes## Notes
3604b1da37SPedro Lopes
3704b1da37SPedro Lopes- It only moves whole-line todo items, optionally preceded by a simple list marker such as `* ` or `- `.
3804b1da37SPedro Lopes- It detects a hashtag token in the opening tag, e.g. `<todo #done>...</todo>`.
3904b1da37SPedro Lopes- It does not move `<todo due:monday>...</todo>`.
4004b1da37SPedro Lopes- It intentionally requires DokuWiki edit permission and a security token.
4104b1da37SPedro 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