call format hooks when generating page previews

[ikiwiki.git] / doc / plugins / write.mdwn

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 35f391f7f2f07d965117125ada195dcfa480c3b5..5def4c67967165f927ae696954c254e72f49221d 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -220,7 +220,9 @@ and should return the sanitized 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
 
 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.
+header and footer inserted by ikiwiki, the html document type, etc. (It
+should not rely on always being passed the entire page, as it won't be
+when the page is being previewed.)

 
 The function is passed named parameters: "page" and "content", and 
 should return the formatted content.
 
 The function is passed named parameters: "page" and "content", and 
 should return the formatted content.