README.md
1Don't Feed Templates Plugin for DokuWiki
2========================================
3
4This plugin works together with TemplatePageName. By default, DokuWiki does not
5include pages with name starting by ``.``, ``-`` or ``_`` in feeds, which is
6enough to have templates hidden when listing namespaces. If you use the plugin
7TemplatePageName to change the default template names, chances are high that
8you will not start you template with one of these three characters to make your
9template editable online. In that case, you will have the template page listed
10in your feeds.
11
12This plugin makes sure these template pages do not appear in namespace listing
13feeds.
14
15By default, the plugin will get the template page names from the
16TemplatePageName plugin configuration, so you don't need to configure it twice.
17If you do not use TemplatePageName but still want to filter out some
18special template files (or if you use another plugin to achieve the same goal
19as TemplatePageName), you may still use the plugin. You need to activate the
20``always`` option that forces the plugin to activate, and you will also need to
21specify yourself the template page names for the two kinds of DokuWiki's
22templates (current namespace, or current and below namespaces).
23
24Installation
25------------
26
27If you install this plugin manually, make sure it is installed in
28``lib/plugins/dontfeedtemplates/``. If the folder is called differently the
29plugin will not work!
30
31Please refer to http://www.dokuwiki.org/plugins for additional info
32on how to install plugins in DokuWiki.
33
34----
35
36Copyright (C) Cilyan Olowen <gaknar@gmail.com>
37
38This program is free software; you can redistribute it and/or modify
39it under the terms of the GNU General Public License as published by
40the Free Software Foundation; version 2 of the License
41
42This program is distributed in the hope that it will be useful,
43but WITHOUT ANY WARRANTY; without even the implied warranty of
44MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45GNU General Public License for more details.
46
47See the COPYING file in your DokuWiki folder for details
48