Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 0ca0da8b1a | |||
| 7de33a31f7 | |||
| 7677aefc14 | |||
| 80a3d4a079 | |||
| 02eda6c503 | |||
| b6a9ac74db | |||
| 193de4b6b9 | |||
| cee78a973f | |||
| 7fdf23d196 |
18 changed files with 1721 additions and 1180 deletions
17
.gitattributes
vendored
Normal file
17
.gitattributes
vendored
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
# One consistent line-ending approach for this theme: LF (Unix) everywhere.
|
||||
# See the comment at the top of config.xml. Text files are normalized to LF
|
||||
# in the repository and checked out with LF; binary files are stored as-is.
|
||||
* text=auto eol=lf
|
||||
*.png binary
|
||||
*.jpg binary
|
||||
*.jpeg binary
|
||||
*.gif binary
|
||||
*.svg binary
|
||||
*.ico binary
|
||||
*.zip binary
|
||||
*.woff binary
|
||||
*.woff2 binary
|
||||
*.ttf binary
|
||||
*.otf binary
|
||||
*.eot binary
|
||||
*.map -text
|
||||
6
.gitignore
vendored
Normal file
6
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
# Client variant definitions contain confidential house-style values (client
|
||||
# names, colors, fonts, logo files). They are NOT kept in this public repo:
|
||||
# store them in the private variants repository or locally, and point
|
||||
# variants/build.php at that folder (2nd CLI argument or RESPONDAGE_VARIANTS_DIR).
|
||||
variants/*.json
|
||||
variants/README.internal.md
|
||||
135
README.md
135
README.md
|
|
@ -1 +1,134 @@
|
|||
This is a LimeSurvey version 6 theme as an extension of the Vanilla base theme.
|
||||
Respondage Vanilla — LimeSurvey theme (version 6/7 compatible), extension of the core Vanilla theme.
|
||||
|
||||
This is the MOTHER theme. Client-specific variants (e.g. `<client>_vanilla`)
|
||||
extend this theme via `<extends>respondage_vanilla</extends>` and contain only
|
||||
a generated `config.xml` plus their own `files/` (logos). LimeSurvey inherits
|
||||
all files (views, css, js, images, options page) from the mother theme, so any
|
||||
change to a file in this theme automatically applies to all variants — no
|
||||
copying of files needed.
|
||||
|
||||
## What's in here
|
||||
|
||||
- `config.xml` — theme manifest incl. all theme options (colors, fonts, font
|
||||
sizes/weights/colors, header logos, ...).
|
||||
- `views/` — twig overrides (header with left/center/right logos and navbar
|
||||
menu color, survey list, question, group description).
|
||||
- `sass/` → `css/plain.css` — theme styles (keep both in sync; plain.css is
|
||||
the compiled output of sass/plain.sass).
|
||||
- `css/custom.css`, `scripts/custom.js` — loaded last, safe for project
|
||||
tweaks.
|
||||
- `options/` — options page assets.
|
||||
- `variants/` — build/export tooling only. Client variant definitions
|
||||
(`variants/*.json`) hold confidential house-style values, are gitignored
|
||||
(see `.gitignore`) and live in the private variants repo, not here.
|
||||
|
||||
## Header logos (left / center / right)
|
||||
|
||||
Three independent logo options in the Images category: `brandlogo`(+`brandlogofile`)
|
||||
left, `centerlogo`(+`centerlogofile`) center, `rightlogo`(+`rightlogofile`)
|
||||
right. The center logo is absolutely centered in the navbar (see
|
||||
`sass/plain.sass`). Logo files are looked up in the theme's own `files/`
|
||||
folder first, then in the mother theme's `files/` folder.
|
||||
|
||||
## Menu item color in the top bar
|
||||
|
||||
Option `navbarfontcolor` (Colors category) sets the text color of the menu
|
||||
items in the navbar; it is applied in `views/subviews/header/custom_header.twig`
|
||||
and should contrast with `headerbackgroundcolor`.
|
||||
|
||||
## Distance from the logo to the top of the screen
|
||||
|
||||
Option `logotopmargin` (Images category, e.g. `15px` or `0px`) sets the top
|
||||
padding of the header logos, applied in `custom_header.twig`. Use `0px` to
|
||||
align a logo exactly with the top of the screen.
|
||||
|
||||
## Custom fonts per variant
|
||||
|
||||
LimeSurvey only knows its core font packages (`application/config/fonts.php`),
|
||||
so a theme cannot register a `font-*` package itself. Instead a variant ships
|
||||
its own font files and css:
|
||||
|
||||
1. Put the font files in the variant's `files/fonts/` (e.g. `my-custom-font.woff2`).
|
||||
2. Create `css/variant.css` in the variant with the `@font-face` and the body
|
||||
class rule (the selected font is applied as `font-<value>` on `<body>`):
|
||||
```css
|
||||
@font-face {
|
||||
font-family: 'My Custom Font';
|
||||
src: url('../files/fonts/my-custom-font.woff2') format('woff2');
|
||||
font-weight: 400; font-style: normal;
|
||||
}
|
||||
body.font-my_custom_font {
|
||||
font-family: 'My Custom Font', Arial, sans-serif;
|
||||
}
|
||||
```
|
||||
(`../files/...` works because the asset manager copies the whole theme dir.)
|
||||
3. In `variants/<client>.json` declare the css file and the dropdown entry:
|
||||
```json
|
||||
{
|
||||
"files_add": { "css": ["css/variant.css"], "js": [] },
|
||||
"fontOptions": [ { "value": "my_custom_font", "label": "My Custom Font" } ]
|
||||
}
|
||||
```
|
||||
`build.php` appends the css to the `<files>` list and the font to the
|
||||
"Custom (this theme)" optgroup of the font dropdown (`data-font-package`
|
||||
stays `websafe`, so no nonexistent package is requested — the real font is
|
||||
loaded by the variant's own css).
|
||||
4. Run `php variants/build.php <client>` and upload/reset as usual.
|
||||
|
||||
## Client variants (house styles) without code duplication
|
||||
|
||||
House-style-specific values are ONLY: colors, fonts, and font
|
||||
sizes/colors/weights (plus logo files). Everything else lives once, here.
|
||||
|
||||
Workflow:
|
||||
|
||||
1. In `config.xml`, the house-style options are marked with `HOUSE-STYLE`
|
||||
comments (colors, fonts, font sizes/weights, logo files, logo top margin,
|
||||
background image/color). Only those values belong in a variant json —
|
||||
never hardcode house-style values in shared files (`views/`, `sass/`,
|
||||
`css/`, `scripts/`), because those are inherited by all variants.
|
||||
2. Create `variants/<client>.json` with the variant name/title/description and
|
||||
only the house-style option keys with the client values:
|
||||
```json
|
||||
{
|
||||
"name": "client_vanilla",
|
||||
"title": "Client Vanilla",
|
||||
"options": { "primarycolor": "#123456", "fontsize": "18px" }
|
||||
}
|
||||
```
|
||||
2. Run `php variants/build.php <client>`. This generates
|
||||
`../<client>/config.xml`: a copy of this theme's config.xml with only those
|
||||
option values replaced, `<extends>` set to this theme, and the `<engine>`
|
||||
section emptied except `<optionspage>` (same as LimeSurvey's own "extend
|
||||
theme" action), so engine settings are inherited. The `<files>` list is
|
||||
kept: LimeSurvey resolves each listed file in the variant first and then in
|
||||
the mother, so the mother's css/js keep loading until a variant ships its
|
||||
own file with the same name. Unknown option keys make the build fail
|
||||
loudly, so drift is caught at build time.
|
||||
3. Put the client's images in `../<client>/files/`, upload the folder to
|
||||
`upload/themes/survey/`, install/reset the theme in LimeSurvey.
|
||||
|
||||
Because of the native `<extends>` mechanism:
|
||||
- changes to any file (twig/css/js) in this mother theme apply to all
|
||||
variants immediately — edit them only here;
|
||||
- changes to non-house-style option defaults in `config.xml` apply to a
|
||||
variant after re-running the build script and resetting that variant theme;
|
||||
- house-style values live only in `variants/<client>.json` and the variant's
|
||||
`files/`, so they are never overwritten by changes in this mother theme.
|
||||
|
||||
## Public release
|
||||
|
||||
The public version of this theme is ONLY the mother theme: this directory
|
||||
without `variants/` (client house-style definitions) and without `.git`.
|
||||
Build it with:
|
||||
|
||||
bash variants/export_public.sh [output-dir]
|
||||
|
||||
This creates a checked, client-free copy plus a zip (default output:
|
||||
`<limesurvey-root>/dist/`). Publish only that artifact / the `main` branch.
|
||||
NEVER publish: `variants/*.json`, generated client theme folders, or any git
|
||||
branch containing a client theme (client names, colors and logos are
|
||||
confidential). Client variant definitions stay in a PRIVATE repository (or
|
||||
locally); `variants/*.json` is gitignored and `build.php` reads the
|
||||
definitions from that private folder via its second argument or
|
||||
RESPONDAGE_VARIANTS_DIR.
|
||||
|
|
|
|||
83
config.xml
83
config.xml
|
|
@ -3,6 +3,11 @@
|
|||
(¯`·._.·(¯`·._.· Vanilla Theme Manifest ·._.·´¯)·._.·´¯)
|
||||
Base configuration for Vanilla Theme.
|
||||
The content of this file is imported into DB when you install the template.
|
||||
|
||||
Line endings: ALL text files in this theme (including this config.xml) use
|
||||
LF (Unix) line endings only - no CRLF, no lone CR. This is enforced by
|
||||
.gitattributes (* text=auto eol=lf). Keep it that way so diffs stay
|
||||
readable; do not re-save files with CRLF line endings.
|
||||
-->
|
||||
<config>
|
||||
<!-- Those metadata are displayed in the theme configuration page. -->
|
||||
|
|
@ -16,15 +21,16 @@
|
|||
<authorUrl>http://www.respondage.nl</authorUrl>
|
||||
<copyright>Copyright (C) 2026 Respondage. All rights reserved.</copyright>
|
||||
<license>GNU General Public License version 2 or later</license>
|
||||
<version>3.0.1</version>
|
||||
<version>3.1.0</version>
|
||||
<apiVersion>3</apiVersion>
|
||||
<description><![CDATA[<strong>Respondage Theme based on core theme Vanilla</strong><br>A clean and simple base that was used by a certain theme developer to create a really clean theme.]]></description>
|
||||
<lastUpdate>2026-06-10 12:00:00</lastUpdate>
|
||||
<lastUpdate>2026-11-16 19:13:27</lastUpdate>
|
||||
<extends>vanilla</extends>
|
||||
</metadata>
|
||||
|
||||
<compatibility>
|
||||
<version>6.0</version>
|
||||
<version>7.0</version>
|
||||
</compatibility>
|
||||
|
||||
<!--
|
||||
|
|
@ -59,6 +65,20 @@
|
|||
</files>
|
||||
|
||||
<!-- You can add here any option you want. It will be available in twig file via aSurveyInfo.options.youroptionname -->
|
||||
|
||||
<!--
|
||||
HOUSE-STYLE CONVENTION:
|
||||
- Options in sections marked "HOUSE-STYLE" are house-style specific:
|
||||
colors, fonts and the sizes/colors/weights of those fonts, plus
|
||||
logo on/off + file, logo top margin and background image/color.
|
||||
- House-style values are ONLY set per client in variants/<client>.json
|
||||
(processed by variants/build.php into the variant's config.xml).
|
||||
Never hardcode them in views/, sass/, css/ or scripts/: those files
|
||||
are shared with all variants.
|
||||
- Unmarked options are functional/structural (default of the mother
|
||||
theme, same for all variants). A variant may still override them via
|
||||
the json; build.php checks that the key exists.
|
||||
-->
|
||||
<options>
|
||||
<hideprivacyinfo type="buttons" category="Simple options" width="4" title="Hide privacy info" options="on|off" optionlabels="Yes|No">off</hideprivacyinfo>
|
||||
<container type="buttons" category="Simple options" width="4" title="Survey container" options="on|off" optionlabels="Yes|No">on</container>
|
||||
|
|
@ -66,17 +86,29 @@
|
|||
<showclearall type="buttons" category="Simple options" width="4" title="Show Clear All button" options="on|off" optionlabels="Yes|No">off</showclearall>
|
||||
<fixnumauto type="buttons" category="Simple options" width="4" title="Fix automatically numeric value" options="enable|partial|disable" optionlabels="Yes|For expression|No">enable</fixnumauto>
|
||||
|
||||
<!-- Images
|
||||
HOUSE-STYLE: logos (on/off + file), logotopmargin, background image
|
||||
and bodybackgroundcolor are set per variant via variants/<client>.json -->
|
||||
<!-- Images -->
|
||||
<brandlogo type="buttons" category="Images" width="2" title="Display main logo" options="on|off" optionlabels="Yes|No">on</brandlogo>
|
||||
<brandlogofile type="imagefile" category="Images" width="7" title="Main logo file" parent="brandlogo">./files/logo.png</brandlogofile>
|
||||
<secondlogo type="buttons" category="Images" width="2" title="Display second logo" options="on|off" optionlabels="Yes|No">on</secondlogo>
|
||||
<secondlogofile type="imagefile" category="Images" width="7" title="Second logo file" parent="secondlogo">./files/logo.png</secondlogofile>
|
||||
<brandlogo type="buttons" category="Images" width="2" title="Display logo on the left of the header" options="on|off" optionlabels="Yes|No">on</brandlogo>
|
||||
<brandlogofile type="imagefile" category="Images" width="7" title="Logo file (left)" parent="brandlogo">./files/logo.png</brandlogofile>
|
||||
<centerlogo type="buttons" category="Images" width="2" title="Display logo in the center of the header" options="on|off" optionlabels="Yes|No">off</centerlogo>
|
||||
<centerlogofile type="imagefile" category="Images" width="7" title="Logo file (center)" parent="centerlogo">./files/logo.png</centerlogofile>
|
||||
<rightlogo type="buttons" category="Images" width="2" title="Display logo on the right of the header" options="on|off" optionlabels="Yes|No">off</rightlogo>
|
||||
<rightlogofile type="imagefile" category="Images" width="7" title="Logo file (right)" parent="rightlogo">./files/logo2.png</rightlogofile>
|
||||
<logotopmargin type="duration" category="Images" width="3" title="Distance from the logo to the top of the screen (use 0px to align a logo exactly with the very top)">15px</logotopmargin>
|
||||
<backgroundimage type="buttons" category="Images" width="4" title="Background image (behind body of page)" options="on|off" optionlabels="Yes|No">on</backgroundimage>
|
||||
<backgroundimagefixed type="buttons" category="Images" width="4" title="Background image fixed or scroll" options="fixed|scroll" optionlabels="Fixed|Scroll">scroll</backgroundimagefixed>
|
||||
<backgroundimagedisplay type="buttons" category="Images" width="4" title="Background image display" options="tile|cover" optionlabels="Tile|Cover">tile</backgroundimagedisplay>
|
||||
<backgroundimagefile type="imagefile" category="Images" width="12" title="Background image file" parent="backgroundimage">./files/tiledtexture.png</backgroundimagefile>
|
||||
<bodybackgroundcolor type="colorpicker" category="Images" width="8" title="Overall background color (when there is no picture in the background)" options="on|off" optionlabels="Yes|No">#dddddd</bodybackgroundcolor>
|
||||
|
||||
<!-- Questions
|
||||
HOUSE-STYLE: the colorpicker options in this section (question
|
||||
title/background/help/border/checkbox colors) are house-style colors.
|
||||
NOT house-style (structural, same for all variants): questionborder,
|
||||
questionborderstyle, the borderradius values, questiondropdown and
|
||||
questionhelptextposition. -->
|
||||
<!-- Questions -->
|
||||
<questiontitlebackgroundcolor type="colorpicker" category="Questions" width="6" title="Question title background color" options="on|off" optionlabels="Yes|No">#5e1c64</questiontitlebackgroundcolor>
|
||||
<questiontitlefontcolor type="colorpicker" category="Questions" width="6" title="Question title font color" options="on|off" optionlabels="Yes|No">#ffffff</questiontitlefontcolor>
|
||||
|
|
@ -96,8 +128,13 @@
|
|||
<!-- Progress -->
|
||||
<progressbarposition type="buttons" category="Progress" width="6" title="Position of the progress bar" options="under|in" optionlabels="Under header|In header">under</progressbarposition>
|
||||
|
||||
<!-- Various colors
|
||||
HOUSE-STYLE: ALL colorpickers in this section (header, navbar menu,
|
||||
primary, font, slider, progressbar, privacy) are house-style colors
|
||||
and are set per variant via variants/<client>.json -->
|
||||
<!-- Various colors -->
|
||||
<headerbackgroundcolor type="colorpicker" category="Colors" width="12" title="Header background color" options="on|off" optionlabels="Yes|No">#eeeeee</headerbackgroundcolor>
|
||||
<navbarfontcolor type="colorpicker" category="Colors" width="12" title="Menu item text color in the top bar (should contrast with the header background color)" options="on|off" optionlabels="Yes|No">#444444</navbarfontcolor>
|
||||
<primarycolor type="colorpicker" category="Colors" width="12" title="Primary color (for buttons)" options="on|off" optionlabels="Yes|No">#5e1c64</primarycolor>
|
||||
<fontcolor type="colorpicker" category="Colors" width="12" title="Base font color" options="on|off" optionlabels="Yes|No">#444444</fontcolor>
|
||||
<sliderhandlecolor type="colorpicker" category="Colors" width="12" title="Slider handle color" options="on|off" optionlabels="Yes|No">#5e1c64</sliderhandlecolor>
|
||||
|
|
@ -105,10 +142,44 @@
|
|||
<progressbarcolor type="colorpicker" category="Colors" width="12" title="Progress bar color" options="on|off" optionlabels="Yes|No">#5e1c64</progressbarcolor>
|
||||
<progressbarfontcolor type="colorpicker" category="Colors" width="12" title="Progress bar font color" options="on|off" optionlabels="Yes|No">#ffffff</progressbarfontcolor>
|
||||
<privacybackgroundcolor type="colorpicker" category="Colors" width="12" title="Privacy background color" options="on|off" optionlabels="Yes|No">lightyellow</privacybackgroundcolor>
|
||||
<!-- fonts
|
||||
HOUSE-STYLE: the whole Fonts section (font choice, fontsize and all
|
||||
font sizes/weights) is house-style specific.
|
||||
|
||||
PLACING A CUSTOM FONT - instructions:
|
||||
1. Put the font file (e.g. .woff2) in the files/fonts/ folder of
|
||||
the variant (or of this mother theme if all variants should be
|
||||
able to pick the font).
|
||||
2. Create a css file in the variant, e.g. css/variant.css, with the
|
||||
@font-face and the body class (the selected font is applied as
|
||||
class font-<value> on <body>):
|
||||
@font-face {
|
||||
font-family: 'My Custom Font';
|
||||
src: url('../files/fonts/my-custom-font.woff2') format('woff2');
|
||||
}
|
||||
body.font-my_custom_font {
|
||||
font-family: 'My Custom Font', Arial, sans-serif;
|
||||
}
|
||||
('../files/...' works because the asset manager copies the whole
|
||||
theme dir; in css of the mother theme likewise: ../files/fonts/...)
|
||||
3. Add to variants/<client>.json:
|
||||
"files_add": { "css": ["css/variant.css"], "js": [] },
|
||||
"fontOptions": [ { "value": "my_custom_font",
|
||||
"label": "My Custom Font" } ]
|
||||
build.php appends the css to the <files> list and the font to the
|
||||
"Custom (this theme)" optgroup below. data-font-package stays
|
||||
"websafe": LimeSurvey only knows core font packages
|
||||
(application/config/fonts.php); the actual font is loaded via
|
||||
the variant's own css.
|
||||
4. Run: php variants/build.php <client> and upload/reset the theme.
|
||||
See also README.md ("Custom fonts per variant"). -->
|
||||
<!-- fonts -->
|
||||
<!-- When adding new items, please keep fonts ordered alphabetically -->
|
||||
<font type="dropdown" category="Fonts" width="4" title="Fonts" parent="font">opensans
|
||||
<dropdownoptions>
|
||||
<!-- Custom fonts of a variant are appended to the optgroup below by variants/build.php ("fontOptions" in the variant json) -->
|
||||
<optgroup label="Custom (this theme)">
|
||||
</optgroup>
|
||||
<optgroup label="User browser">
|
||||
<option class="font-arial " value="arial" data-font-package="websafe">Arial</option>
|
||||
<option class="font-arial_black " value="arial_black" data-font-package="websafe">Arial Black</option>
|
||||
|
|
|
|||
|
|
@ -26,7 +26,6 @@
|
|||
{% set fontOptions = '' %}
|
||||
|
||||
{% set brandlogofileOptions , brandlogofileInheritFilename, brandlogofileInheritPreview = '', '', '' %}
|
||||
{% set secondlogofileOptions , secondlogofileInheritFilename, secondlogofileInheritPreview = '', '', '' %}
|
||||
|
||||
{# For surveyspecific settings add an inherit option #}
|
||||
{% if templateConfiguration.sid is not empty or templateConfiguration.gsid is not empty %}
|
||||
|
|
|
|||
|
|
@ -2,3 +2,18 @@
|
|||
@use 'surveys-list'
|
||||
@use 'progress'
|
||||
@use 'extras'
|
||||
|
||||
/* Header: left, center and right logo in the navbar */
|
||||
#survey-nav .container-fluid,
|
||||
#survey-nav .container
|
||||
position: relative
|
||||
|
||||
#survey-nav .logo-center
|
||||
position: absolute
|
||||
left: 50%
|
||||
top: 50%
|
||||
transform: translate(-50%, -50%)
|
||||
float: none
|
||||
|
||||
#survey-nav .logo-right
|
||||
margin-left: 15px
|
||||
226
variants/build.php
Normal file
226
variants/build.php
Normal file
|
|
@ -0,0 +1,226 @@
|
|||
<?php
|
||||
/**
|
||||
* Build a thin client variant of this theme (respondage_vanilla).
|
||||
*
|
||||
* A variant is a separate LimeSurvey theme that extends this mother theme
|
||||
* (<extends> in its config.xml). LimeSurvey then inherits ALL files
|
||||
* (views, css, js, images, options page) from the mother theme, so any
|
||||
* change made here in a file automatically applies to every variant.
|
||||
*
|
||||
* Only config.xml is generated per variant: it is a copy of this mother
|
||||
* config.xml in which ONLY the house-style option values (colors, fonts,
|
||||
* font sizes/colors/weights, logo files) listed in variants/<name>.json
|
||||
* are replaced, plus the metadata (name/title/description/extends).
|
||||
* The <engine> section is emptied except <optionspage>, so engine settings
|
||||
* (css framework, packages, view/files directories, template editor) are
|
||||
* inherited from the mother. The <files> section is kept as-is: LimeSurvey
|
||||
* resolves each listed file in the variant first and then in the mother,
|
||||
* so the mother's css/js keep loading until the variant ships its own file
|
||||
* with the same name (which then replaces the mother's file). This mirrors
|
||||
* what LimeSurvey itself does when you "extend" a theme in the theme editor.
|
||||
*
|
||||
* Usage:
|
||||
* php variants/build.php <variantName> [definitions-dir]
|
||||
*
|
||||
* The definitions (variants/<variantName>.json) contain confidential client
|
||||
* house-style values and are NOT kept in this (public) repository - see
|
||||
* .gitignore. Store them in the private variants repository or locally, and
|
||||
* point this script at that folder via the optional second argument or the
|
||||
* RESPONDAGE_VARIANTS_DIR environment variable.
|
||||
*
|
||||
* Example:
|
||||
* php variants/build.php <client> /path/to/private-variants
|
||||
*
|
||||
* Optional keys in the variant json:
|
||||
* "files_add": {"css": ["css/variant.css"], "js": []} extra files shipped by the
|
||||
* variant, appended to the <files> list of the generated config.xml
|
||||
* "fontOptions": [{"value": "my_custom_font", "label": "My Custom Font"}] custom fonts,
|
||||
* appended to the "Custom (this theme)" optgroup of the font dropdown
|
||||
*
|
||||
* Output:
|
||||
* ../<variantName>/config.xml (next to this theme, in upload/themes/survey)
|
||||
*
|
||||
* After running this script, upload the variant folder to
|
||||
* upload/themes/survey/ and (re)install or reset the theme in LimeSurvey
|
||||
* (Theme options -> reset), so the new config.xml is imported into the DB.
|
||||
*
|
||||
* If an option key in the json no longer exists in the mother config.xml,
|
||||
* the script fails loudly, so drift between mother and variant is caught
|
||||
* at build time instead of silently rendering wrong values.
|
||||
*/
|
||||
|
||||
if (PHP_SAPI !== 'cli') {
|
||||
fwrite(STDERR, "This script must be run from the command line.\n");
|
||||
exit(1);
|
||||
}
|
||||
|
||||
$variantName = isset($argv[1]) ? trim($argv[1]) : '';
|
||||
if ($variantName === '' || !preg_match('/^[a-z0-9_]+$/i', $variantName)) {
|
||||
fwrite(STDERR, "Usage: php variants/build.php <variantName> [definitions-dir]\n");
|
||||
fwrite(STDERR, " <variantName> must match an existing <definitions-dir>/<variantName>.json file.\n");
|
||||
fwrite(STDERR, " Default definitions-dir: the variants/ folder next to this script, or RESPONDAGE_VARIANTS_DIR.\n");
|
||||
exit(1);
|
||||
}
|
||||
|
||||
$motherDir = dirname(__DIR__); // .../themes/survey/respondage_vanilla
|
||||
$themesDir = dirname($motherDir); // .../themes/survey
|
||||
$motherConfig = $motherDir . DIRECTORY_SEPARATOR . 'config.xml';
|
||||
$definitionsDir = $argv[2] ?? (getenv('RESPONDAGE_VARIANTS_DIR') ?: __DIR__);
|
||||
$definitionFile = rtrim($definitionsDir, '/\\') . DIRECTORY_SEPARATOR . $variantName . '.json';
|
||||
|
||||
foreach ([$motherConfig, $definitionFile] as $f) {
|
||||
if (!is_file($f)) {
|
||||
fwrite(STDERR, "Required file not found: $f\n");
|
||||
exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
$definition = json_decode(file_get_contents($definitionFile), true);
|
||||
if (!is_array($definition)) {
|
||||
fwrite(STDERR, "Invalid JSON in $definitionFile\n");
|
||||
exit(1);
|
||||
}
|
||||
|
||||
$doc = new DOMDocument();
|
||||
$doc->preserveWhiteSpace = false;
|
||||
$doc->formatOutput = true;
|
||||
if (!$doc->load($motherConfig)) {
|
||||
fwrite(STDERR, "Could not parse mother config: $motherConfig\n");
|
||||
exit(1);
|
||||
}
|
||||
$xpath = new DOMXPath($doc);
|
||||
|
||||
$motherName = (string) $xpath->query('//metadata/name')->item(0)->textContent;
|
||||
|
||||
// --- metadata: identify the variant, point extends to the mother theme ---
|
||||
function setMetadata(DOMXPath $xpath, DOMDocument $doc, string $tag, string $value): void
|
||||
{
|
||||
$node = $xpath->query("//metadata/$tag")->item(0);
|
||||
if ($node === null) {
|
||||
$node = $doc->createElement($tag);
|
||||
$xpath->query('//metadata')->item(0)->appendChild($node);
|
||||
}
|
||||
$node->textContent = $value;
|
||||
}
|
||||
|
||||
setMetadata($xpath, $doc, 'name', $definition['name'] ?? $variantName);
|
||||
setMetadata($xpath, $doc, 'title', $definition['title'] ?? ucfirst($variantName));
|
||||
if (isset($definition['description'])) {
|
||||
setMetadata($xpath, $doc, 'description', $definition['description']);
|
||||
}
|
||||
setMetadata($xpath, $doc, 'extends', $motherName);
|
||||
setMetadata($xpath, $doc, 'lastUpdate', date('Y-m-d H:i:s'));
|
||||
|
||||
// --- empty the <engine> section except <optionspage>: inherited from the mother ---
|
||||
// (same as TemplateManifest::deleteEngineInDom() does when extending a theme in LimeSurvey)
|
||||
$engineNode = $xpath->query('//engine')->item(0);
|
||||
if ($engineNode !== null) {
|
||||
foreach (iterator_to_array($engineNode->childNodes) as $child) {
|
||||
if ($child instanceof DOMElement && $child->nodeName !== 'optionspage') {
|
||||
$engineNode->removeChild($child);
|
||||
} elseif ($child instanceof DOMComment) {
|
||||
$engineNode->removeChild($child);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// --- extra files shipped by the variant itself ---
|
||||
// In the variant json: "files_add": {"css": ["css/variant.css"], "js": []}
|
||||
// They are appended to the <files> list. The mother's files keep loading until the
|
||||
// variant ships a file with the same name; from that moment it replaces the mother's
|
||||
// file (LimeSurvey "add" also means "replace" for identical paths).
|
||||
if (!empty($definition['files_add'])) {
|
||||
$filesNode = $xpath->query('//files')->item(0);
|
||||
if ($filesNode === null) {
|
||||
fwrite(STDERR, "No <files> section found in mother config\n");
|
||||
exit(1);
|
||||
}
|
||||
foreach (['css', 'js', 'print_css'] as $type) {
|
||||
$values = $definition['files_add'][$type] ?? [];
|
||||
if (empty($values)) {
|
||||
continue;
|
||||
}
|
||||
$typeNode = $xpath->query('//files/' . $type)->item(0);
|
||||
if ($typeNode === null) {
|
||||
$typeNode = $doc->createElement($type);
|
||||
$filesNode->appendChild($typeNode);
|
||||
}
|
||||
foreach ((array) $values as $file) {
|
||||
$add = $doc->createElement('add');
|
||||
$add->appendChild($doc->createTextNode((string) $file));
|
||||
$typeNode->appendChild($add);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// --- custom fonts of the variant, added to the font dropdown ---
|
||||
// In the variant json: "fontOptions": [{"value": "my_custom_font", "label": "My Custom Font"}]
|
||||
// The font files themselves live in the variant's files/fonts/ and the @font-face +
|
||||
// body.font-<value> rule in a css file shipped by the variant (see files_add, e.g.
|
||||
// css/variant.css with src: url('../files/fonts/my-custom-font.woff2')).
|
||||
// data-font-package stays "websafe": LimeSurvey only knows the core font packages
|
||||
// (application/config/fonts.php), and "websafe" is the neutral one, so no missing
|
||||
// package is requested. The real font is loaded by the variant's own css.
|
||||
if (!empty($definition['fontOptions'])) {
|
||||
$optgroup = $xpath->query('//options/font/dropdownoptions/optgroup[@label="Custom (this theme)"]')->item(0);
|
||||
if ($optgroup === null) {
|
||||
fwrite(STDERR, "No <optgroup label=\"Custom (this theme)\"> found in the font dropdown of the mother config.xml\n");
|
||||
exit(1);
|
||||
}
|
||||
foreach ((array) $definition['fontOptions'] as $font) {
|
||||
if (empty($font['value']) || empty($font['label'])) {
|
||||
fwrite(STDERR, "Each entry in 'fontOptions' needs 'value' and 'label'\n");
|
||||
exit(1);
|
||||
}
|
||||
$value = preg_replace('/[^a-z0-9_]/i', '_', (string) $font['value']);
|
||||
$option = $doc->createElement('option');
|
||||
$option->setAttribute('class', 'font-' . $value);
|
||||
$option->setAttribute('value', $value);
|
||||
$option->setAttribute('data-font-package', 'websafe');
|
||||
$option->appendChild($doc->createTextNode((string) $font['label']));
|
||||
$optgroup->appendChild($option);
|
||||
}
|
||||
}
|
||||
|
||||
// --- options: replace only the house-style values listed in the json ---
|
||||
if (!empty($definition['options']) && !is_array($definition['options'])) {
|
||||
fwrite(STDERR, "'options' in $definitionFile must be an object of optionName => value\n");
|
||||
exit(1);
|
||||
}
|
||||
$optionsNode = $xpath->query('//options')->item(0);
|
||||
if ($optionsNode === null) {
|
||||
fwrite(STDERR, "No <options> section found in mother config\n");
|
||||
exit(1);
|
||||
}
|
||||
foreach (($definition['options'] ?? []) as $key => $value) {
|
||||
$matches = $xpath->query('//options/' . $key);
|
||||
if ($matches->length === 0) {
|
||||
fwrite(STDERR, "Option '$key' from $definitionFile does not exist in the mother config.xml.\n");
|
||||
fwrite(STDERR, "Remove it from the json or rename it there; the mother theme changed.\n");
|
||||
exit(1);
|
||||
}
|
||||
$option = $matches->item(0);
|
||||
// Replace only the text value, keep child elements (e.g. <dropdownoptions> of the font option)
|
||||
foreach (iterator_to_array($option->childNodes) as $child) {
|
||||
if ($child instanceof DOMText) {
|
||||
$option->removeChild($child);
|
||||
}
|
||||
}
|
||||
$option->insertBefore($doc->createTextNode((string) $value), $option->firstChild);
|
||||
}
|
||||
|
||||
// --- write the variant config ---
|
||||
$variantDir = $themesDir . DIRECTORY_SEPARATOR . $variantName;
|
||||
if (!is_dir($variantDir) && !mkdir($variantDir, 0775, true)) {
|
||||
fwrite(STDERR, "Could not create directory: $variantDir\n");
|
||||
exit(1);
|
||||
}
|
||||
if (!is_dir($variantDir . DIRECTORY_SEPARATOR . 'files')) {
|
||||
mkdir($variantDir . DIRECTORY_SEPARATOR . 'files', 0775, true);
|
||||
}
|
||||
$out = $variantDir . DIRECTORY_SEPARATOR . 'config.xml';
|
||||
$doc->save($out);
|
||||
|
||||
echo "Variant '$variantName' built: $out\n";
|
||||
echo 'Options overridden: ' . (empty($definition['options']) ? '(none)' : implode(', ', array_keys($definition['options']))) . "\n";
|
||||
echo "Remember: upload the folder to upload/themes/survey/ and reset the theme in LimeSurvey.\n";
|
||||
53
variants/export_public.sh
Normal file
53
variants/export_public.sh
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
#!/usr/bin/env bash
|
||||
#
|
||||
# Build a PUBLIC release of the mother theme (respondage_vanilla) only.
|
||||
#
|
||||
# Client data (variant definitions variants/*.json, generated client theme
|
||||
# folders, git branches containing a client theme) must NEVER be published.
|
||||
# This script therefore:
|
||||
# 1. copies the theme WITHOUT .git, WITHOUT variants/*.json (only the
|
||||
# generic build.php and export script are kept) and without old exports;
|
||||
# 2. scans the staged copy for client-identifying strings and ABORTS if any
|
||||
# are found;
|
||||
# 3. creates a zip next to the folder.
|
||||
#
|
||||
# Usage:
|
||||
# bash variants/export_public.sh [output-dir]
|
||||
#
|
||||
# Default output dir: <limesurvey-root>/dist (deliberately NOT inside
|
||||
# upload/themes/survey/, because every folder there is scanned as a theme).
|
||||
#
|
||||
set -euo pipefail
|
||||
|
||||
THEME_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
SITE_ROOT="$(cd "$THEME_DIR/../../../.." && pwd)"
|
||||
OUT_DIR="${1:-$SITE_ROOT/dist}"
|
||||
STAGE="$OUT_DIR/respondage_vanilla"
|
||||
VERSION="$(sed -n 's:.*<version>\([^<]*\)</version>.*:\1:p' "$THEME_DIR/config.xml" | head -1)"
|
||||
ZIP_NAME="respondage_vanilla-${VERSION}-public.zip"
|
||||
|
||||
rm -rf "$STAGE"
|
||||
mkdir -p "$STAGE" "$OUT_DIR"
|
||||
|
||||
# 1. copy the theme, excluding .git, client variant definitions, the internal
|
||||
# variants README and old exports (the generic build/export scripts are kept)
|
||||
(cd "$THEME_DIR" && tar --exclude='./.git' --exclude='./dist' --exclude='./variants/*.json' --exclude='./variants/README.internal.md' -cf - .) | (cd "$STAGE" && tar -xf -)
|
||||
|
||||
# 2. leak check: no client-identifying strings may remain (text files only).
|
||||
# The bracket trick keeps this script from matching its own pattern.
|
||||
if grep -rIlE 'eras[m]us|defen[s]ie|rijk[s]logo' "$STAGE"; then
|
||||
echo "ERROR: client-identifying strings found in the public export - aborting, staging removed." >&2
|
||||
rm -rf "$STAGE"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# 3. zip it
|
||||
(cd "$OUT_DIR" && rm -f "$ZIP_NAME" && zip -qr "$ZIP_NAME" respondage_vanilla)
|
||||
|
||||
echo "Public release created:"
|
||||
echo " folder: $STAGE"
|
||||
echo " zip: $OUT_DIR/$ZIP_NAME"
|
||||
echo
|
||||
echo "Publish ONLY this artifact (or the main branch of this repo)."
|
||||
echo "NEVER publish variants/*.json, generated client theme folders, or a git"
|
||||
echo "branch that contains a client theme - client names, colors and logos are confidential."
|
||||
|
|
@ -145,8 +145,21 @@
|
|||
background-color: {{ aSurveyInfo.options.headerbackgroundcolor }};
|
||||
}
|
||||
|
||||
.navbar-default .navbar-nav > li > a:hover {
|
||||
color: {{ aSurveyInfo.options.fontcolor }};
|
||||
#survey-nav .logo-container > img {
|
||||
padding-top: {{ aSurveyInfo.options.logotopmargin }};
|
||||
}
|
||||
|
||||
#survey-nav .navbar-nav > li > a,
|
||||
#survey-nav .navbar-nav .nav-link {
|
||||
color: {{ aSurveyInfo.options.navbarfontcolor }};
|
||||
}
|
||||
|
||||
#survey-nav .navbar-nav > li > a:hover,
|
||||
#survey-nav .navbar-nav > li > a:focus,
|
||||
#survey-nav .navbar-nav .nav-link:hover,
|
||||
#survey-nav .navbar-nav .nav-link:focus {
|
||||
color: {{ aSurveyInfo.options.navbarfontcolor }};
|
||||
opacity: 0.75;
|
||||
}
|
||||
|
||||
.progress {
|
||||
|
|
|
|||
|
|
@ -28,8 +28,9 @@ For the survey navigator ("Next", "Back", etc.), see: navigation/navigator.twig
|
|||
or (aSurveyInfo.aQuestionIndex.bShow == true and aSurveyInfo.format != 'A')
|
||||
or (aSurveyInfo.alanguageChanger.show)
|
||||
%}
|
||||
{% set showRightLogo = (aSurveyInfo.options.rightlogo == "on" and imageSrc(aSurveyInfo.options.rightlogofile)) %}
|
||||
<div id="survey-nav" class="navbar {{ navClass }} navbar-expand-md fixed-top border-bottom pt-0 pb-0">
|
||||
<div class="container-fluid">
|
||||
<div class="container-fluid d-flex align-items-center">
|
||||
{% if ShowMenu %}
|
||||
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar"
|
||||
aria-controls="small-screens-menus" aria-expanded="false">
|
||||
|
|
@ -37,24 +38,25 @@ For the survey navigator ("Next", "Back", etc.), see: navigation/navigator.twig
|
|||
<span class="navbar-toggler-icon" aria-hidden="true"></span>
|
||||
</button>
|
||||
{% endif %}
|
||||
{# Logo option #}
|
||||
{% if( aSurveyInfo.options.brandlogo == "on") %}
|
||||
<div class="navbar-brand logo-container d-none d-md-block">
|
||||
{# Left logo #}
|
||||
{% if( aSurveyInfo.options.brandlogo == "on" and imageSrc(aSurveyInfo.options.brandlogofile)) %}
|
||||
<div class="navbar-brand logo-container logo-left d-none d-md-block">
|
||||
{{ image(aSurveyInfo.options.brandlogofile, aSurveyInfo.name, {"class": "logo img-fluid"}) }}
|
||||
</div>
|
||||
{% else %}
|
||||
<div class="navbar-brand">
|
||||
<div class="navbar-brand logo-left">
|
||||
{{ aSurveyInfo.name }}
|
||||
</div>
|
||||
{% endif %}
|
||||
{% if( aSurveyInfo.options.secondlogo == "on") %}
|
||||
<div class="navbar-brand logo-container d-none d-md-block">
|
||||
{{ image(aSurveyInfo.options.secondlogofile, aSurveyInfo.name, {"class": "logo img-fluid"}) }}
|
||||
{# Center logo (absolutely centered via CSS, see sass/plain.sass) #}
|
||||
{% if( aSurveyInfo.options.centerlogo == "on" and imageSrc(aSurveyInfo.options.centerlogofile)) %}
|
||||
<div class="navbar-brand logo-container logo-center d-none d-md-block">
|
||||
{{ image(aSurveyInfo.options.centerlogofile, aSurveyInfo.name, {"class": "logo img-fluid"}) }}
|
||||
</div>
|
||||
{% endif %}
|
||||
{% if ShowMenu %}
|
||||
<div id="navbar" class="collapse navbar-collapse navbar-nav-scroll pt-2">
|
||||
<ul class="nav navbar-nav navbar-action-link navbar-right ms-auto">
|
||||
<div id="navbar" class="collapse navbar-collapse navbar-nav-scroll pt-2 {{ showRightLogo ? "" : "ms-auto" }}">
|
||||
<ul class="nav navbar-nav navbar-action-link navbar-right">
|
||||
{{ include('./subviews/navigation/save_links.twig') }}
|
||||
{{ include('./subviews/navigation/clearall_links.twig') }}
|
||||
{{ include('./subviews/navigation/question_index_menu.twig') }}
|
||||
|
|
@ -62,6 +64,12 @@ For the survey navigator ("Next", "Back", etc.), see: navigation/navigator.twig
|
|||
</ul>
|
||||
</div>
|
||||
{% endif %}
|
||||
{# Right logo #}
|
||||
{% if showRightLogo %}
|
||||
<div class="navbar-brand logo-container logo-right d-none d-md-block ms-auto">
|
||||
{{ image(aSurveyInfo.options.rightlogofile, aSurveyInfo.name, {"class": "logo img-fluid"}) }}
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
|
|
|
|||
Loading…
Reference in a new issue