summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-07-17 15:16:56 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-07-17 16:17:15 -0400
commit584f3e3061e8983e4caa328d7bc16fdeba849654 (patch)
tree4417efdf3ccd866c866ec9ab2cfd1faa030346cc /doc/plugins
parent1b46f52043aa6eff37da3677d7bdf11944b733ab (diff)
Add a postscan hook.
* Add a postscan hook. * search: Use postscan hook, avoid updating index when previewing.
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 4dc55e302..b4acb237d 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -216,6 +216,17 @@ modify the body of a page after it has been fully converted to html.
The function is passed named parameters: "page", "destpage", and "content",
and should return the sanitized content.
+### postscan
+
+ hook(type => "postscan", id => "foo", call => \&postscan);
+
+This hook is called once the full page body is available (but before the
+format hook). The most common use is to update search indexes. Added in
+ikiwiki 2.54.
+
+The function is passed named parameters "page" and "content". Its return
+value is ignored.
+
### format
hook(type => "format", id => "foo", call => \&format);