aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorwww-data <www-data@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-03 20:45:10 +0000
committerwww-data <www-data@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-03 20:45:10 +0000
commit5d887948f9e6715bec1645bbea3f58e49dfc7ebe (patch)
treeffaed75fa47dfbd8a6af7c36ca4c66414590884c /doc/plugins
parent3900abf3143912bce58e5f114c5693cf0fc3c3a5 (diff)
downloadikiwiki-5d887948f9e6715bec1645bbea3f58e49dfc7ebe.tar
ikiwiki-5d887948f9e6715bec1645bbea3f58e49dfc7ebe.tar.gz
web commit by joey
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn28
1 files changed, 14 insertions, 14 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index db1badb7c..04803f777 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -33,6 +33,20 @@ Each time the directive is processed, the referenced function (`preprocess` in t
as named parameters as well. Whatever the function returns goes onto the
page in place of the directive.
+### Error handing
+
+While a plugin can call ikiwiki's error routine for a fatal error, for
+errors that aren't intended to halt the entire wiki build, including bad
+parameters passed to a [[PreProcessorDirective]], etc, it's better to just
+return the error message as the output of the plugin.
+
+### Html issues
+
+Note that if [[HTMLSanitization]] is enabled, html in
+[[PreProcessorDirective]] output is sanitised, which may limit what your
+plugin can do. Also, the rest of the page content is not in html format at
+preprocessor time. Text output by a preprocessor directive will be passed through markdown along with the rest of the page.
+
## Other types of hooks
Beyond PreProcessorDirectives, Other types of hooks that can be used by plugins include:
@@ -56,20 +70,6 @@ Each time a page or pages is removed from the wiki, the referenced function is c
Each time ikiwiki renders a change or addition (but not deletion) of a page to the wiki, the referenced function is called, and passed the name of the source file that was rendered.
-## Error handing in plugins
-
-While a plugin can call ikiwiki's error routine for a fatal error, for
-errors that aren't intended to halt the entire wiki build, including bad
-parameters passed to a [[PreProcessorDirective]], etc, it's better to just
-return the error message as the output of the plugin.
-
-## Html issues
-
-Note that if [[HTMLSanitization]] is enabled, html in
-[[PreProcessorDirective]] output is sanitised, which may limit what your
-plugin can do. Also, the rest of the page content is not in html format at
-preprocessor time. Text output by a preprocessor directive will be passed through markdown along with the rest of the page.
-
## Wiki configuration
A plugin can access the wiki's configuration via the `%IkiWiki::config` hash.