X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f92505d78b82c6ac146e43054ebd12441575a602..84b915d6d1fb9af543e0a6989c0920d10a1176e9:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index e1e057c00..ea2d00630 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -92,6 +92,8 @@ function is passed no values. ### needsbuild + + hook(type => "needsbuild", id => "foo", call => \&needsbuild); This allows a plugin to manipulate the list of files that need to be @@ -142,6 +144,30 @@ format at preprocessor time. Text output by a preprocessor directive will be linkified and passed through markdown (or whatever engine is used to htmlize the page) along with the rest of the page. +### linkify + + hook(type => "linkify", id => "foo", call => \&linkify); + +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. 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`. + +### scan + + hook(type => "scan", id => "foo", call => \&scan); + +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. + ### htmlize hook(type => "htmlize", id => "ext", call => \&htmlize); @@ -490,7 +516,7 @@ version of the file. In particular, in preview mode, this should still be called even if the file isn't going to be written to during the preview. Ikiwiki uses this information to automatically clean up rendered files when -the page that rendered them goes away or is changes to no longer render +the page that rendered them goes away or is changed to no longer render them. will_render also does a few important security checks. #### `pagetype($)`