http(oop)s

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

diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index f24accafab3d821ca012c03e559048e6358358c6..c197ae53f99e6fcda3697cd1fc2e477e62bfa0a4 100644 (file)
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -1,21 +1,36 @@
+[[!template id=plugin name=tag author="[[Joey]]"]]
+[[!tag type/tags type/link]]
+

 This plugin allows tagging pages. List tags as follows:
 
 This plugin allows tagging pages. List tags as follows:
 

-       \[[tag tech life linux]]
+       \[[!tag tech life linux]]
+
+The tags work the same as if you had put a (hidden) [[ikiwiki/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 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 feeds.
+If you want a visible [[ikiwiki/WikiLink]] along with the tag, use taglink
+instead:

 
 

-This plugin has a configuration option. Set --tagbase=tag and links to tags
+       \[[!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.
 
 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.
 

-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.
+If you want to override the tagbase for a particular tag, you can use
+something like this:
+
+       \[[!tag ./foo]]
+       \[[!taglink /foo]]

 
 

-[[tag type/tags type/link]]
+[[!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.
+"""]]