haiku plugin

1 files changed, 14 insertions, 0 deletions

diff --git a/doc/plugins/haiku.mdwn b/doc/plugins/haiku.mdwn
new file mode 100644
index 000000000..977272cf6
--- /dev/null
+++ b/doc/plugins/haiku.mdwn
@@ -0,0 +1,14 @@
+This plugin allows inserting a randomly generated haiku into a wiki page.
+Just type \\[[haiku hint="argument with a bear"]].
+
+[[haiku hint="argument with a bear"]]
+
+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.
+
+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.