X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/ad02a40b3b253984078514696291a06b28a12844..8be7c6137fd98ba39e4517420ef3950960717d34:/doc/plugins/contrib/trail.mdwn diff --git a/doc/plugins/contrib/trail.mdwn b/doc/plugins/contrib/trail.mdwn index fc43afef4..bfd4d3d0b 100644 --- a/doc/plugins/contrib/trail.mdwn +++ b/doc/plugins/contrib/trail.mdwn @@ -52,15 +52,15 @@ Updated, November 2011: Known bugs: * the blueview and goldtype CSS nearly work, but the alignment is a bit off -* a `trailinline` with no `sort` option is sorted in arbitrary order ---- [[!template id=plugin name=trail author="[[Simon_McVittie|smcv]]"]] [[!tag type/chrome]] -This plugin provides the [[ikiwiki/directive/trail]], +This plugin provides the [[ikiwiki/directive/trailoptions]], [[ikiwiki/directive/traillink]], [[ikiwiki/directive/trailitem]], +[[ikiwiki/directive/trailitems]] and [[ikiwiki/directive/trailinline]] [[directives|ikiwiki/directive]]. It's sometimes useful to have "trails" of pages in a wiki where each @@ -76,6 +76,9 @@ trails that it's a member of (if any), with links to the trail and to the next and previous members. HTML `` tags with the `prev`, `next` and `up` relations are also generated. +The [[ikiwiki/directive/trailoptions]] directive sets options for the +entire trail. + Pages can be included in a trail in various ways: * The [[ikiwiki/directive/trailinline]] directive sets up an [[inline]], @@ -88,7 +91,7 @@ Pages can be included in a trail in various ways: This directive only works if the [[!iki plugins/inline desc=inline]] plugin is also enabled. -* The [[ikiwiki/directive/trail]] directive has optional `pages` and +* The [[ikiwiki/directive/trailitems]] directive has optional `pages` and `pagenames` options which behave the same as in [[inline]], but don't produce any output in the page, so you can have trails that don't list all their pages. @@ -124,9 +127,7 @@ Pages can be included in a trail in various ways: Like `\[[!tag]]`, this still counts as a [[ikiwiki/WikiLink]] even though there's no visible link. -You can mix several of these directives in one page, and the resulting +You can mix several of these directives in one page. The resulting trail will contain all of the pages matched by any of the directives, -in the same order as the directives (unless you use the `sort` option -on `\[[!trail]]` or `\[[!trailinline]]`, which takes precedence). - -The [[ikiwiki/directive/trail]] directive can also be used to set options. +in the same order that the directives appear (unless you use the `sort` or +`reverse` options on `\[[!trailoptions]]`).