summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2010-04-17 17:15:07 -0400
committerJoey Hess <joey@kitenet.net>2010-04-17 17:15:07 -0400
commit59ceeb5621ae0ae2bcb7501c6ac0c7a06562a7cc (patch)
tree3d0ce429fc26c72cde6d05e17c0ebbd15b606dba /doc/plugins
parent831b891abdc68d1b111381d6559cebd5a9b6c78f (diff)
improve docs
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index e33c99421..5190a26ed 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -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