X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c69a7f758590c91bd137a8d1cfa99f37bf28045a..623c7e17989f53ef049f12639950d2c50c9edd4f:/doc/plugins/tag.mdwn diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index 02e84763c..1d6bfbdd9 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -1,13 +1,24 @@ [[!template id=plugin name=tag author="[[Joey]]"]] [[!tag type/tags type/link]] -This plugin implements the [[ikiwiki/directive/tag]] and -[[ikiwiki/directive/taglink]] [[ikiwiki/directive]]s. +This plugin provides the [[ikiwiki/directive/tag]] and +[[ikiwiki/directive/taglink]] [[directives|ikiwiki/directive]]. 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 -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. +It also provides the `tagged()` [[ikiwiki/PageSpec]], which can be used to +match pages that are tagged with a specific tag. + +The `tagbase` setting can be used to make tags default to being put in a +particular subdirectory. + +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. + +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. +"""]]