Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info

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

diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index 98990973b3cef08955ae113f2c86b0af6a6c9757..8e1286e6272b5adffc5598d88b529fc4dfcd5ab0 100644 (file)
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -1,29 +1,21 @@
-[[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 [[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.
+The `tagbase` setting can be used to make tags default to being put in a
+particular subdirectory.

 
 

-If you want a visible [[WikiLink]] along with the tag, use taglink instead:
+The `tag_autocreate` setting can be used to control whether new tag pages
+are created as needed. It defaults to being done only if a `tagbase` is
+set.

 
 

-       \[[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 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.
 """]]
 This wiki has the tag plugin enabled, so you'll see a note below that this
 page is tagged with the "tags" tag.
 """]]