aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-08-28 18:17:59 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-08-28 18:17:59 +0000
commit4895955ceaf264c5f17b10c4009e1ab1afcc55ee (patch)
tree4f8553a9007b263e0b44afd0b9d0cbe8b5cf7b88 /doc
parente3a6ff004474cacb3e7a69a37696a65ebf1e2fcd (diff)
downloadikiwiki-4895955ceaf264c5f17b10c4009e1ab1afcc55ee.tar
ikiwiki-4895955ceaf264c5f17b10c4009e1ab1afcc55ee.tar.gz
* Change htmlize, format, and sanitize hooks to use named parameters.
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/write.mdwn19
1 files changed, 12 insertions, 7 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index af970221e..bfa0bad1d 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -94,6 +94,9 @@ specifies the filename extension that a file must have to be htmlized using
this plugin. This is how you can add support for new and exciting markup
languages to ikiwiki.
+The function is passed named parameters: "page" and "content" and should
+return the htmlized content.
+
## pagetemplate
IkiWiki::hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
@@ -115,18 +118,20 @@ a new custom parameter to the template.
Use this to implement html sanitization or anything else that needs to
modify the body of a page after it has been fully converted to html.
-The function is passed the page content and should return the sanitized
-content.
+
+The function is passed named parameters: "page" and "content", and
+should return the sanitized content.
## format
IkiWiki::hook(type => "format", id => "foo", call => \&format);
-The function is passed the complete page content and can reformat it
-and return the new content. The difference between format and sanitize is
-that sanitize only acts on the page body, while format can modify the
-entire html page including the header and footer inserted by ikiwiki, the
-html document type, etc.
+The difference between format and sanitize is that sanitize only acts on
+the page body, while format can modify the entire html page including the
+header and footer inserted by ikiwiki, the html document type, etc.
+
+The function is passed named parameters: "page" and "content", and
+should return the formatted content.
## delete