docs: document conventions in config.xml (HOUSE-STYLE markers, LF line endings)

- HOUSE-STYLE convention block above <options> and per-section markers
  (Images/Questions/Colors/Fonts) make clear which options are house-style
  specific and belong in variants/<client>.json only - never hardcoded in
  shared views/sass/css/js files.
- Header comment documents the LF-only line-ending rule (enforced by
  .gitattributes).

Generated by Mistral Vibe.
Co-Authored-By: Mistral Vibe <vibe@mistral.ai>
This commit is contained in:
Tammo ter Hark 2026-11-16 19:51:19 +01:00
commit 7677aefc14

View file

@ -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. -->
@ -59,6 +64,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,6 +85,9 @@
<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 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>
@ -80,6 +102,12 @@
<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>
@ -99,7 +127,11 @@
<!-- 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 -->
<!-- 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>