urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

listdirectives: Enable use of the directives underlay.

master
Joey Hess 2008-09-11 18:46:32 -04:00
parent 9921a4a8a1
commit bc7381c4f9
4 changed files with 24 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
IkiWiki/Plugin/listdirectives.pm
View File

@ -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);

9
Makefile.PL
View File

@ -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 \

3
debian/changelog vendored
View File

@ -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

16
doc/plugins/listdirectives.mdwn
View File

@ -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.