]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/haiku.mdwn
* Support inlining pages raw, rather than creating a blog.
[ikiwiki.git] / doc / plugins / haiku.mdwn
index 6b4080af56b03bc08af241d76f808121dc061db4..d78e609da9132e5cfbd20d8b9d04035efbe21754 100644 (file)
@@ -1,14 +1,20 @@
 This plugin allows inserting a randomly generated haiku into a wiki page.
-Just type \\[[haiku hint="argument"]].
+Just type:
 
-[[haiku hint="argument"]]
+       \[[haiku hint="argument"]]
 
-The hint parameter can be omitted, it only provides the generator a hint at
+[[haiku hint="argument test"]]
+
+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.
 
-This plugin is included in ikiwiki, but is not enabled by default.
+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.
+
+[[tag type/fun]]