aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/contrib/ikiwiki/directive/trailoptions.mdwn
blob: e1603f11b685344cca358eb45fb7671943cb9043 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
The `trailoptions` directive is supplied by the
[[!iki plugins/contrib/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"]]