X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/e3c6b9bb9d6cef040f9c3f8a86337cf340966806..4fda36e8dfcddfc12c451fbb142aa54de377ba33:/doc/plugins/write.mdwn?ds=sidebyside diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index b9d7c01c2..508dd83dc 100644 --- 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 -"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`. @@ -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`. +Present in IkiWiki 2.40 and later. The function is passed named parameters "page" and "content". Its return value is ignored. @@ -525,12 +527,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. -#### `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. +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