aboutsummaryrefslogtreecommitdiff
path: root/underlays/basewiki/directive/haiku.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'underlays/basewiki/directive/haiku.mdwn')
-rw-r--r--underlays/basewiki/directive/haiku.mdwn13
1 files changed, 13 insertions, 0 deletions
diff --git a/underlays/basewiki/directive/haiku.mdwn b/underlays/basewiki/directive/haiku.mdwn
new file mode 100644
index 000000000..d7df3e249
--- /dev/null
+++ b/underlays/basewiki/directive/haiku.mdwn
@@ -0,0 +1,13 @@
+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.