ikiwiki/doc/plugins/listdirectives.mdwn

[[!template id=plugin name=listdirectives author="Will"]]
[[!tag type/meta]]
[[!tag type/widget]]

This plugin provides the [[ikiwiki/directive/listdirectives]]
[[ikiwiki/directive]], which inserts a list of currently available
directives into the page.

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.
rename preprocessordirective to directive Reasons include: - easier to type - might want postprocessor directives again sometime, and listdirectives can then use the directive/* files for either - that it's done as a preprocessor step is an internal detail (and not a very accurate one, really :-) 2008-08-25 20:19:39 +02:00			`[[!template id=plugin name=listdirectives author="Will"]]`
			`[[!tag type/meta]]`
more tag reorg 2010-02-12 09:43:01 +01:00			`[[!tag type/widget]]`
rename preprocessordirective to directive Reasons include: - easier to type - might want postprocessor directives again sometime, and listdirectives can then use the directive/* files for either - that it's done as a preprocessor step is an internal detail (and not a very accurate one, really :-) 2008-08-25 20:19:39 +02:00
Fix typo 2008-09-12 05:02:02 +02:00			`This plugin provides the [[ikiwiki/directive/listdirectives]]`
listdirectives: Enable use of the directives underlay. 2008-09-12 00:46:32 +02:00			`[[ikiwiki/directive]], which inserts a list of currently available`
			`directives into the page.`
rename preprocessordirective to directive Reasons include: - easier to type - might want postprocessor directives again sometime, and listdirectives can then use the directive/* files for either - that it's done as a preprocessor step is an internal detail (and not a very accurate one, really :-) 2008-08-25 20:19:39 +02:00
listdirectives: Enable use of the directives underlay. 2008-09-12 00:46:32 +02:00			`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.`