summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2010-07-30 16:05:07 +0200
committerintrigeri <intrigeri@boum.org>2010-07-30 16:14:23 +0200
commit25447bccae0439ea56da7a788482a4807c7c459d (patch)
tree21d63415d77cc97890a493b035a083970fb09b84 /doc/plugins
parent1fe87a0808ee4d19d97956d48447644c69334f8a (diff)
Added a rescan hook.
This is needed for the po plugin vs. e.g. meta titles. In order to get rid of the ugly "rebuilding all pages to fix meta titles" thing, Joey suggested to make "po, at scan time, re-run the scan hooks, passing them modified content (either converted from po to mdwn or with the escaped stuff cheaply de-escaped)". This would unfortunately not work, as the meta plugin gathers its data using the preprocess hook in scan mode: it would overwrite with buggy data the correct data we would have forced it to gather in po's scan hook. We then need a hook that runs *after* the preprocess hook has been run in scan mode, but *before* any page rendering is started. Hence this one.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 10b4df835..335320394 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -194,6 +194,17 @@ them to `%links`. Present in IkiWiki 2.40 and later.
The function is passed named parameters "page" and "content". Its return
value is ignored.
+### rescan
+
+ hook(type => "rescan", id => "foo", call => \&scan);
+
+This hook is called after the scan hook has been run, as well as the
+preprocess hook in scan mode. It is used to collect additional
+metadata that depends on a first scan to have been performed already.
+
+The function is passed named parameters "page" and "content". Its return
+value is ignored.
+
### filter
hook(type => "filter", id => "foo", call => \&filter);