review

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

diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index 3c1c1efeb622579c76fc4bb5fc18926a03b11f5c..1d6bfbdd98f144d308396d7aa8b849187b854190 100644 (file)
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -1,19 +1,24 @@
-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 provides the [[ikiwiki/directive/tag]] and 
+[[ikiwiki/directive/taglink]] [[directives|ikiwiki/directive]].
+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. The tags will also show up on blog
-entries and at the bottom of the tagged pages, as well as in rss feeds.
+It also provides the `tagged()` [[ikiwiki/PageSpec]], which can be used to
+match pages that are tagged with a specific tag.

 
 

-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.
+The `tagbase` setting can be used to make tags default to being put in a
+particular subdirectory.

 
 

-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.
+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.

 
 

-[[tag plugins/type/tags plugins/type/link]]
+The `tag_autocreate_commit` setting is enabled by default, and causes
+new tag pages to be checked into version control.
+
+[[!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.
+"""]]