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