implement typed links; add tagged_is_strict config option

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

diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index 95a346622fcf34210d1b0da83e9ba3db3f80af00..8cd79da4157fd2fe6ab77bd8586601a09d3cc718 100644 (file)
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -1,9 +1,19 @@
-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.
+If the `tagged_is_strict` config option is set, `tagged()` will only match
+tags explicitly set with [[ikiwiki/directive/tag]] or
+[[ikiwiki/directive/taglink]]; if not (the default), it will also match
+any other [[WikiLinks|ikiwiki/WikiLink]] to the tag page.
+
+[[!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.
+"""]]