From 22035e909988e28f6777be39a9a4c67e910a65d0 Mon Sep 17 00:00:00 2001
From: Egil Moeller <egil.moller@freecode.no>
Date: Fri, 12 Mar 2010 21:46:39 +0100
Subject: Added some documentation on the hooks available

---
 trunk/README.hooks | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 trunk/README.hooks

(limited to 'trunk/README.hooks')

diff --git a/trunk/README.hooks b/trunk/README.hooks
new file mode 100644
index 0000000..d15949c
--- /dev/null
+++ b/trunk/README.hooks
@@ -0,0 +1,24 @@
+Hooks that plugins can provide
+
+All hooks must return either undefined/null or a list of return values. This might be an empty list or a list of just one value.
+
+handlePath
+  Registers new urls to serve
+  Parameters: None
+  Returns: Parameter suitable for Dispatcher
+renderPageBodyPre
+  Adds extra html before the body of a page
+  Parameters: bodyFileName, data, plugin
+  Returns: String(s) of html
+renderPageBodyPost
+  Adds extra html after the body of a page
+  Parameters: bodyFileName, data, plugin
+  Returns: String(s) of html
+serverStartup
+  Run right after server startup
+  Parameters: None
+  Returns: None
+serverShutdown
+  Run before server shutdown
+  Parameters: None
+  Returns: None
-- 
cgit v1.2.3