X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/75a11e6a8d92f7ff221eb4b1270526d57ef537bc..96be7225cf989dbee7bf9472a81cff445e8a7e83:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 3030d6558..d09367f1b 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -148,7 +148,7 @@ return the htmlized content. hook(type => "pagetemplate", id => "foo", call => \&pagetemplate); -[[Templates|wikitemplate]] are filled out for many different things in +[[Templates|wikitemplates]] are filled out for many different things in ikiwiki, like generating a page, or part of a blog page, or an rss feed, or a cgi. This hook allows modifying the variables available on those templates. The function is passed named parameters. The "page" and @@ -258,8 +258,9 @@ If the hook has no opinion about whether the edit can proceed, return These hooks allow tapping into the parts of ikiwiki that use [[cpan CGI::FormBuilder]] to generate web forms. These hooks are passed named -parameters: `cgi`, `session`, and `form`. These are, respectively, the -`CGI` object, the user's `CGI::Session`, and a `CGI::FormBuilder`. +parameters: `cgi`, `session`, `form`, and `buttons`. These are, respectively, +the `CGI` object, the user's `CGI::Session`, a `CGI::FormBuilder`, and a +reference to an array of names of buttons to go on the form. Each time a form is set up, the `formbuilder_setup` hook is called. Typically the `formbuilder_setup` hook will check the form's title, and if @@ -270,8 +271,7 @@ will not validate or display the form. Form validation and display can be overridden by the formbuilder hook. By default, ikiwiki will do a basic validation and display of the form, but if this hook is registered, it will stop that and let the hook take -over. This hook is passed an additional named parameter: `buttons` is an -array of the submit buttons for the form. +over. ### savestate @@ -474,15 +474,15 @@ rendered to. ## RCS plugins -ikiwiki's support for revision control systems also uses pluggable perl -modules. These are in the `IkiWiki::RCS` namespace, for example +ikiwiki's support for [[revision_control_systems|rcs]] also uses pluggable +perl modules. These are in the `IkiWiki::RCS` namespace, for example `IkiWiki::RCS::svn`. 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. +See [[RCS_details|rcs/details]] for some more info. ## PageSpec plugins