summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-09-16 00:52:26 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-09-16 00:52:26 +0000
commit0f25ec8eb640a850a8f1efe7081c03d05d04eda4 (patch)
tree5c290f48fb651b7c8c24849208328ef634ec22e9 /doc/plugins
parent6206e9a62e06ca9bf55f6bc659e7229ba0b911d1 (diff)
* pagetemplate hooks are now also called when generating cgi pages.
* Add a favicon plugin, which simply adds a link tag for an icon to each page (and cgis).
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/favicon.mdwn6
-rw-r--r--doc/plugins/write.mdwn14
2 files changed, 13 insertions, 7 deletions
diff --git a/doc/plugins/favicon.mdwn b/doc/plugins/favicon.mdwn
new file mode 100644
index 000000000..f301433fa
--- /dev/null
+++ b/doc/plugins/favicon.mdwn
@@ -0,0 +1,6 @@
+[[template id=plugin name=favicon included=1 author="Joey Hess"]]
+[[tag type/chrome]]
+
+If this plugin is enabled, then an icon link is added to pages, for web
+browsers to display. The icon is currently hardcoded to be a favicon.png,
+which must be in the root of the wiki.
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index a78785e02..57521687e 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -105,13 +105,13 @@ return the htmlized content.
hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
-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.
+[[Templates]] are filled out for many different things in ikiwiki,
+like generating a page, or part of a blog page, or an rss feed, or a cgi.
+This hook allows modifying those templates. 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.