web commit by tschwinge: How to use this plugin?

[ikiwiki.git] / doc / plugins / tag.mdwn

diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index 1bc38e6fb788f51dd60ed78d1e10ab4f544fd266..caffaa6924380dfdfcccbed97ad867a524105bd7 100644 (file)
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -1,4 +1,4 @@
-[[template id=plugin name=tag included=1 author="[[Joey]]"]]
+[[template id=plugin name=tag author="[[Joey]]"]]
 [[tag type/tags type/link]]
 
 This plugin allows tagging pages. List tags as follows:
@@ -11,12 +11,19 @@ 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.
 
-This plugin has a configuration option. Set --tagbase=tag and links to tags
+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.
 
-If this plugin is enabled, you'll see a note below that this page is tagged
-with the "tags" tag.
+[[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.
+"""]]