Merge branch 'master' of ssh://git.ikiwiki.info

[git.ikiwiki.info.git] / doc / plugins / contrib / trail.mdwn

diff --git a/doc/plugins/contrib/trail.mdwn b/doc/plugins/contrib/trail.mdwn
index fc43afef4c30f74f6ef118e3ef2698042f3d60b4..9d895783a5a4f12f60d2c8a8a7294250e8ee0077 100644 (file)
--- a/doc/plugins/contrib/trail.mdwn
+++ b/doc/plugins/contrib/trail.mdwn
@@ -1,7 +1,7 @@
 [[!tag patch]]
-[[!template id=gitbranch branch=smcv/trail3 author="[[smcv]]"]]
+[[!template id=gitbranch branch=smcv/trail3-integrated author="[[smcv]]"]]
 
-Available from [[smcv]]'s git repository, in the `trail3` branch. This
+Available from [[smcv]]'s git repository, in the `trail3` and `trail3-integrated` branches. This
 plugin aims to solve [[todo/wikitrails]] in a simpler way; it can also be
 used for [[navigation through blog posts|todo/Pagination_next_prev_links]].
 
@@ -38,7 +38,7 @@ as its data structure, resulting in timing-related limitations (it couldn't
 select pages for the trail by using pagespecs, because pagespecs can't be
 evaluated correctly until the scan stage has finished).
 
-Updated, November 2011:
+Updated, November 2011 (`trail3`):
 
 * reinstated `inline` integration ([[report]] integration would probably be
   pretty easy too, if this gets merged)
@@ -49,18 +49,24 @@ Updated, November 2011:
 * CSS for the default anti-theme and all built-in themes (it looks nicest
   in the default anti-theme and in actiontabs - the demo uses actiontabs)
 
+Updated, March 2012 (`trail3-integrated`):
+
+* replaced `\[[!trailinline]]` with `\[[!inline trail=yes]]`
+* added a `build_affected` hook so it doesn't have to use `inject`
+  (optional commit, can be omitted)
+
 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 +82,9 @@ trails that it's a member of (if any), with links to the trail and to
 the next and previous members. HTML `<link>` 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 +97,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 +133,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]]`).