aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-11-08 13:48:07 -0500
committerJoey Hess <joey@gnu.kitenet.net>2009-11-08 13:48:07 -0500
commit66b46576ec097b9f10b45d4b1de18bb214cd5bd5 (patch)
tree9cda888650586e576da95dd5eaa28bb1ec80991d /doc/plugins
parent19ff6180a8bbb2e5441fe177a934e146d129f1c7 (diff)
downloadikiwiki-66b46576ec097b9f10b45d4b1de18bb214cd5bd5.tar
ikiwiki-66b46576ec097b9f10b45d4b1de18bb214cd5bd5.tar.gz
Moved the postscan hook to run on the raw html of a page, before the template is filled out. This improves the search plugin's indexing, since it will not include navigational elements from the page template or sidebar.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn22
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index c72418c3c..2f179d46f 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -201,6 +201,17 @@ like `Makefile` that have no extension.
If `hook` is passed an optional "longname" parameter, this value is used
when prompting a user to choose a page type on the edit page form.
+### postscan
+
+ hook(type => "postscan", id => "foo", call => \&postscan);
+
+This hook is called once the page has been converted to html (but before
+the generated html is put in a template). 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.
+
### pagetemplate
hook(type => "pagetemplate", id => "foo", call => \&pagetemplate);
@@ -237,17 +248,6 @@ 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);