X-Git-Url: http://git.tremily.us/?a=blobdiff_plain;f=doc%2Fplugins%2Ftag.mdwn;h=1d6bfbdd98f144d308396d7aa8b849187b854190;hb=070b90727139c1415300040ea359aeac7fade9d5;hp=a2f0c7e5796e36b9819430d9202d1f7884282189;hpb=d5e65e582a34ae2494fee493ddcb2b959e4a4bce;p=ikiwiki.git diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index a2f0c7e57..1d6bfbdd9 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -1,28 +1,22 @@ [[!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. +The `tagbase` setting can be used to make tags default to being put in a +particular subdirectory. -If you want a visible [[ikiwiki/WikiLink]] along with the tag, use taglink -instead: +The `tag_autocreate` setting can be used to control whether new tag pages +are created as needed. It defaults to being done only if a `tagbase` is +set. - \[[!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. +The `tag_autocreate_commit` setting is enabled by default, and causes +new tag pages to be checked into version control. [[!if test="enabled(tag)" then=""" This wiki has the tag plugin enabled, so you'll see a note below that this