aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/write.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-02-04 18:34:47 -0500
committerJoey Hess <joey@kodama.kitenet.net>2008-02-04 18:34:47 -0500
commit57567f41680b80799037cc47c60a09c9a9e0e724 (patch)
tree2c944de8f4549646e82e0f4b8f6b930926fa727a /doc/plugins/write.mdwn
parent346fc8f1a55e6e5337dcaee02329874b7798af17 (diff)
downloadikiwiki-57567f41680b80799037cc47c60a09c9a9e0e724.tar
ikiwiki-57567f41680b80799037cc47c60a09c9a9e0e724.tar.gz
note about will_render and preview
Diffstat (limited to 'doc/plugins/write.mdwn')
-rw-r--r--doc/plugins/write.mdwn9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 216cfa51c..e1e057c00 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -481,8 +481,13 @@ If the destination directory doesn't exist, it will first be created.
Given a page name and a destination file name (not including the base
destination directory), register that the page will result in that file
-being rendered. It's important to call this before writing to any file in
-the destination directory.
+being rendered.
+
+It's important to call this before writing to any file in the destination
+directory, and it's important to call it consistently every time, even if
+the file isn't really written this time -- unless you delete any old
+version of the file. In particular, in preview mode, this should still be
+called even if the file isn't going to be written to during the preview.
Ikiwiki uses this information to automatically clean up rendered files when
the page that rendered them goes away or is changes to no longer render