X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/5017ffd8a512c09d3c34764709791812acfc5515..5f6589656b71b06d58b968550da7322db06e40fd:/doc/plugins/tag.mdwn diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index 95a346622..caffaa692 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -1,9 +1,29 @@ +[[template id=plugin name=tag author="[[Joey]]"]] +[[tag type/tags type/link]] + This plugin allows tagging pages. List tags as follows: - \\[[tag tech life linux]] + \[[tag tech life linux]] The tags work the same as if you had put a (hidden) [[WikiLink]] on the page -for each tag, so you can use a [[GlobList]] to link to all pages that are -tagged with a given tag, for example. +for each tag, so you can use a [[PageSpec]] match all pages that are +tagged with a given tag, for example. The tags will also show up on blog +entries and at the bottom of the tagged pages, as well as in RSS and Atom +feeds. + +If you want a visible [[WikiLink]] along with the tag, use taglink instead: + + \[[taglink foo]] + \[[taglink tagged_as_foo|foo]] + +This plugin has a configuration option. Set --tagbase=tags and links to tags +will be located under the specified base page. If ikiwiki is configured +this way, then the example above actually tags the page with the tags +tags/tech, tags/life, and tags/linux. This is a useful way to avoid +having to write the full path to tags, if you want to keep them grouped +together out of the way. -This plugin is included in ikiwiki, but is not enabled by default. +[[if test="enabled(tag)" then=""" +This wiki has the tag plugin enabled, so you'll see a note below that this +page is tagged with the "tags" tag. +"""]]