X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/409e62021c5c05e0184a61d0692697c10a0b8283..84e6c4fa665703133b5778e92c045897df496e97:/doc/plugins/tag.mdwn diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index 517bbaa37..edae03887 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -1,19 +1,30 @@ +[[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]] -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. +The tags work the same as if you had put a (hidden) [[ikiwiki/WikiLink]] on +the page for each tag, so you can use a [[ikiwiki/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 [[ikiwiki/WikiLink]] along with the tag, use taglink +instead: -This plugin has a configuration option. Set --tagbase=tag and all tags will -be located inside a "tag" subdirectory, so in the above example, the tags -are really set to tag/tech, tag/life, and tag/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. + \[[taglink foo]] + \[[taglink tagged_as_foo|foo]] -This plugin is included in ikiwiki, but is not enabled by default. If it is -enabled, you'll see a note below that this page is tagged with the "tags" -tag. +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. -[[tag tags]] +[[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. +"""]]