X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=doc%2Fplugins%2Ftag.mdwn;h=bdf39d7e89cc4bb7d94e48e9414d9992c0ef28e8;hb=204c0a63f3fd7673dac83da6aa5f9c9e3cc9a6c5;hp=edae03887727737bff0812faf2a7739b52e89675;hpb=fa90bdf4bf44d108bd8c3d53104b48aa20dc18eb;p=ikiwiki.git diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index edae03887..bdf39d7e8 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -1,30 +1,17 @@ -[[template id=plugin name=tag author="[[Joey]]"]] -[[tag type/tags type/link]] +[[!template id=plugin name=tag author="[[Joey]]"]] +[[!tag type/tags type/link]] -This plugin allows tagging pages. List tags as follows: +This plugin provides the [[ikiwiki/directive/tag]] and +[[ikiwiki/directive/taglink]] [[directives|ikiwiki/directive]]. +These directives allow tagging pages. - \[[tag tech life linux]] +It also provides the `tagged()` [[ikiwiki/PageSpec]], which can be used to +match pages that are tagged with a specific tag. -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 the `tag_autocreate` setting is enabled, tag pages will automatically be +created as needed. -If you want a visible [[ikiwiki/WikiLink]] along with the tag, use taglink -instead: - - \[[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. - -[[if test="enabled(tag)" then=""" +[[!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. """]]