]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/write.mdwn
fix logic
[git.ikiwiki.info.git] / doc / plugins / write.mdwn
index e33c99421ee7293d8877153bf90ee99c07b285b1..eaa0081319d223a0934b7b48d4edbaf27eac501e 100644 (file)
@@ -315,9 +315,9 @@ a new custom parameter to the template.
 
 This hook allows plugins to change the [[template|wikitemplates]] that is
 used for a page in the wiki. The hook is passed a "page" parameter, and
-should return the name of the template file to use, or undef if it doesn't
-want to change the default ("page.tmpl"). Template files are looked for in
-/usr/share/ikiwiki/templates by default.
+should return the name of the template file to use (relative to the
+template directory), or undef if it doesn't want to change the default
+("page.tmpl").
 
 ### sanitize
 
@@ -705,6 +705,14 @@ Creates and returns a [[!cpan HTML::Template]] object. The first parameter
 is the name of the file in the template directory. The optional remaining
 parameters are passed to `HTML::Template->new`.
 
+### `template_depends($$;@)`
+
+Use this instead of `template()` if the content of a template is being
+included into a page. This causes the page to depend on the template,
+so it will be updated if the template is modified.
+
+Like `template()`, except the second parameter is the page.
+
 ### `htmlpage($)`
 
 Passed a page name, returns the base name that will be used for a the html
@@ -968,19 +976,20 @@ 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
-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 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