urosm
/
ikiwiki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add_autofile filename should be relative to srcdir

master
Joey Hess 2010-04-21 14:27:12 -04:00
parent 0fcbcc4815
commit 9c8761ba49
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/plugins/write.mdwn
View File

@ -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.
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.