diff options
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/tag.mdwn | 10 | ||||
| -rw-r--r-- | doc/plugins/write.mdwn | 13 |
2 files changed, 12 insertions, 11 deletions
diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn index 517bbaa37..de89bf4e7 100644 --- a/doc/plugins/tag.mdwn +++ b/doc/plugins/tag.mdwn @@ -4,13 +4,13 @@ This plugin allows tagging pages. List tags as follows: 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. +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. 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. +be located inside a "tag" subdirectory, 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. 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" diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 32a5ce51b..93c6d1d5c 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -107,12 +107,13 @@ languages to ikiwiki. IkiWiki::hook(type => "pagetemplate", id => "foo", call => \&pagetemplate); -Each time a page is rendered, a [[template|templates]] is filled out. -This hook allows modifying that template. The function is passed named -parameters. The "page" and "destpage" parameters are the same as for a -preprocess hook. The "template" parameter is a `HTML::Template` object that -is the template that will be used to generate the page. The function -can manipulate that template object. +Each time a page (or part of a blog page, or an rss feed) is rendered, a +[[template|templates]] is filled out. This hook allows modifying that +template. The function is passed named parameters. The "page" and +"destpage" parameters are the same as for a preprocess hook. The "template" +parameter is a `HTML::Template` object that is the template that will be +used to generate the page. The function can manipulate that template +object. The most common thing to do is probably to call $template->param() to add a new custom parameter to the template. Note that in order to be robust, |