Merge commit 'origin/master'

[git.ikiwiki.info.git] / doc / plugins / haiku.mdwn

diff --git a/doc/plugins/haiku.mdwn b/doc/plugins/haiku.mdwn
index 977272cf622fce9c8008cf7972ba1fa9e05012c2..74eac1c29679961c96ec2c9329cd8be81296b7a3 100644 (file)
--- a/doc/plugins/haiku.mdwn
+++ b/doc/plugins/haiku.mdwn
@@ -1,14 +1,11 @@
-This plugin allows inserting a randomly generated haiku into a wiki page.
-Just type \\[[haiku hint="argument with a bear"]].
+[[!template id=plugin name=haiku author="[[Joey]]"]]
+[[!tag type/fun]]

 
 

-[[haiku hint="argument with a bear"]]
+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 at
-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.
-
-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.