]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/write.mdwn
Bug: UTF-16 and UTF-32 are unhandled: New
[git.ikiwiki.info.git] / doc / plugins / write.mdwn
index 33532039420f7f3e9a7c9a4857de1b7fe6502dd4..d5bd1dd7648bf867b3dfe1f3a21f71038e40ee83 100644 (file)
@@ -177,10 +177,15 @@ function is passed no values.
 
        hook(type => "needsbuild", id => "foo", call => \&needsbuild);
 
-This allows a plugin to manipulate the list of files that need to be
-built when the wiki is refreshed. The function is passed a reference to an
-array of files that will be rebuilt, and can modify the array, either
-adding or removing files from it.
+This allows a plugin to observe or even manipulate the list of files that
+need to be built when the wiki is refreshed. 
+
+As its first parameter, the function is passed a reference to an array of
+files that will be built. It should return an array reference that is a
+modified version of its input. It can add or remove files from it.
+
+The second parameter passed to the function is a reference to an array of
+files that have been deleted.
 
 ### scan
 
@@ -194,17 +199,6 @@ them to `%links`. Present in IkiWiki 2.40 and later.
 The function is passed named parameters "page" and "content". Its return
 value is ignored.
 
-### rescan
-
-       hook(type => "rescan", id => "foo", call => \&scan);
-
-This hook is called after the scan hook has been run, as well as the
-preprocess hook in scan mode. It is used to collect additional
-metadata that depends on a first scan to have been performed already.
-
-The function is passed named parameters "page" and "content". Its return
-value is ignored.
-
 ### filter
 
        hook(type => "filter", id => "foo", call => \&filter);
@@ -746,6 +740,8 @@ with no ".tmpl" extension. Template pages are normally looked for in
 the templates/ directory. If the page name starts with "/", a page
 elsewhere in the wiki can be used.
 
+If the template is not found, or contains a syntax error, an error is thrown.
+
 ### `template_depends($$;@)`
 
 Use this instead of `template()` if the content of a template is being