diff options
| author | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-08-04 07:41:02 +0000 |
|---|---|---|
| committer | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2006-08-04 07:41:02 +0000 |
| commit | 0708bb8aecaa6f4edcb60d84ed6555d61f83a2bc (patch) | |
| tree | df03d054883ad1c42ae2586ee224a30a7bb57100 /doc | |
| parent | acaee3d0bce78b6e6d8989821150d28a87026ff0 (diff) | |
* Don't run tidy with -xml as that fails if the input is not well-formed.
Run it with -asxhtml instead, so it will output well-formed xhtml no
matter what the input.
* Disable tidy warnings too.
* Add a new format hook, and make tidy use it, since tidy can really only
operate on and output complete html documents, not the body chunks
that sanitise gets.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/plugins/aggregate.mdwn | 4 | ||||
| -rw-r--r-- | doc/plugins/write.mdwn | 12 |
2 files changed, 14 insertions, 2 deletions
diff --git a/doc/plugins/aggregate.mdwn b/doc/plugins/aggregate.mdwn index 4cd5b57ac..fe17199e3 100644 --- a/doc/plugins/aggregate.mdwn +++ b/doc/plugins/aggregate.mdwn @@ -13,7 +13,9 @@ aggregated feeds. ## setup Make sure that you have the [[html]] plugin enabled, as the created pages are -in html format. The [[meta]] and [[tag]] plugins are also recommended. +in html format. The [[meta]] and [[tag]] plugins are also recommended. The +[[htmltidy]] plugin is suggested, since feeds can easily contain invalid +html which tidy can fix. You will need to run ikiwiki periodically from a cron job, passing it the --aggregate parameter, to make it check for new posts. Here's an example diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 79bd75e9b..6d9054389 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -129,10 +129,20 @@ to set it, as setting a variable that's not present is an error. IkiWiki::hook(type => "sanitize", 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. +modify the body of a page after it has been fully converted to html. The function is passed the page content and should return the sanitized content. +## format + + IkiWiki::hook(type => "format", id => "foo", call => \&format); + +The function is passed the complete page content and can reformat it +and return the new content. The difference between format and sanitize is +that sanitize only acts on the page body, while format can modify the +entire html page including the header and footer inserted by ikiwiki, the +html document type, etc. + ## delete IkiWiki::hook(type => "delete", id => "foo", call => \&delete); |