summaryrefslogtreecommitdiff
path: root/ikiwiki/directive/trailoptions.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ikiwiki/directive/trailoptions.mdwn')
-rw-r--r--ikiwiki/directive/trailoptions.mdwn18
1 files changed, 18 insertions, 0 deletions
diff --git a/ikiwiki/directive/trailoptions.mdwn b/ikiwiki/directive/trailoptions.mdwn
new file mode 100644
index 0000000..d83f444
--- /dev/null
+++ b/ikiwiki/directive/trailoptions.mdwn
@@ -0,0 +1,18 @@
+The `trailoptions` directive is supplied by the
+[[!iki plugins/trail desc=trail]] plugin. It sets options for the
+trail represented by this page.
+
+ \[[!trailoptions sort="meta(title)" circular="no"]]
+
+Options available:
+
+* `sort`: sets a [[ikiwiki/pagespec/sorting]] order for the entire trail,
+ overriding the order in which they were added
+
+* `reverse`: reverses the order of the trail
+
+* `circular`: if set to `yes` or `1`, the trail is made into a loop by
+ making the last page's "next" link point to the first page, and the first
+ page's "previous" link point to the last page
+
+[[!meta robots="noindex, follow"]]