summaryrefslogtreecommitdiff
path: root/doc/ikiwiki/directive/tag.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:41:26 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 18:41:26 -0400
commit9921a4a8a1a696ce69acce5e14943f0149d926ff (patch)
tree926ebf50f913087a99c05993a3b01e2d935c9878 /doc/ikiwiki/directive/tag.mdwn
parent7d98c3d52bcdf2a3010843d176bf9fd79643207b (diff)
Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki.
Diffstat (limited to 'doc/ikiwiki/directive/tag.mdwn')
-rw-r--r--doc/ikiwiki/directive/tag.mdwn30
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/tag.mdwn b/doc/ikiwiki/directive/tag.mdwn
new file mode 100644
index 000000000..a6e1833a4
--- /dev/null
+++ b/doc/ikiwiki/directive/tag.mdwn
@@ -0,0 +1,30 @@
+The `tag` and `taglink` directives are supplied by the [[!iki plugins/tag]] plugin.
+
+These directives allow tagging pages. List tags as follows:
+
+ \[[!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.
+
+If you want a visible [[ikiwiki/WikiLink]] along with the tag, use taglink
+instead:
+
+ \[[!taglink foo]]
+ \[[!taglink tagged_as_foo|foo]]
+
+Note that if the wiki is configured to use a tagbase, then the tags will be
+located under a base directory, such as "tags/". 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 you want to override the tagbase for a particular tag, you can use
+something like this:
+
+ \[[!tag ./foo]]
+ \[[!taglink /foo]]
+
+[[!meta robots="noindex, follow"]]