web commit by buo: libdir does have an effect

[git.ikiwiki.info.git] / doc / plugins / write.mdwn

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index b9d7c01c2367147b3c7771ca312e8a5b3193e82e..35f391f7f2f07d965117125ada195dcfa480c3b5 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -148,7 +148,8 @@ htmlize the page) along with the rest of the page.
 
 This hook is called to convert [[WikiLinks|WikiLink]] on the page into html
 links. The function is passed named parameters "page", "destpage", and
 
 This hook is called to convert [[WikiLinks|WikiLink]] on the page into html
 links. The function is passed named parameters "page", "destpage", and

-"content". It should return the linkified content.
+"content". It should return the linkified content.  Present in IkiWiki 2.40
+and later.

 
 Plugins that implement linkify must also implement a scan hook, that scans
 for the links on the page and adds them to `%links`.
 
 Plugins that implement linkify must also implement a scan hook, that scans
 for the links on the page and adds them to `%links`.


@@ -160,6 +161,7 @@ for the links on the page and adds them to `%links`.
 This hook is called early in the process of building the wiki, and is used
 as a first pass scan of the page, to collect metadata about the page. It's
 mostly used to scan the page for WikiLinks, and add them to `%links`.
 This hook is called early in the process of building the wiki, and is used
 as a first pass scan of the page, to collect metadata about the page. It's
 mostly used to scan the page for WikiLinks, and add them to `%links`.

+Present in IkiWiki 2.40 and later.

 
 The function is passed named parameters "page" and "content". Its return
 value is ignored.
 
 The function is passed named parameters "page" and "content". Its return
 value is ignored.


@@ -209,8 +211,8 @@ want to change the default ("page.tmpl"). Template files are looked for in
 Use this to implement html sanitization or anything else that needs to
 modify the body of a page after it has been fully converted to html.
 
 Use this to implement html sanitization or anything else that needs to
 modify the body of a page after it has been fully converted to html.
 

-The function is passed named parameters: "page" and "content", and 
-should return the sanitized content.
+The function is passed named parameters: "page", "destpage", and "content",
+and should return the sanitized content.

 
 ### format
 
 
 ### format
 


@@ -359,10 +361,11 @@ next time ikiwiki is run. The hash holds per-page state, so to set a value,
 use `%pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
 use `%pagestate{$page}{$id}{$key}`.
 
 use `%pagestate{$page}{$id}{$key}=$value`, and to retrieve the value,
 use `%pagestate{$page}{$id}{$key}`.
 

-`$key` can be any string you like, but `$id` must be the same as the "id"
-parameter passed to `hook()` when registering the plugin. This is so
-ikiwiki can know when to delete pagestate for plugins that are no longer
-used.
+The `$value` can be anything that perl's Storable module is capable of
+serializing. `$key` can be any string you like, but `$id` must be the same
+as the "id" parameter passed to `hook()` when registering the plugin. This
+is so ikiwiki can know when to delete pagestate for plugins that are no
+longer used.

 
 When pages are deleted, ikiwiki automatically deletes their pagestate too.
 
 
 When pages are deleted, ikiwiki automatically deletes their pagestate too.
 


@@ -525,12 +528,16 @@ a type that ikiwiki knowns how to htmlize. Otherwise, returns undef.
 Given the name of a source file, returns the name of the wiki page
 that corresponds to that file.
 
 Given the name of a source file, returns the name of the wiki page
 that corresponds to that file.
 

-#### `srcfile($)`
+#### `srcfile($;$)`

 
 Given the name of a source file in the wiki, searches for the file in
 the source directory and the underlay directories (most recently added
 underlays first), and returns the full path to the first file found.
 
 
 Given the name of a source file in the wiki, searches for the file in
 the source directory and the underlay directories (most recently added
 underlays first), and returns the full path to the first file found.
 

+Normally srcfile will fail with an error message if the source file cannot
+be found. The second parameter can be set to a true value to make it return
+undef instead.
+

 #### `add_underlay($)`
 
 Adds a directory to the set of underlay directories that ikiwiki will
 #### `add_underlay($)`
 
 Adds a directory to the set of underlay directories that ikiwiki will