diff options
| author | Egil Moeller <egil.moller@freecode.no> | 2010-03-12 21:46:39 +0100 |
|---|---|---|
| committer | Egil Moeller <egil.moller@freecode.no> | 2010-03-12 21:46:39 +0100 |
| commit | 22035e909988e28f6777be39a9a4c67e910a65d0 (patch) | |
| tree | 891de8e4389c0b47964809ea857cc464f8119953 /trunk/README.hooks | |
| parent | 91df2b2bb7e174f5b81657830dd1835b7d3c2ab8 (diff) | |
| download | etherpad-22035e909988e28f6777be39a9a4c67e910a65d0.tar.gz etherpad-22035e909988e28f6777be39a9a4c67e910a65d0.tar.xz etherpad-22035e909988e28f6777be39a9a4c67e910a65d0.zip | |
Added some documentation on the hooks available
Diffstat (limited to 'trunk/README.hooks')
| -rw-r--r-- | trunk/README.hooks | 24 |
1 files changed, 24 insertions, 0 deletions
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 |