update local template from remote and use it again (if there's a reason not
[ikiwiki] / doc / plugins / tag.mdwn
1 [[template id=plugin name=tag author="[[Joey]]"]]
2 [[tag type/tags type/link]]
3
4 This plugin allows tagging pages. List tags as follows:
5
6         \[[tag tech life linux]]
7
8 The tags work the same as if you had put a (hidden) [[WikiLink]] on the page
9 for each tag, so you can use a [[PageSpec]] match all pages that are
10 tagged with a given tag, for example. The tags will also show up on blog
11 entries and at the bottom of the tagged pages, as well as in RSS and Atom
12 feeds.
13
14 If you want a visible [[WikiLink]] along with the tag, use taglink instead:
15
16         \[[taglink foo]]
17         \[[taglink tagged_as_foo|foo]]
18
19 This plugin has a configuration option. Set --tagbase=tags and links to tags
20 will be located under the specified base page. If ikiwiki is configured
21 this way, then the example above actually tags the page with the tags
22 tags/tech, tags/life, and tags/linux. This is a useful way to avoid
23 having to write the full path to tags, if you want to keep them grouped
24 together out of the way.
25
26 [[if test="enabled(tag)" then="""
27 This wiki has the tag plugin enabled, so you'll see a note below that this
28 page is tagged with the "tags" tag.
29 """]]