README.md
1# Delete Page Button Plugin for DokuWiki
2
3Copyright (c) 2020 Damien Regad <dregad@mantisbt.org>
4
5The plugin adds a _Delete page_ button to DokuWiki's
6[PageMenu](https://www.dokuwiki.org/devel:menus).
7
8This provides a simpler, quicker and more intuitive way for users to
9delete wiki pages, compared to the
10[documented page deletion method](https://www.dokuwiki.org/page#delete_a_page).
11
12![Screenshot](images/screenshot.png)
13
14If JavaScript is enabled
15and the current [Template](https://www.dokuwiki.org/template)
16is supported by the plugin,
17a confirmation dialog will be displayed prior to deleting the page.
18
19![Confirmation](images/confirm.png)
20
21
22## License
23
24This program is free software; you can redistribute it and/or modify
25it under the terms of the
26[GNU General Public License, version 2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
27or later.
28
29This program is distributed in the hope that it will be useful,
30but WITHOUT ANY WARRANTY; without even the implied warranty of
31MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32GNU General Public License for more details.
33
34
35## Installation and Configuration
36
37Please refer to
38[the plugin's wiki page](https://www.dokuwiki.org/plugin:deletepagebutton)
39for information on how to install and configure this plugin in DokuWiki.
40
41If you install this plugin manually, make sure it is installed in
42`lib/plugins/deletepagebutton/` - if the folder is called differently,
43it will not work!
44
45
46## Compatibility
47
48This plugin has been tested with the following DokuWiki releases,
49and should work with later versions as well.
50- 2018-04-22b "Greebo"
51- 2020-07-29 "Hogfather"
52
53Earlier releases are not supported.
54
55The plugin has been tested with the default
56[DokuWiki](https://www.dokuwiki.org/template:dokuwiki) and the
57[Bootstrap3](https://www.dokuwiki.org/template:bootstrap3)
58Templates.
59Other Templates should work as well, as long as they use the same markup for
60Page Tools; otherwise, the page will be deleted without confirmation.
61
62
63## Support
64
65Source code and support for this plugin can be found at
66<https://github.com/dregad/dokuwiki-plugin-deletepagebutton>
67
68## Credits
69
70Icon: <https://materialdesignicons.com/icon/trash-can-outline>
71
72I first thought I could adapt
73[this old plugin](https://github.com/caillou/dokuwiki-plugin-delete)
74but I ended up restarting from scratch.
75