Move trail out of the contrib directory in preparation for eventual merge

master
Simon McVittie 2012-03-18 17:01:45 +00:00
parent 4e54fa1144
commit dc3b9934d5
6 changed files with 5 additions and 62 deletions

View File

@ -1,5 +1,5 @@
The `trailinline` directive is provided by the
[[!iki plugins/contrib/trail desc=trail]]
[[!iki plugins/trail desc=trail]]
plugin. It is equivalent to combining [[ikiwiki/directive/trailitems]] and
[[ikiwiki/directive/inline]] directives with the same options.

View File

@ -1,5 +1,5 @@
The `trailitem` directive is supplied by the
[[!iki plugins/contrib/trail desc=trail]] plugin. It is used like this:
[[!iki plugins/trail desc=trail]] plugin. It is used like this:
\[[!trailitem some_other_page]]

View File

@ -1,5 +1,5 @@
The `trailitems` directive is supplied by the
[[!iki plugins/contrib/trail desc=trail]] plugin. It adds pages
[[!iki plugins/trail desc=trail]] plugin. It adds pages
to the trail represented by the current page, without producing any output
on that page.

View File

@ -1,5 +1,5 @@
The `traillink` directive is supplied by the
[[!iki plugins/contrib/trail desc=trail]]
[[!iki plugins/trail desc=trail]]
plugin. It generates a visible [[ikiwiki/WikiLink]], and also adds the
linked page to the trail represented by the page containing the directive.

View File

@ -1,5 +1,5 @@
The `trailoptions` directive is supplied by the
[[!iki plugins/contrib/trail desc=trail]] plugin. It sets options for the
[[!iki plugins/trail desc=trail]] plugin. It sets options for the
trail represented by this page.
\[[!trailoptions sort="meta(title)" circular="no"]]

View File

@ -1,60 +1,3 @@
[[!tag patch]]
[[!template id=gitbranch branch=smcv/trail3 author="[[smcv]]"]]
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]].
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:
* [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` 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 `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).
Updated, November 2011:
* 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
* create typed links too, as a side-effect, but not when using an inline
* 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
----
[[!template id=plugin name=trail author="[[Simon_McVittie|smcv]]"]]
[[!tag type/chrome]]