clarification

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

diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index 4d45c6bfd4d490a308caca5aa71eca70f0f59a46..94a6280ca63bb7c33dee21bd5053dee0c480709f 100644 (file)
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -1,13 +1,19 @@
 This plugin allows tagging pages. List tags as follows:
 
 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
 
 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]] to link to 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 feeds.
+
+This plugin has a configuration option. Set --tagbase=tag and all tags will
+be located inside a "tag" subdirectory, 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 it is
 enabled, you'll see a note below that this page is tagged with the "tags"
 tag.
 
 
 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.
 

-[[tag tags]]
+[[tag type/tags type/link]]