]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/tag.mdwn
test alternative header link name
[git.ikiwiki.info.git] / doc / plugins / tag.mdwn
index 95a346622fcf34210d1b0da83e9ba3db3f80af00..1d6bfbdd98f144d308396d7aa8b849187b854190 100644 (file)
@@ -1,9 +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.
+It also provides the `tagged()` [[ikiwiki/PageSpec]], which can be used to
+match pages that are tagged with a specific tag.
 
-This plugin is included in ikiwiki, but is not enabled by default.
+The `tagbase` setting can be used to make tags default to being put in a
+particular subdirectory.
+
+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.
+
+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.
+"""]]