diff options
| author | Joey Hess <joey@kitenet.net> | 2010-07-04 15:00:51 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2010-07-04 15:06:48 -0400 |
| commit | 192ce7a238af9021b0fd6dd571f22409af81ebaf (patch) | |
| tree | 4f9c0066a8d783d546826c3291b0f3d40fe32b53 /doc/plugins | |
| parent | 1b14a849fff50888e6a48d7299c23c7d5821572a (diff) | |
| download | ikiwiki-192ce7a238af9021b0fd6dd571f22409af81ebaf.tar ikiwiki-192ce7a238af9021b0fd6dd571f22409af81ebaf.tar.gz | |
remove unnecessary and troublesome filter calls
This better defines what the filter hook is passed, to only be the raw,
complete text of a page. Not some snippet, or data read in from an
unrelated template.
Several plugins that filtered text that originates from an (already
filtered) page were modified not to do that. Note that this was not
done very consistently before; other plugins that receive text from a
page called preprocess on it w/o first calling filter.
The template plugin gets text from elsewhere, and was also changed not to
filter it. That leads to one known regression -- the embed plugin cannot
be used to embed stuff in templates now. But that plugin is deprecated
anyway.
Later we may want to increase the coverage of what is filtered. Perhaps
a good goal would be to allow writing a filter plugin that filters
out unwanted words, from any input. We're not there yet; not only
does the template plugin load unfiltered text from its templates now,
but so can the table plugin, and other plugins that use templates (like
inline!). I think we can cross that bridge when we come to it. If I wanted
such a censoring plugin, I'd probably make it use a sanitize hook instead,
for the better coverage.
For now I am concentrating on the needs of the two non-deprecated users
of filter. This should fix bugs/po_vs_templates, and it probably fixes
an obscure bug around txt's use of filter for robots.txt.
Diffstat (limited to 'doc/plugins')
| -rw-r--r-- | doc/plugins/write.mdwn | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index bb8012342..2e3902388 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -198,8 +198,8 @@ value is ignored. hook(type => "filter", id => "foo", call => \&filter); -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", +Runs on the full raw source of a page, before anything else touches it, and +can make arbitrary changes. The function is passed named parameters "page", "destpage", and "content". It should return the filtered content. ### preprocess |