summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorJohn McLear <john@mclear.co.uk>2014-05-06 21:22:03 +0100
committerJohn McLear <john@mclear.co.uk>2014-05-06 21:22:03 +0100
commita8d9a3868d9e2d2319f62bf19e9906947fae726a (patch)
treecd1fb7cf081d11789b926582aed5b6991801ffd8 /doc/api
parent1f7fcd54f14028eb9e596beb75bb5410ce83ca1c (diff)
downloadetherpad-lite-a8d9a3868d9e2d2319f62bf19e9906947fae726a.zip
docs for new hook
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/hooks_server-side.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/api/hooks_server-side.md b/doc/api/hooks_server-side.md
index 0bde2aad..0c251c3e 100644
--- a/doc/api/hooks_server-side.md
+++ b/doc/api/hooks_server-side.md
@@ -247,3 +247,19 @@ Things in context:
This hook will allow a plug-in developer to re-write each line when exporting to HTML.
+## exportFileName
+Called from src/node/handler/ExportHandler.js
+
+Things in context:
+
+1. padId
+
+This hook will allow a plug-in developer to modify the file name of an exported pad. This is useful if you want to export a pad under another name and/or hide the padId under export. Note that the doctype or file extension cannot be modified for security reasons.
+
+Example:
+
+```
+exports.exportFileName = function(hook, padId){
+ return "newFileName"+padId;
+}
+```