X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/cbb3218db762341a1eafbf2892cb100755772f78..651cdd4b2a85f4e5f9d298a7eea7d0e6d94442b1:/doc/plugins/write.mdwn diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index f4620b623..b6d0611dc 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -217,6 +217,9 @@ value is ignored. Runs on the raw source of a page or `*.tmpl` file that is being used as a template, before it is parsed by [[!cpan HTML::Template]]. +For instance, the [[plugins/templatebody]] plugin uses this to return +the content of the [[ikiwiki/directive/templatebody]] directive (if there +is one) instead of the page's full content. The function is passed named parameters: @@ -455,6 +458,9 @@ object's "name" parameter to the authenticated user's name. Note that if the name is set to the name of a user who is not registered, a basic registration of the user will be automatically performed. +Auth plugins can use the loginselector helper plugin to let the user +select which authentication method to use. + ### sessioncgi hook(type => "sessioncgi", id => "foo", call => \&sessioncgi); @@ -735,21 +741,28 @@ Ordinary [[WikiLinks|ikiwiki/WikiLink]] appear in `%links`, but not in ### `%pagesources` -The `%pagesources` has can be used to look up the source filename +The `%pagesources` hash can be used to look up the source filename of a page. So the key is the page name, and the value is the source filename. Do not modify this hash. +Attachments also appear in this hash, with the same key and value. + $pagesources{"foo"} = "foo.mdwn"; + $pagesources{"logo/ikiwiki.png"} = "logo/ikiwiki.png"; + ### `%destsources` The `%destsources` hash records the name of the source file used to create each destination file. The key is the output filename (ie, -"foo/index.html"), and the value is the source filename that it was built -from (eg, "foo.mdwn"). Note that a single source file may create multiple +"foo/index.html"), and the value is the name of the page that it was built +from (eg, "foo"). Note that a single source file may create multiple destination files. Do not modify this hash directly; call `will_render()`. - - $destsources{"foo/index.html"} = "foo.mdwn"; + +Attachments also appear in this hash, with the same key and value. + + $destsources{"foo/index.html"} = "foo"; + $destsources{"logo/ikiwiki.png"} = "logo/ikiwiki.png"; ## Library functions