X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/409e62021c5c05e0184a61d0692697c10a0b8283..94268a46cd30fc72b51714e42e9db741eb29cc73:/doc/plugins/tag.mdwn diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index 517bbaa37..1d6bfbdd9 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -1,19 +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 [[GlobList]] to link to all pages that are -tagged with a given tag, for example. +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 all tags will -be located inside a "tag" subdirectory, so in the above example, the tags -are really set to tag/tech, tag/life, and tag/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 tags]] +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. +"""]]