X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/be56970d0565cc259bf28b1a3aa9582269c8d41f..f0f3a430f33a5fe3bbb2396f999dbbfd63d1bf19:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index d881554ca..6c013cd4a 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -49,10 +49,11 @@ return the error message as the output of the plugin. ### Html issues -Note that if [[HTMLSanitization]] is enabled, html in +Note that if the [[htmlscrubber]] is enabled, html in [[PreProcessorDirective]] output is sanitised, which may limit what your plugin can do. Also, the rest of the page content is not in html format at -preprocessor time. Text output by a preprocessor directive will be passed through markdown along with the rest of the page. +preprocessor time. Text output by a preprocessor directive will be passed +through markdown along with the rest of the page. ## Other types of hooks @@ -74,7 +75,16 @@ IkiWiki::error if something isn't configured right. Runs on the raw source of a page, before anything else touches it, and can make arbitrary changes. The function is passed named parameters `page` and -`content` should return the filtered content. +`content` and should return the filtered content. + +### sanitize + + IkiWiki::hook(type => "filter", id => "foo", call => \&sanitize); + +Use this to implement html sanitization or anything else that needs to +modify the content of a page after it has been fully converted to html. +The function is passed the page content and should return the sanitized +content. ### delete @@ -83,13 +93,13 @@ make arbitrary changes. The function is passed named parameters `page` and Each time a page or pages is removed from the wiki, the referenced function is called, and passed the names of the source files that were removed. -### render +### change - IkiWiki::hook(type => "render", id => "foo", call => \&render); + IkiWiki::hook(type => "change", id => "foo", call => \&render); -Each time ikiwiki renders a change or addition (but not deletion) of a page -to the wiki, the referenced function is called, and passed the name of the -source file that was rendered. +Each time ikiwiki renders a change or addition (but not deletion) to the +wiki, the referenced function is called, and passed the names of the +source files that were rendered. ### cgi @@ -147,3 +157,5 @@ modules. These are in the `IkiWiki::RCS` namespace, for example Each RCS plugin must support all the IkiWiki::rcs\_* functions. See IkiWiki::RCS::Stub for the full list of functions. It's ok if rcs\_getctime does nothing except for throwing an error. + +See [[about_RCS_backends]] for some more info.