note about will_render and preview
authorJoey Hess <joey@kodama.kitenet.net>
Mon, 4 Feb 2008 23:34:47 +0000 (18:34 -0500)
committerJoey Hess <joey@kodama.kitenet.net>
Mon, 4 Feb 2008 23:34:47 +0000 (18:34 -0500)
doc/plugins/write.mdwn

index 216cfa51c95a5dba9d1fbb49d0b5296afe8d821c..e1e057c007888fd44b5a41a1cd1c31f4b8a64cde 100644 (file)
@@ -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
 
 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
 
 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