summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-05 04:15:47 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-05 04:15:47 +0000
commita59b1ac8d8eb220fd4f574af4a8a6742825aac6f (patch)
treec895e6b18739ff3a22b75fc2817c7f62327fe4a0 /doc
parentf924740b939c3f14072fb5c428468355d8c4be52 (diff)
haiku plugin
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins.mdwn3
-rw-r--r--doc/plugins/haiku.mdwn14
2 files changed, 16 insertions, 1 deletions
diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn
index 57ec8afb9..07c236057 100644
--- a/doc/plugins.mdwn
+++ b/doc/plugins.mdwn
@@ -2,7 +2,8 @@ There's documentation if you want to [[write]] your own plugins, or you can inst
The ikiwiki package includes some standard plugins that are installed and
by default. These include [[inline]], [[pagecount]], [[brokenlinks]],
-[[smiley]], and [[search]]. Of these, [[inline]] is enabled by default.
+[[search]], [[smiley]], and even [[haiku]].
+Of these, [[inline]] is enabled by default.
To enable other plugins, use the `--plugin` switch described in [[usage]],
or the equivalent line in [[ikiwiki.setup]].
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.