]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/contrib/trail.mdwn
Merge branch 'master' into po
[ikiwiki.git] / doc / plugins / contrib / trail.mdwn
1 [[!tag type/chrome patch]]
2
3 Available from [[smcv]]'s git repository, in the `trail` branch. This
4 plugin aims to solve [[todo/wikitrails]] in a simpler way.
5
6 Joey: what do you think of this plugin? If you like the general approach
7 and are likely to include it in ikiwiki, I'll try to modify
8 [[plugins/contrib/album]] to be based on it, rather than partially
9 reinventing it.
10
11 This plugin can benefit from
12 [[another_of_my_branches|todo/inline_plugin:_specifying_ordered_page_names]]
13 but does not require it.
14
15 ----
16
17 [[!template id=plugin name=trail author="[[Simon_McVittie|smcv]]"]]
18
19 It's sometimes useful to have "trails" of pages in a wiki, as a guided
20 tour, sequence of chapters etc. In this plugin, a trail is represented
21 by a page, and the pages in the trail are indicated by specially marked
22 links within that page.
23
24 If using the default `page.tmpl`, each page automatically displays the
25 trails that it's a member of (if any), with links to the trail and to
26 the next and previous members.
27
28 The `traillink` [[ikiwiki/directive]] is used to record which pages
29 are in a trail, and simultaneously link to them. Alternatively, the
30 [[ikiwiki/directive/inline]] directive can be used with `trail=yes`
31 to record the inlined pages as part of the trail, in the order in
32 which they are inlined.
33
34 ## Directives
35
36 (These will go to the appropriate pages in [[ikiwiki/directive]] if this
37 plugin is included in ikiwiki.)
38
39 ### traillink
40
41 The `traillink` directive is supplied by the [[!iki plugins/contrib/trail desc=trail]]
42 plugin. This directive appears on the page representing a trail. It acts
43 as a visible [[ikiwiki/WikiLink]], but also records the linked page as
44 a member of the trail.
45
46 Various syntaxes can be used:
47
48     \[[!traillink Badgers]]
49     \[[!traillink How_to_find_mushrooms_using_badgers|badgers]]
50     \[[!traillink badgers text="How to find mushrooms using badgers"]]
51
52 ### trailoptions
53
54 The `trailoptions` directive is supplied by the [[!iki plugins/contrib/trail desc=trail]]
55 plugin. This directive appears on the page representing a trail, and
56 produces no output.
57
58 Currently, the only option supported is `[[!trailoptions circular=yes]]`,
59 which adds links between the first and last pages, turning the trail into
60 a circle.