public-offering
/
pad.pub0.org
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

pluginfw: Hook to include additional body in HTML exports (#4469) 

* hook, needs docs

* docs
changelog-187
John McLear 2020-11-06 13:48:59 +00:00 committed by GitHub
parent 3fa58efede
commit 881d8b8d95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/api/hooks_server-side.md
View File

@ -661,6 +661,24 @@ function _analyzeLine(alineAttrs, apool) {
} }
``` ```
## exportHTMLAdditionalContent
Called from: src/node/utils/ExportHtml.js
Things in context:
1. padId
This hook will allow a plug-in developer to include additional HTML content in the Body of the exported HTML
Example:
```
exports.exportHTMLAdditionalContent = async (hookName, context) => {
let padId = context;
return "I am groot in " + padId;
}
```
## stylesForExport ## stylesForExport
Called from: src/node/utils/ExportHtml.js Called from: src/node/utils/ExportHtml.js

5
src/node/utils/ExportHtml.js
View File

@ -498,6 +498,11 @@ exports.getPadHTMLDocument = async function (padId, revNum)
let html = await getPadHTML(pad, revNum); let html = await getPadHTML(pad, revNum);
let exportHTMLAdditionalContent = await hooks.aCallAll("exportHTMLAdditionalContent", padId);
exportHTMLAdditionalContent.forEach(function(hookHtml){
html += hookHtml;
});
return eejs.require("ep_etherpad-lite/templates/export_html.html", { return eejs.require("ep_etherpad-lite/templates/export_html.html", {
body: html, body: html,
padId: Security.escapeHTML(padId), padId: Security.escapeHTML(padId),