patch plugin documentation to refer to directive pages

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

diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index 95a346622fcf34210d1b0da83e9ba3db3f80af00..02e84763c8bf5df787279da36033b28b957b1d97 100644 (file)
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -1,9 +1,13 @@
-This plugin allows tagging pages. List tags as follows:
+[[!template id=plugin name=tag author="[[Joey]]"]]
+[[!tag type/tags type/link]]
 
-       \\[[tag tech life linux]]
+This plugin implements the [[ikiwiki/directive/tag]] and 
+[[ikiwiki/directive/taglink]] [[ikiwiki/directive]]s.
+These directives allow tagging pages.
 
-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.
-
-This plugin is included in ikiwiki, but is not enabled by default.
+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.