summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/traillink.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/traillink.mdwn')
-rw-r--r--ikiwiki/directive/traillink.mdwn16
1 files changed, 16 insertions, 0 deletions
diff --git a/ikiwiki/directive/traillink.mdwn b/ikiwiki/directive/traillink.mdwn
new file mode 100644
index 0000000..090e253
--- /dev/null
+++ b/ikiwiki/directive/traillink.mdwn
@@ -0,0 +1,16 @@
+The `traillink` directive is supplied by the
+[[!iki plugins/trail desc=trail]]
+plugin. It generates a visible [[ikiwiki/WikiLink]], and also adds the
+linked page to the trail represented by the page containing the directive.
+
+In its simplest form, the first parameter is like the content of a WikiLink:
+
+ \[[!traillink some_other_page]]
+
+The displayed text can also be overridden, either with a `|` symbol or with
+a `text` parameter:
+
+ \[[!traillink Click_here_to_start_the_trail|some_other_page]]
+ \[[!traillink some_other_page text="Click here to start the trail"]]
+
+[[!meta robots="noindex, follow"]]