X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/65d0aee407f81db9ca2261fc8ecb1958f62302a9..d98f3ef9ac5ee8595c32547b1207892d4f1f312f:/doc/plugins/haiku.mdwn diff --git a/doc/plugins/haiku.mdwn b/doc/plugins/haiku.mdwn index be462645b..448733d95 100644 --- a/doc/plugins/haiku.mdwn +++ b/doc/plugins/haiku.mdwn @@ -1,16 +1,12 @@ -This plugin allows inserting a randomly generated haiku into a wiki page. -Just type \\[[haiku hint="argument"]]. +[[!template id=plugin name=haiku author="[[Joey]]"]] +[[!tag type/fun]] +[[!tag type/widget]] -[[haiku hint="argument test"]] +This plugin provides a [[ikiwiki/directive/haiku]] [[ikiwiki/directive]]. +The directive allows inserting a randomly generated haiku into a wiki page. -The hint parameter can be omitted, it only provides the generator a hint of -what to write the haiku about. If no hint is given, it might base it on the -page name. Since the vocabulary it knows is very small, many hints won't -affect the result at all. +As a special bonus, enabling this plugin makes any error messages ikiwiki +should display be written in haiku. -This plugin is included in ikiwiki, but is not enabled by default. As a -special bonus, enabling this plugin makes any error messages ikiwiki should -display be written in haiku. - -You need to have the Coy module installed for this plugin to do anything -interesting. That does all the heavy lifting. +You need to have the [[!cpan Coy]] module installed for this plugin to do +anything interesting. That does all the heavy lifting.