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 cf7044b2cbea60c63e3b85b806b7c5170017a2ab..404c3b44f3ace0123194a29c14c5ede32d2be3dc 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -966,6 +966,23 @@ added. Pass it the page that contains the link, and the link text.
 An optional third parameter sets the link type. If not specified,
 it is an ordinary [[ikiwiki/WikiLink]].
 
 An optional third parameter sets the link type. If not specified,
 it is an ordinary [[ikiwiki/WikiLink]].
 

+### `add_autofile($$$)`
+
+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 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.
+

 ## Miscellaneous
 
 ### Internal use pages
 ## Miscellaneous
 
 ### Internal use pages


@@ -1085,6 +1102,8 @@ it up in the history.
 
 It's ok if this is not implemented, and throws an error.
 
 
 It's ok if this is not implemented, and throws an error.
 

+If the RCS cannot determine a ctime for the file, return 0.
+

 #### `rcs_getmtime($)`
 
 This is used to get the page modification time for a file from the RCS, by
 #### `rcs_getmtime($)`
 
 This is used to get the page modification time for a file from the RCS, by


@@ -1092,6 +1111,8 @@ looking it up in the history.
 
 It's ok if this is not implemented, and throws an error.
 
 
 It's ok if this is not implemented, and throws an error.
 

+If the RCS cannot determine a mtime for the file, return 0.
+

 #### `rcs_receive()`
 
 This is called when ikiwiki is running as a pre-receive hook (or
 #### `rcs_receive()`
 
 This is called when ikiwiki is running as a pre-receive hook (or