improve docs
authorJoey Hess <joey@kitenet.net>
Sat, 17 Apr 2010 21:15:07 +0000 (17:15 -0400)
committerJoey Hess <joey@kitenet.net>
Sat, 17 Apr 2010 21:15:07 +0000 (17:15 -0400)
doc/plugins/write.mdwn

index e33c99421ee7293d8877153bf90ee99c07b285b1..5190a26edb4ce85f5f54c94b9abfe0f9058a5c33 100644 (file)
@@ -968,9 +968,9 @@ it is an ordinary [[ikiwiki/WikiLink]].
 
 ### `add_autofile($$$)`
 
-Sometimes you may want to add a file to the `srcdir`. For example,
-[[plugins/tag]] pages can be automatically created as needed. This function
-can be used to do that. 
+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. 
 
 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
@@ -980,7 +980,8 @@ 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 to work.
+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.
 
 ## Miscellaneous