add_autofile filename should be relative to srcdir

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

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 5190a26edb4ce85f5f54c94b9abfe0f9058a5c33..404c3b44f3ace0123194a29c14c5ede32d2be3dc 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -972,13 +972,13 @@ Sometimes you may want to add a file to the `srcdir` as a result of content
 of other pages. For example, [[plugins/tag]] pages can be automatically
 created as needed. This function can be used to do that. 
 
 of other pages. For example, [[plugins/tag]] pages can be automatically
 created as needed. This function can be used to do that. 
 

-The three parameters are the filename to add, the name of the plugin,
-and a callback function. The callback will be called if it is appropriate
-to automatically add the file, and should then take care of creating it,
-and doing anything else it needs to (such as checking it into revision
-control). Note that the callback may not always be called. For example,
-if an automatically added file is deleted by the user, ikiwiki will avoid
-re-adding it again.
+The three parameters are the filename to create (relative to the `srcdir`),
+the name of the plugin, and a callback function. The callback will be
+called if it is appropriate to automatically add the file, and should then
+take care of creating it, and doing anything else it needs to (such as
+checking it into revision control). Note that the callback may not always
+be called. For example, if an automatically added file is deleted by the
+user, ikiwiki will avoid re-adding it again.

 
 This function needs to be called during the scan hook, or earlier in the
 build process, in order to add the file early enough for it to be built.
 
 This function needs to be called during the scan hook, or earlier in the
 build process, in order to add the file early enough for it to be built.