improve docs

master
Joey Hess 2010-04-17 17:15:07 -04:00
parent 831b891abd
commit 59ceeb5621
1 changed files with 5 additions and 4 deletions

View 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