Move trail out of the contrib directory in preparation for eventual merge
[ikiwiki.git] / doc / ikiwiki / directive / trailoptions.mdwn
1 The `trailoptions` directive is supplied by the
2 [[!iki plugins/trail desc=trail]] plugin. It sets options for the
3 trail represented by this page.
4
5     \[[!trailoptions sort="meta(title)" circular="no"]]
6
7 Options available:
8
9 * `sort`: sets a [[ikiwiki/pagespec/sorting]] order for the entire trail,
10   overriding the order in which they were added
11
12 * `reverse`: reverses the order of the trail
13
14 * `circular`: if set to `yes` or `1`, the trail is made into a loop by
15   making the last page's "next" link point to the first page, and the first
16   page's "previous" link point to the last page
17
18 [[!meta robots="noindex, follow"]]