diff options
author | William Uther <willu@cse.unsw.edu.au> | 2008-09-11 17:05:51 -0400 |
---|---|---|
committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 17:05:51 -0400 |
commit | c69a7f758590c91bd137a8d1cfa99f37bf28045a (patch) | |
tree | 16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/tag.mdwn | |
parent | 4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff) | |
download | ikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar ikiwiki-c69a7f758590c91bd137a8d1cfa99f37bf28045a.tar.gz |
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/tag.mdwn')
-rw-r--r-- | doc/plugins/tag.mdwn | 29 |
1 files changed, 3 insertions, 26 deletions
diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index c197ae53f..02e84763c 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -1,21 +1,9 @@ [[!template id=plugin name=tag author="[[Joey]]"]] [[!tag type/tags type/link]] -This plugin allows 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]] +This plugin implements the [[ikiwiki/directive/tag]] and +[[ikiwiki/directive/taglink]] [[ikiwiki/directive]]s. +These directives allow tagging pages. 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 @@ -23,14 +11,3 @@ 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. - -If you want to override the tagbase for a particular tag, you can use -something like this: - - \[[!tag ./foo]] - \[[!taglink /foo]] - -[[!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. -"""]] |