X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/cb60d16bb41b680616c1d4532a15df2ec478ce96..28c3e5482d7431b7554e6288bb2f9f55fbd274ed:/doc/plugins/tag.mdwn diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index f24accafa..1d6bfbdd9 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -1,21 +1,24 @@ -This plugin allows tagging pages. List tags as follows: +[[!template id=plugin name=tag author="[[Joey]]"]] +[[!tag type/tags type/link]] - \[[tag tech life linux]] +This plugin provides the [[ikiwiki/directive/tag]] and +[[ikiwiki/directive/taglink]] [[directives|ikiwiki/directive]]. +These directives allow tagging pages. -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. +It also provides the `tagged()` [[ikiwiki/PageSpec]], which can be used to +match pages that are tagged with a specific tag. -This plugin has a configuration option. Set --tagbase=tag 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 `tagbase` setting can be used to make tags default to being put in a +particular subdirectory. -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. +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. -[[tag type/tags type/link]] +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 +page is tagged with the "tags" tag. +"""]]