Move the directive documentation into its own underlay, separate from basewiki,...

[ikiwiki.git] / doc / ikiwiki / directive / haiku.mdwn

diff --git a/doc/ikiwiki/directive/haiku.mdwn b/doc/ikiwiki/directive/haiku.mdwn
new file mode 100644 (file)
index 0000000..15d303b
--- /dev/null
+++ b/doc/ikiwiki/directive/haiku.mdwn
@@ -0,0 +1,15 @@
+The `haiku` directive is supplied by the [[!iki plugins/haiku]] plugin.
+
+This plugin allows inserting a randomly generated haiku into a wiki page.
+Just type:
+
+       \[[!haiku hint="argument"]]
+
+[[!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.
+
+[[!meta robots="noindex, follow"]]