aboutsummaryrefslogtreecommitdiffstats
path: root/README.hooks
diff options
context:
space:
mode:
authorEgil Moeller <egil.moller@freecode.no>2010-03-22 00:23:01 +0100
committerEgil Moeller <egil.moller@freecode.no>2010-03-22 00:23:01 +0100
commitf0050f45b67b0ca6539e03b23848e977f47c0905 (patch)
tree87f9168b0174b59b82fc5a116f6f24e5876f9c0b /README.hooks
parentfc00cfedd6c25d1634a1e0d28a7b7bc5f42e1cd7 (diff)
downloadetherpad-f0050f45b67b0ca6539e03b23848e977f47c0905.tar.gz
etherpad-f0050f45b67b0ca6539e03b23848e977f47c0905.tar.xz
etherpad-f0050f45b67b0ca6539e03b23848e977f47c0905.zip
Updated changes to adhere to new directory layout
Diffstat (limited to 'README.hooks')
-rw-r--r--README.hooks24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.hooks b/README.hooks
new file mode 100644
index 0000000..d15949c
--- /dev/null
+++ b/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