diff options
| author | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:46:32 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:46:32 -0400 |
| commit | bc7381c4f9f76cbef6bef27cc382a8246b58a4f7 (patch) | |
| tree | 30d1f252573f704eb27a09c48b96f2f0b0dda5ce | |
| parent | 9921a4a8a1a696ce69acce5e14943f0149d926ff (diff) | |
listdirectives: Enable use of the directives underlay.
| -rw-r--r-- | IkiWiki/Plugin/listdirectives.pm | 1 | ||||
| -rwxr-xr-x | Makefile.PL | 9 | ||||
| -rw-r--r-- | debian/changelog | 3 | ||||
| -rw-r--r-- | doc/plugins/listdirectives.mdwn | 16 |
4 files changed, 24 insertions, 5 deletions
diff --git a/IkiWiki/Plugin/listdirectives.pm b/IkiWiki/Plugin/listdirectives.pm index a5498a20a..6f8ddb06a 100644 --- a/IkiWiki/Plugin/listdirectives.pm +++ b/IkiWiki/Plugin/listdirectives.pm @@ -7,6 +7,7 @@ use strict; use IkiWiki 2.00; sub import { #{{{ + add_underlay("directives"); hook(type => "getsetup", id => "listdirectives", call => \&getsetup); hook(type => "checkconfig", id => "listdirectives", call => \&checkconfig); hook(type => "needsbuild", id => "listdirectives", call => \&needsbuild); diff --git a/Makefile.PL b/Makefile.PL index 78e659fe6..95e574c66 100755 --- a/Makefile.PL +++ b/Makefile.PL @@ -57,6 +57,15 @@ extra_install: install -m 644 $$file $(DESTDIR)$(PREFIX)/share/ikiwiki/$$dir; \ done; \ done + + # The directive docs become their own special underlay. + install -d $(DESTDIR)$(PREFIX)/share/ikiwiki/directives/ikiwiki/directive + for file in doc/ikiwiki/directive/*; do \ + if [ -f "$$file" ]; then \ + install -m 644 $$file $(DESTDIR)$(PREFIX)/share/ikiwiki/directives/ikiwiki/directive; \ + fi \ + done + for dir in `find templates -follow -type d ! -regex '.*\.svn.*'`; do \ install -d $(DESTDIR)$(PREFIX)/share/ikiwiki/$$dir; \ for file in `find $$dir -follow -maxdepth 1 -type f`; do \ diff --git a/debian/changelog b/debian/changelog index fd2079368..82e1fa474 100644 --- a/debian/changelog +++ b/debian/changelog @@ -14,6 +14,9 @@ ikiwiki (2.64) UNRELEASED; urgency=low * Directive documentation broken out of the plugin documentation and into pages suitable to be used as an underlay. Thanks to Willu for doing most of the tedious work. + * Move the directive documentation into its own underlay, separate from + basewiki, since it's sorta large compared to the rest of basewiki. + * listdirectives: Enable use of the directives underlay. -- Joey Hess <joeyh@debian.org> Mon, 08 Sep 2008 19:21:20 -0400 diff --git a/doc/plugins/listdirectives.mdwn b/doc/plugins/listdirectives.mdwn index 2f6691345..2939ff0ee 100644 --- a/doc/plugins/listdirectives.mdwn +++ b/doc/plugins/listdirectives.mdwn @@ -1,9 +1,15 @@ [[!template id=plugin name=listdirectives author="Will"]] [[!tag type/meta]] -This plugin provides the [[ikiwiki/directive/linkmap]] [[ikiwiki/directive]]. -The linkmap directive inserts a list of currently available directives into the page. +This plugin provides the [[ikiwiki/directive/linkmap]] +[[ikiwiki/directive]], which inserts a list of currently available +directives into the page. -Each directive links to a wiki page with the same name. The location of the -pages in the wiki can be controlled via the `directive_description_dir` -setting in the setup file. +Each directive links to a wiki page with the same name, that should +document that directive. The location of these pages can be controlled via +the `directive_description_dir` setting in the setup file, the default is +"ikiwiki/directive/foo". + +When this plugin is enabled, it enables the directives underlay, which +contains documentation about all the directives included in plugins shipped +with ikiwiki. This adds about 200 kb to the size of your wiki. |