(no commit message)

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

diff --git a/doc/plugins/contrib/trail.mdwn b/doc/plugins/contrib/trail.mdwn
index 5adff4c78b29f45c29409c3e18b0ea5c28d47afa..fc43afef4c30f74f6ef118e3ef2698042f3d60b4 100644 (file)
--- a/doc/plugins/contrib/trail.mdwn
+++ b/doc/plugins/contrib/trail.mdwn
@@ -1,20 +1,39 @@
 [[!tag patch]]
 [[!tag patch]]

-[[!template id=gitbranch branch=smcv/trail author="[[smcv]]"]]
+[[!template id=gitbranch branch=smcv/trail3 author="[[smcv]]"]]

 
 

-Available from [[smcv]]'s git repository, in the `trail` branch. This
+Available from [[smcv]]'s git repository, in the `trail3` branch. 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]].
 
 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]].
 

+If you don't want to use a branch of ikiwiki, manual installation requires
+these files (use the "raw" link in gitweb to download):
+
+* [trail.pm](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/IkiWiki/Plugin/trail.pm)
+  in an `IkiWiki/Plugin` subdirectory of your configured `plugindir`
+* [page.tmpl](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/templates/page.tmpl)
+  and
+  [trails.tmpl](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/templates/trails.tmpl)
+  in your configured `templatedir`, or a `templates` subdirectory of your wiki repository
+* the trail-related bits from the end of the
+  [stylesheet](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/doc/style.css)
+  (put them in your local.css)
+* the trail-related bits at the end of the
+  [actiontabs](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/themes/actiontabs/style.css)
+  or [blueview/goldtype](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/trail3:/themes/blueview/style.css)
+  stylesheets, if you use one of those themes (again, put them in your local.css)
+

 The branch also includes [[todo/test_coverage]] machinery.
 
 Demo:
 
 The branch also includes [[todo/test_coverage]] machinery.
 
 Demo:
 

-* [a trail based on links](http://demo.hosted.pseudorandom.co.uk/trail/)
-* [a hybrid trail/inline](http://demo.hosted.pseudorandom.co.uk/trail2/)
+* [in use on entries in my blog](http://smcv.pseudorandom.co.uk/)
+* [a demo trail based on links](http://demo.hosted.pseudorandom.co.uk/trail/)
+* [a demo hybrid trail/inline](http://demo.hosted.pseudorandom.co.uk/trail2/)

 
 

-The page `e` in the demo is in both trails, to demonstrate how that looks.
+The page `e` is in both demo trails, to demonstrate how a page in more than
+one trail looks.

 
 

-The `smcv/trail2` branch is an older version of `trail` which used typed links
+The `smcv/trail2` branch is an older version of `trail3` which used typed links

 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).
 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).


@@ -23,20 +42,17 @@ Updated, November 2011:
 
 * reinstated `inline` integration ([[report]] integration would probably be
   pretty easy too, if this gets merged)
 
 * reinstated `inline` integration ([[report]] integration would probably be
   pretty easy too, if this gets merged)

-

 * switched from typed links back to a custom data structure to avoid
   chicken/egg problems with ordering
 * switched from typed links back to a custom data structure to avoid
   chicken/egg problems with ordering

-

 * create typed links too, as a side-effect, but not when using an inline
 * create typed links too, as a side-effect, but not when using an inline

-

 * regression test with nearly full coverage
 * regression test with nearly full coverage

-

 * 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)
 
 Known bugs:
 
 * the blueview and goldtype CSS nearly work, but the alignment is a bit off
 * 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)
 
 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

 
 ----
 
 
 ----