You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#3441 discusses the introduction of custom named skins.
This issue proposes the first enabling step: the introduction of a new skinName parameter in settings.json that holds the name of the desired skin.
Detailed spec:
move current src/static/custom to src/static/skins/no-skin (this will be the default empty skin)
in the code, identify the files that point to static/custom/*. DONE: they seem to be:
src/node/hooks/express/specialpages.js
src/static/js/ace.js
src/templates/index.html
src/templates/javascript.html
src/templates/pad.html
replace all the references to static/custom/* with src/static/skins/*.
For HTML files the <%=settings.skinName%>ejs syntax can be used.
perform a sanitization of the skin value: when concatenated to settings.exports.root, it has to be a proper, existing subdirectory of src/static/skins
in case of errors, fall back to no-skin
backwards compatibility: when running with a settings.json from Etherpad <= 1.7, which does not have the skinName parameter, the application has to fall back to no-skin and print a WARNING message in the logs, inviting the user to update its settings file.
The text was updated successfully, but these errors were encountered:
…scripts.
Currently, an Etherpad skin requires the existence of 6 files:
- index.{css,js}
- pad.{css,js}
- timeslider.{css,js}
In the default empty skin (in static/custom), there were 2 small placeholders
({js,css}.template) to be copied in place by the startup script in case no skin
was in use.
Now that we are moving to multiple directories (see #3471) we can simply commit
the example files and remove the copying code from the startup script.
#3441 discusses the introduction of custom named skins.
This issue proposes the first enabling step: the introduction of a new
skinName
parameter insettings.json
that holds the name of the desired skin.Detailed spec:
src/static/custom
tosrc/static/skins/no-skin
(this will be the default empty skin)static/custom/*
.DONE: they seem to be:
src/node/hooks/express/specialpages.js
src/static/js/ace.js
src/templates/index.html
src/templates/javascript.html
src/templates/pad.html
static/custom/*
withsrc/static/skins/*
.For HTML files the
<%=settings.skinName%>
ejs syntax can be used.settings.exports.root
, it has to be a proper, existing subdirectory ofsrc/static/skins
no-skin
settings.json
from Etherpad <= 1.7, which does not have theskinName
parameter, the application has to fall back tono-skin
and print a WARNING message in the logs, inviting the user to update its settings file.The text was updated successfully, but these errors were encountered: