Merge branch 'master' into autotag

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

diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index 2f541e532afb8a6104292352dd4414ceec035d5d..bdf39d7e89cc4bb7d94e48e9414d9992c0ef28e8 100644 (file)
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -1,24 +1,17 @@
-[[template id=plugin name=tag author="[[Joey]]"]]
-[[tag type/tags type/link]]
+[[!template id=plugin name=tag author="[[Joey]]"]]
+[[!tag type/tags type/link]]
 
-This plugin allows tagging pages. List tags as follows:
+This plugin provides the [[ikiwiki/directive/tag]] and 
+[[ikiwiki/directive/taglink]] [[directives|ikiwiki/directive]].
+These directives allow tagging pages.
 
-       \[[tag tech life linux]]
+It also provides the `tagged()` [[ikiwiki/PageSpec]], which can be used to
+match pages that are tagged with a specific tag.
 
-The tags work the same as if you had put a (hidden) [[WikiLink]] on the page
-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 the `tag_autocreate` setting is enabled, tag pages will automatically be
+created as needed.
 
-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 test="enabled(tag)" then="""
+[[!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.
 """]]