respond, open wishlist todo item with design

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

diff --git a/doc/plugins/haiku.mdwn b/doc/plugins/haiku.mdwn
index 248e56d8d84df08daf9b5a126a6b500eb68aa2f0..448733d957b1f2b6b440c3d558419b8b174cab67 100644 (file)
--- a/doc/plugins/haiku.mdwn
+++ b/doc/plugins/haiku.mdwn
@@ -1,14 +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"]]
+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.
-
-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.