doc/plugins/contrib/ikiwiki/directive/trail.mdwn

   1 The `trail` directive is supplied by the
   2 [[!iki plugins/contrib/trail desc=trail]] plugin. It sets options for the
   3 trail represented by this page, and can also add pages to the trail. Example usage:
   4
   5     \[[!trail sort="meta(title)" circular="no"]]
   6
   7 The available options are:
   8
   9 * `pages`: adds pages that match a [[ikiwiki/PageSpec]] to the trail
  10
  11 * `pagenames`: adds a space-separated list of pages to the trail,
  12   with the same [[SubPage/LinkingRules]] as for a [[ikiwiki/WikiLink]]
  13
  14 * `sort`: sets a [[ikiwiki/pagespec/sorting]] order; if not specified, the
  15   items of the trail are ordered according to the first link to each item
  16   found on the trail page
  17
  18 * `reverse`: reverses the [[ikiwiki/pagespec/sorting]] order
  19
  20 * `circular`: if set to `yes` or `1`, the trail is made into a loop by
  21   making the last page's "next" link point to the first page, and the first
  22   page's "previous" link point to the last page
  23
  24 [[!meta robots="noindex, follow"]]