Actions

New Template System in LS3.x/nl: Difference between revisions

From LimeSurvey Manual

No edit summary
No edit summary
 
(122 intermediate revisions by 3 users not shown)
Line 3: Line 3:
__TOC__
__TOC__
=Inleiding=
=Inleiding=
NB: In eerder versies van LimeSurvey noemden we de bestanden die definieerden hoe de enquête eruit zag, dus de kleuren, lettertypes, lay-out en het gedrag een template/sjabloon. Naar nieuwe inzichten noemen we dit nu een "thema". Template/sjabloon is gereserveerd voor voorbeeld enquêtes.


Op deze pagina leggen we uit hoe je:
Op deze pagina leggen we uit hoe je:


* gebruik maakt van het nieuwe thema-systeem van LimeSurvey 3.0
* gebruik maakt van het nieuwe thema-systeem in LimeSurvey 3.0
* gebruik maakt van overerving (inheritance) bij je eigen thema's
* gebruik maakt van overerving (inheritance) bij je eigen thema's
* een afbeelding toevoegt
* een afbeelding toevoegt
Line 13: Line 15:
<hr/>
<hr/>


In LimeSurvey 3 is er een geheel nieuw thema-systeem, gebaseerd op Twig 1.29, Bootstrap, waarin overerving van thema's en bijbehorende opties mogelijk zijn.  Het oude systeem met keywords is vervangen, 100% van de front-end HTML kan nu aangepast worden. Vroeger was er een keyword {ASSESSMENTS} dat vervangen werd door een stukje HTML op het moment van uitvoering. Een ontwikkelaar kon dit alleen aanpassen met JavaScript. Nu is er een bestand '''assessments.twig''' met de logica  (geschreven in Twig) om de HTML aan te maken. Op deze pagina beschrijven we hoe je dit systeem kunt gebruiken.
In LimeSurvey 3 is er een geheel nieuw thema-systeem, gebaseerd op Twig 1.29, Bootstrap, waarin overerving van thema's en bijbehorende opties mogelijk is.  Het oude systeem met keywords is vervangen, Alle HTML van de front-end kan nu aangepast worden. Vroeger was er een keyword {ASSESSMENTS} dat vervangen werd door een stukje HTML op het moment van uitvoering. Een ontwikkelaar kon dit alleen aanpassen met JavaScript. Nu is er een bestand '''assessments.twig''' met de logica  (geschreven in Twig) om de HTML aan te maken. Op deze pagina beschrijven we hoe je dit systeem kunt gebruiken.


<div class="simplebox">[[File:help.png]]  We geven geen uitgebreide beschrijving hoe Twig werkt. Het is een eenvoudige constructie in PHP die een goede beveiliging biedt dankzij het “sandbox” systeem (dat zien we later uitgebreider terug als het over de core-code hebben). Het gebruik is eenvoudig, zeker als je wat kennis van PHP hebt. Hier is de documentatie van Twig 1.X:
<div class="simplebox">[[File:help.png]]  We geven geen uitgebreide beschrijving hoe Twig werkt. Het is een eenvoudige constructie in PHP die een goede beveiliging biedt dankzij het “sandbox” systeem (dat zien we later uitgebreider terug als het over de core-code hebben). Het gebruik is eenvoudig, zeker als je wat kennis van PHP hebt. Documentatie van Twig 1.X:
https://twig.symfony.com/ </div>
https://twig.symfony.com/ </div>


Line 24: Line 26:
<br />
<br />
De lijst heeft 5 kolommen:
De lijst heeft 5 kolommen:
* een voorvertoning van het thema:  dit is alleen het plaatje “preview.png” in de rootmap van het thema
* Een voorvertoning van het thema:  dit is alleen het plaatje. “preview.png” in de rootmap van het thema.
* de titel van het thema zoals aangegeven in het manifest (config.xml in de rootmap van het thema)
* De titel van het thema zoals aangegeven in het manifest (config.xml in de rootmap van het thema).
* een beschrijving: een tekst in het manifest
* Een beschrijving: een tekst in het manifest.
* type thema: Core (aangeleverd bij LimeSurvey), User (toegevoegd in map upload), XML (niet geladen in de database)
* Type thema: Core (aangeleverd bij LimeSurvey), User (toegevoegd in map upload), XML (niet geladen in de database).
* Extends: indien het een uitbreiding is van een ander thema, de naam van dat thema
* Extends: indien het een uitbreiding is van een ander thema, de naam van dat thema.
* Enkele knoppen voor acties
* Enkele knoppen voor acties:
** Installatie: Het laad het manifest van een thema om het toe te voegen aan de database zodat het beschikbaar voor selectie bij een enquête
** Installatie: Het laad het manifest van een thema om het toe te voegen aan de database zodat het beschikbaar voor selectie bij een enquête.
** Verwijderen: de registratie van het thema in de database wordt verwijderd
** Verwijderen: de registratie van het thema in de database wordt verwijderd.
** Sjablooneditor: link naar de thema-editor
** Thema-editor: link naar de thema-editor.
** Sjabloon-opties: link naar de globale configuratie van de bijbehorende opties
** Thema-opties: link naar de globale configuratie van de bijbehorende opties.


==Thema-editor==
==Thema-editor==
<div class="simplebox">[[File:help.png]] Hier gaan we ervan uit dat je het gebruik van het oude systeem nog kent.</div>
<div class="simplebox">[[File:help.png]] Hier gaan we ervan uit dat je het gebruik van het oude systeem kent.</div>
<br>
<br>
De editor is zo veel als mogelijk gelijk gebleven. Als je een standaardthema opent, dan kun je het wijzigen. Er is nu echter geen knop ''kopieer'' maar een knop ''uitbreiden'' (extend).
De editor is zo veel als mogelijk gelijk gebleven. Als je een standaardthema opent, dan kun je het wijzigen. Er is nu geen knop ''kopieer'' maar een knop ''uitbreiden'' (extend).
<br>
<br>
[[File:Extends default.png|center|baseline|border|''Nu spreken we van het '''uitbreiden''' van een thema'']]
[[File:Extends default.png|center|baseline|border|''Nu spreken we van het '''uitbreiden''' van een thema'']]


====Overerving (inheritance)====
====Overerving ( inheritance )====


In versie 3, kan een thema overerven van een ander thema, het is een uitbreiding van een ander thema. Dit betekent dat de thema-map bijna leeg is, het bevat alleen de bestanden (views, stylesheets, scripts, resources enz.) die anders zijn dan het origineel. Hierdoor kun je snel veel thema's maken voor je verschillende gebruikers zonder veel werk te krijgen aan het onderhoud van veel thema's. Je kunt een eigen thema maken en daar dan per bedrijf een variant van maken (met een ander logo, style, misschien een link naar een website in de footer enz.). Als je dan de CSS of de globale lay-out van je eigen basisthema wijzigt, dan worden alle wijzigingen geërft door de bedrijfsthema's. Je kunt onbeperkt overerven, een onderdeel van een bedrijf kan een eigen thema hebben en dan kan het bedrijfsthema  weer de basis voor het onderdeel zijn.
In versie 3 kan een thema overerven van een ander thema, het is een uitbreiding van een ander thema. Dit betekent dat de thema-map bijna leeg is, het bevat alleen de bestanden (views, stylesheets, scripts, resources enz.) die anders zijn dan het origineel. Hierdoor kun je snel veel thema's maken voor je verschillende gebruikers zonder veel werk te krijgen aan het onderhoud van veel thema's. Je kunt een eigen thema maken en daar dan per bedrijf een variant van maken (met een ander logo, style, misschien een link naar een website in de footer enz.). Als je dan de CSS of de globale lay-out van je eigen basisthema wijzigt, dan worden alle wijzigingen geërft door de bedrijfsthema's. Je kunt onbeperkt overerven, een onderdeel van een bedrijf kan een eigen thema hebben en dan kan het bedrijfsthema  weer de basis voor het onderdeel zijn.


<div class="simplebox">[[File:help.png]] Je kunt ook een eigen thema maken door een standaardthema uit te breiden. Dan zou een update van het standaardthema geen problemen moeten geven.</div>
<div class="simplebox">[[File:help.png]] Je kunt ook een eigen thema maken door een standaardthema uit te breiden. Dan zou een update van het standaardthema geen problemen moeten geven. </div>


====Toevoegingen aan de gebruikersinterface====
====Toevoegingen aan de gebruikersinterface====
Line 59: Line 61:
<div class="simplebox">[[File:help.png]] De bronnen (jpg, png enz.) van het originele thema worden bij het uitbreiden gekopieerd. Dit moet omdat als je een CSS-bestand kopieert en er zijn referenties (bijvoorbeeld bij een background-image) dan moeten die in het huidige thema-pad te vinden zijn.</div>
<div class="simplebox">[[File:help.png]] De bronnen (jpg, png enz.) van het originele thema worden bij het uitbreiden gekopieerd. Dit moet omdat als je een CSS-bestand kopieert en er zijn referenties (bijvoorbeeld bij een background-image) dan moeten die in het huidige thema-pad te vinden zijn.</div>


De thema-editor voor het thema extends_monochrome ziet er uit als:
De thema-editor ziet er voor het thema extends_monochrome uit als:
[[File:Editing extends monochrome.jpg|center|baseline|border|'' Wijzigen thema extends_monochrome'']]
[[File:Editing extends monochrome.jpg|center|baseline|border|'' Wijzigen thema extends_monochrome'']]
<br /><br />
<br /><br />
Line 81: Line 83:
====Voorbeeld: toevoegen van een afbeelding====
====Voorbeeld: toevoegen van een afbeelding====


De knop '''Kopieer naar lokaal sjabloon en wijzigingen opslaan''' doet wat het zegt. Als je iets in het bestand wijzigt dan wordt de wijziging in dat bestand opgeslagen.
De knop '''Kopieer naar lokaal thema en wijzigingen opslaan''' doet wat het zegt. Als je iets in het bestand wijzigt dan wordt de wijziging in dat bestand opgeslagen.
<br>
<br>
Als je klikt op het bestand layout_global.twig, en net voor de regel met ''{% block content %}'''' de tekst “TEST” toevoegt en dan op de knop tikt, dan zie je dat het keyword bij dit bestand is gewijzigd van “inherited” in “local”, de knoptekst is nu ook weer '''Bewaar wijzigingen'''.  
Als je klikt op het bestand layout_global.twig en daarin net voor de regel met ''{% block content %}'' de tekst “TEST” toevoegt en dan op de knop tikt, zie je dat het keyword bij dit bestand is gewijzigd van “inherited” in “local”, de knoptekst is nu ook weer '''Bewaar wijzigingen'''.  
[[File:After edition.png|center|''net na het klikken op de knop'']]
[[File:After edition.png|center|''net na het klikken op de knop'']]
<br>
<br>
Als je naar de map upload/templates/extends_monochrome/views/, gaat, dan zie je dat daar maar een bestand in staat, het bestand  layout_global.twig met de tekst “TEST”.
Als je naar de map upload/themas/extends_monochrome/views/ gaat, dan zie je dat daar maar een bestand in staat, het bestand  layout_global.twig met de tekst “TEST”.
[[File:Tree with layout global arrow.png|center|''Het bestand is aanwezig in je sjabloon'']]
[[File:Tree with layout global arrow.png|center|''Het bestand is aanwezig in je thema'']]
<br><br>
<br><br>
We voegen nu een afbeelding toe in plaats van een tekst.  Klik op de link ''tip'':
We voegen nu een afbeelding toe in plaats van een tekst.  Klik op de link ''tip'':
Line 94: Line 96:
'''{{ image('./files/myfile.png', 'alt-text for my file', {"class": "myclass"}) }}'''
'''{{ image('./files/myfile.png', 'alt-text for my file', {"class": "myclass"}) }}'''
<br>
<br>
Je hebt natuurlijk de Twig-documentatie al eens een keer gelezen en je weet dan ook dat bij '''&#123;&#123; }}<nowiki />''' de inhoud tussen de haakjes, dus hier het resultaat van de function image( ) op het scherm wordt getoond.  
Je hebt natuurlijk de Twig-documentatie al eens gelezen en je weet dan ook dat bij '''&#123;&#123; }}<nowiki />''' de inhoud tussen de haakjes, dus hier het resultaat van de function image( ) op het scherm wordt getoond.  


<div class="simplebox">[[File:help.png]]  Als je de code eens een keer wilt zien, die staat hier: [https://github.com/LimeSurvey/LimeSurvey/blob/f3737a75e428f604d68d2e5ba958f3eba3eba2e1/application/core/LS_Twig_Extension.php#L219-L237 versie RC3]
<div class="simplebox">[[File:help.png]]  Als je de code eens een keer wilt zien: [https://github.com/LimeSurvey/LimeSurvey/blob/f3737a75e428f604d68d2e5ba958f3eba3eba2e1/application/core/LS_Twig_Extension.php#L219-L237 versie RC3]
Maar je hoeft alleen maar te weten hoe je het moet aanroepen.
Maar je hoeft alleen maar te weten hoe je het moet aanroepen.
</div>
</div>
<br>
<br>
De function image() wordt gebruik om:
De function image() wordt gebruik om:
* de afbeelding te vinden die in het sjabloon gebruikt wordt. De functie zoekt indien nodig ook in het sjabloon (meerdere niveaus mogelijk) waar het sjabloon van afstamt.
* de afbeelding te vinden die in het thema gebruikt wordt. De functie zoekt indien nodig ook in het thema (meerdere niveaus mogelijk) waar het thema van afstamt.
* dit gaat met gebruik van de ''asset-manager'' voor een betere performance van het sjabloon. Meer informatie hierover:  http://www.yiiframework.com/wiki/148/understanding-assets/
* dit gaat met gebruik van de ''asset-manager'' voor een betere performance van het thema. Meer informatie hierover:  http://www.yiiframework.com/wiki/148/understanding-assets/


<div class="simplebox">
<div class="simplebox">
Dus om een afbeelding in je sjabloon toe te voegen:
Dus om een afbeelding in je thema toe te voegen:
* eerst indien nodig een bestand uploaden en dan op de plek waar je het wilt hebben toevoegen in een twig-bestand met:
* indien nodig, eerst een bestand uploaden en dan op de plek waar je het wilt hebben toevoegen in een twig-bestand met:
'''&#123;&#123; image('./files/myfile.png') }}'''
'''&#123;&#123; image('./files/myfile.png') }}'''


Line 120: Line 122:
* Een knop om het lokale bestand te verwijderen en terug te keren naar de opdracht inherited.
* Een knop om het lokale bestand te verwijderen en terug te keren naar de opdracht inherited.
* Alleen de afbeeldingen in de CSS-bestanden laten kopiëren (door een lijst toe te voegen in het manifest)
* Alleen de afbeeldingen in de CSS-bestanden laten kopiëren (door een lijst toe te voegen in het manifest)
* Herinneren welke sjablonen het huidige als basis gebruiken  (indien die er zijn).
* Herinneren welke thema's het huidige als basis gebruiken  (indien die er zijn).


==Sjabloon opties==
==Thema-opties==
Ook nieuw in versie 3 is de pagina sjabloon optie. Iemand die een sjabloon maakt kan eigen opties maken en zelfs een eigen optie-pagina, dat lichten we later toe. Eerst laten we zien doe de optie-pagina bij de standaardsjablonen werkt. Klik op : “sjabloon opties” in de sjabloonlijst.
Ook nieuw in versie 3 is de pagina thema-optie. Iemand die een thema maakt kan eigen opties maken en zelfs een eigen optie-pagina, dat lichten we later toe. Eerst laten we zien doe de optie-pagina bij de standaardthema's werkt. Klik op : “thema-opties” in de thema-lijst.
===Geavanceerde opties===
===Geavanceerde opties===


Line 131: Line 133:
===Eenvoudige opties===
===Eenvoudige opties===


De pagina Eenvoudige opties krijg je bij het sjabloon zelf. Het wordt aangemaakt met een twig-bestand en wat JavaScript in de map template/options/ :  
De pagina Eenvoudige opties krijg je bij het thema zelf. Het wordt aangemaakt met een twig-bestand en wat JavaScript in de map themes/options/ :  
https://github.com/LimeSurvey/LimeSurvey/tree/develop/templates/default/options
https://github.com/LimeSurvey/LimeSurvey/tree/develop/templates/default/options
<div class="simplebox">[[File:help.png]] Deze pagina kan er bij een ander sjabloon heel anders uitzien, ook kan en zal elke sjabloonmaker een eigen stijl hebben wat betreft opmaak e.d. </div>
<div class="simplebox">[[File:help.png]] Deze pagina kan er bij een ander thema heel anders uitzien, ook zal elke maker van een thema een eigen stijl hebben wat betreft opmaak e.d. </div>


[[File:Options.png|thumb|750px|center]]
[[File:Options.png|thumb|750px|center]]
Line 143: Line 145:
&#123;"replace": &#91;&#91;"css/bootstrap.css","css/darkly.css"]]}
&#123;"replace": &#91;&#91;"css/bootstrap.css","css/darkly.css"]]}
<br>
<br>
De eenvoudige opties op een standaardsjabloon zijn:
De eenvoudige opties op een standaardthema zijn:
*'''Ajax mode:''' De volgende pagina laden via Ajax (sneller) of via herladen pagina (beter als je wilt debuggen)
*'''Ajax mode:''' De volgende pagina laden via Ajax (sneller) of via herladen pagina (beter als je wilt debuggen)
*'''Achtergrondplaatje:''' Indien Ja, het plaatje pattern.png dat wordt geladen (wordt later vervangen bij een bestandskeuze)
*'''Achtergrondplaatje:''' Indien Ja, het plaatje pattern.png dat wordt geladen (wordt later vervangen bij een bestandskeuze).
*'''Box container:''' Indien Nee, de vragen worden niet in een box getoond, je kunt dan vragen langer dan het scherm maken.
*'''Box container:''' Indien Nee, de vragen worden niet in een box getoond, je kunt dan vragen langer dan het scherm maken.
*'''Logo:''' Indien Nee, de naam van de enquête wordt getoond in de topregel, anders wordt er een (door je geselecteerde) afbeelding getoond
*'''Logo:''' Indien Nee, de naam van de enquête wordt getoond in de kopregel, anders wordt er een (door je geselecteerde) afbeelding getoond.
*'''Animeren body:''' Bij Ja kun je een animatie kiezen die gebruikt wordt bij het laden van de body van de enquête.
*'''Animeren body:''' Bij Ja kun je een animatie kiezen die gebruikt wordt bij het laden van de body van de enquête.
*'''Animeren vraag:''' als bij body
*'''Animeren vraag:''' als bij body.
*'''Animeren waarschuwing:''' als bij body
*'''Animeren waarschuwing:''' als bij body.
*'''Bootstrap thema:''' Het te laden Bootstrap thema, afkomstig van https://bootswatch.com/3/
*'''Bootstrap thema:''' Het te laden Bootstrap thema, afkomstig van https://bootswatch.com/3/
<br>
<br>
Line 156: Line 158:
Het animeren is optioneel en je kunt andere animaties gebruiken.
Het animeren is optioneel en je kunt andere animaties gebruiken.


<div class="simplebox">[[File:help.png]] Het sjabloon monochrome gebruikt dezelfde bootstrap kleur thema als de beheerders-interface. Ze gebruiken niet het CSS-framework vervangingssysteem, maar voegen eenvoudig een CSS-bestand toe. Dit is een andere manier om met aangepaste thema's om te gaan voor aanbieders van thema's.</div>
<div class="simplebox">[[File:help.png]] Het thema monochrome gebruikt dezelfde bootstrap kleurthema als de beheerders-interface. Ze gebruiken niet het CSS-framework vervangingssysteem, maar voegen eenvoudig een CSS-bestand toe. Dit is een alternatieve manier om met aangepaste thema's om te gaan voor aanbieders van thema's.</div>


===Inheritance===
===Inheritance===


Hiervoor hebben we gezien dat een sjabloon een ander sjabloon kan extenden. Dit kan ook voor de configuratie van het sjabloon. Je kunt dan voor het sjabloon een configuratie hebben op  
Hiervoor hebben we gezien dat een thema een ander thema kan extenden. Dit kan ook voor de configuratie van het thema. Je kunt dan voor het thema een configuratie hebben op  


* op globaal niveau (die hebben we net via de sjabloonlijst gezien)
* op globaal niveau (die hebben we net via de thema-lijst gezien)
* op enquête-groepsniveau
* op enquête-groepsniveau
* minstens 1 op enquête-niveau  
* minstens 1 op enquête-niveau  
Line 176: Line 178:
[[File:Surveygroupedit.png|thumb|800px|center|''Wijzigen standaard enquête-groep'']]
[[File:Surveygroupedit.png|thumb|800px|center|''Wijzigen standaard enquête-groep'']]
<br>
<br>
De derde tab op deze pagina is “Thema-opties bij deze enquête-groep”. Als je er op klikt krijg je dezelfde lijst met sjablonen als in de sjablonenlijst, er is nu maar één knop zichtbaar (de sjabloon-editor kan alleen via de hoofdlijst worden aangeroepen).
De derde tab op deze pagina is “Thema-opties bij deze enquête-groep”. Als je er op klikt krijg je dezelfde lijst met thema's als in de thema-lijst, er is nu maar één knop zichtbaar (de thema-editor kan alleen via de hoofdlijst worden aangeroepen).
<br>
Als je nu klikt op de optie voor het standaardsjabloon krijg je dit scherm:
[[File:Option group inherit.png|thumb|800px|center|''Standaard worden op enquête-groepsniveau de sjabloon-opties geërft'']]
<br>
<br>
Als je nu klikt op de optie voor het standaardthema krijg je dit scherm:
[[File:Option group inherit.png|thumb|800px|center|''Standaard worden op enquête-groepsniveau de thema-opties geërft'']]<br>
* '''Alles''' betekent dat de configuratie van de globale instellingen wordt overgenomen.  
* '''Alles''' betekent dat de configuratie van de globale instellingen wordt overgenomen.  
* Op de pagina met de geavanceerde opties zie je welke velden dan worden overgenomen.
* Op de pagina met de geavanceerde opties zie je welke velden dan worden overgenomen.
* "Nee" in de eenvoudige opties zorgt ervoor dat je een pagina krijgt als die bij de globale opties. Je kunt dan per veld aangeven ja, nee of inherited om de optie in te stellen (ja/nee) of toch de waarde van de globale instellingen over te nemen.   
* "Nee" in de eenvoudige opties zorgt ervoor dat je een pagina krijgt als die bij de globale opties. Je kunt dan per veld aangeven ja, nee of inherited om de optie in te stellen (ja/nee) of toch de waarde van de globale instellingen over te nemen.   
[[File:Inherit group.png|thumb|800px|center|''Elke instelling kan de optie inherited (overerven) hebben'']]
[[File:Inherit group.png|thumb|800px|center|''Elke instelling kan de optie inherited (overerven) hebben'']].


<div class="simplebox">[[File:help.png]] Een enquête-groep kan onderdeel zijn van een enquête-groep. De enquête-groep erft dan van de bovenliggende groep, de groep waar het dus deel van uitmaakt.</div>
<div class="simplebox">[[File:help.png]] Een enquête-groep kan onderdeel zijn van een enquête-groep. De enquête-groep erft dan van de bovenliggende groep, de groep waar het dus deel van uitmaakt.</div>


====Op enquête-niveau====
====Op enquête-niveau====
Als je een enquête wijzigt staat er in het linkermenu de nieuwe optie “Sjabloon-opties”. Die geeft toegang tot een pagina waar je de opties van het sjabloon voor de huidige enquête kunt instellen. Ook hier is, net als bij enquête-groepen, sprake over overerving (inheritance). Hier wordt geërft van de betreffende enquête-groep.   
Als je een enquête wijzigt staat er in het linkermenu de nieuwe optie “Thema-opties”. Die geeft toegang tot een pagina waar je de opties van het thema voor de huidige enquête kunt instellen. Ook hier is, net als bij enquête-groepen, sprake over overerving (inheritance). Hier wordt geërft van de betreffende enquête-groep.   
[[File:Options survey.png|thumb|800px|center|''Sjabloon-opties op enquête niveau'']]
[[File:Options survey.png|thumb|800px|center|''Thema-opties op enquête niveau'']]


==De praktijk==
==De praktijk==
Stel dat we een sjabloon zowel voor bedrijf A als bedrijf B gebruiken. Je stelt wat opties in op globaal niveau (bijv.: ajax aan, animeer body met een schuif, waarschuwen met een pulse). Je maakt dan een enquête-groep aan voor bedrijf A en ook een voor bedrijf B.  Elke groep bevat de enquêtes die dat bedrijf doet. Je stelt hierbij in de groep alleen het logo en de achtergrond in en laat de andere opties overerven.  Je kunt voor een enquête van een van de bedrijven de achtergrond aanpassen naar aanleiding van de enquête zelf, dus op enquête-niveau. Als bedrijf B dan stelt dat het pulseren lelijk te vinden en liever iets met vervagen te zien dan kun de animatie op groepsniveau van de groep van dat bedrijf aanpassen. De enquêtes van bedrijf B gebruiken dan de nieuwe manier van animeren. Je kunt ook eenvoudig op 1 plek het logo van een bedrijf aanpassen in alle enquêtes als een bedrijf een nieuwe logo neemt.
Stel dat we een thema zowel voor bedrijf A als bedrijf B gebruiken. Je stelt wat opties in op globaal niveau (bijv.: ajax aan, animeer body met een schuif, waarschuwen met een pulse). Je maakt dan een enquête-groep aan voor bedrijf A en ook een voor bedrijf B.  Elke groep bevat de enquêtes die dat bedrijf doet. Je stelt hierbij in de groep alleen het logo en de achtergrond in en laat de andere opties overerven.  Je kunt voor een enquête van een van de bedrijven de achtergrond aanpassen naar aanleiding van de enquête zelf, dus op enquête-niveau.  
Als bedrijf B dan stelt dat het pulseren lelijk te vinden en liever iets met vervagen te zien dan kun je de animatie op groepsniveau van de groep van dat bedrijf aanpassen. De enquêtes van bedrijf B gebruiken dan de nieuwe manier van animeren. Je kunt ook eenvoudig op 1 plek het logo van een bedrijf aanpassen in alle enquêtes als een bedrijf een nieuwe logo neemt.
<br>
<br>
<div class="simplebox">Deze voorbeelden zijn op basis van het huidige basissjabloon. Maar je kunt als sjabloonontwerper met twig natuurlijk eigen opties toevoegen. Je kunt een optie “info footer” toevoegen waarin je gegevens toevoegt als bedrijfswebsite of een telefoonnummer van het bedrijf. Als een bedrijf dan verschillende afdelingen heeft met verschillende telefoonnummers, maar wel enquêtes houden dan kun je ook subgroepen per afdeling aanmaken. EHet telefoonnummer wordt dan een optie.</div>
<div class="simplebox">Deze voorbeelden zijn op basis van het huidige basisthema. Maar je kunt als ontwerper met twig natuurlijk eigen opties toevoegen. Je kunt een optie “info footer” toevoegen waarin je gegevens toevoegt als bedrijfswebsite of een telefoonnummer van het bedrijf. Als een bedrijf dan verschillende afdelingen heeft met verschillende telefoonnummers, maar wel enquêtes houden dan kun je ook subgroepen per afdeling aanmaken. Het telefoonnummer wordt dan een optie.</div>


= Veel gestelde vragen over het aanpassen van een thema =
= Veel gestelde vragen over het aanpassen van een thema =
Line 202: Line 204:


==Aanpassen CSS/JavaScript: werken met de asset-manager ("Waarom werken mijn aanpassingen niet?") ==
==Aanpassen CSS/JavaScript: werken met de asset-manager ("Waarom werken mijn aanpassingen niet?") ==
<br />


Als je de CSS/JavaScript van een thema probeert aan te passen in een editor dan kan het gebeuren dat je wijzigingen niet meegenomen lijken te worden.
Als je de CSS/JavaScript van een thema probeert aan te passen in een editor dan kan het gebeuren dat je wijzigingen niet meegenomen lijken te worden.
Line 210: Line 211:
Vanaf versie 2.50 gebruikt LimeSurvey de  
Vanaf versie 2.50 gebruikt LimeSurvey de  
[http://www.yiiframework.com/wiki/148/understanding-assets/  Yii asset-manager].
[http://www.yiiframework.com/wiki/148/understanding-assets/  Yii asset-manager].
<br />


Daardoor komen de CSS/JavaScript-bestanden van het thema in een submap met een willekeurige naam bijvoorbeeld ''tmp/1ef64ml/''. Dus als je een css/js-bestand wijzigt en dat bekend is in de asset-manager, dan worden de bestanden geplaatst in een nieuwe submap. Dit voorkomt dat de gebruiker de cache van de webbrowser moet verversen, er wordt immers een nieuw bestand gebruikt, de gebruiker ziet dan direct de nieuwe versie.  
Daardoor komen de CSS/JavaScript-bestanden van het thema in een submap met een willekeurige naam bijvoorbeeld ''tmp/1ef64ml/''. Dus als je een css/js-bestand wijzigt en dat bekend is in de asset-manager, dan worden de bestanden geplaatst in een nieuwe submap. Dit voorkomt dat de gebruiker de cache van de webbrowser moet verversen, er wordt immers een nieuw bestand gebruikt, de gebruiker ziet dan direct de nieuwe versie.  
Line 233: Line 233:


Je kunt dus op meerdere manieren de CSS/JavaScript van een thema wijzigen:
Je kunt dus op meerdere manieren de CSS/JavaScript van een thema wijzigen:
*'''met de LimeSurvey Sjabloon editor:''' die werkt met de asset-manager, je hoeft je dus dan daar geen zorgen over te maken dan je een oude versie krijgt bij gebruik
*'''met de LimeSurvey Thema-editor:''' die werkt met de asset-manager, je hoeft je dus dan daar geen zorgen over te maken dan je een oude versie krijgt bij gebruik
*'''je kunt gaan debuggen:''' je schakelt de asset-manager uit, de css/js bestanden van je thema's worden gebruikt. Je moet dan als gebruiker de cache verversen na elke aanpassing
*'''je kunt gaan debuggen:''' je schakelt de asset-manager uit, de css/js bestanden van je thema's worden gebruikt. Je moet dan als gebruiker de cache verversen na elke aanpassing
* '''Je kunt de cache verversen''': bij de algemene instellingen -> Algemeen -> Cachegeheugen voor assets wissen
* '''Je kunt de cache verversen''': bij de algemene instellingen -> Algemeen -> Cachegeheugen voor assets wissen
Line 239: Line 239:
[[File:Clearassets-ls3 3.png]]
[[File:Clearassets-ls3 3.png]]


<div class="simplebox">[[File:help.png]] '''Wij bevelen het gebruik van de sjabloon-editor aan.''' </div>
<div class="simplebox">[[File:help.png]] '''Wij bevelen het gebruik van de thema-editor aan om de CSS aan te passen.''' </div>




Door het gebruik van de sjabloon-editor krijg je een goed beeld van de architectuur van het nieuwe thema-systeem.
Door het gebruik van de thema-editor krijg je een goed beeld van de architectuur van het nieuwe thema-systeem.
Wees voorzichtig als je de CSS in het thema fruity aanpast, de meeste definities gebruiken de selector ".fruity" (een class van de body).
Wees voorzichtig als je de CSS in het thema fruity aanpast, de meeste definities gebruiken de selector ".fruity" (een class van de body).


Line 250: Line 250:
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/bootswatch/css/variations/flatly.min.css
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/bootswatch/css/variations/flatly.min.css


<syntaxhighlight lang="css" enclose="div">
<syntaxhighlight lang="css">
@import url("https://fonts.googleapis.com/css?family=Lato:400,700,400italic");
@import url("https://fonts.googleapis.com/css?family=Lato:400,700,400italic");
</syntaxhighlight>
</syntaxhighlight>
Line 256: Line 256:
Daarna wordt in de CSS het Lato font gebruikt:
Daarna wordt in de CSS het Lato font gebruikt:
https://github.com/thomaspark/bootswatch/blob/master/dist/flatly/bootstrap.css#L72
https://github.com/thomaspark/bootswatch/blob/master/dist/flatly/bootstrap.css#L72
<syntaxhighlight lang="css" enclose="div">
<syntaxhighlight lang="css">
body {
body {
   ...
   ...
Line 270: Line 270:
Je kunt een font-bestand natuurlijk ook lokaal opslaan en dat bestand dan gebruiken in plaats van bijvoorbeeld het via Google CDN (privacy) te gebruiken. Een voorbeeld met het font noto:
Je kunt een font-bestand natuurlijk ook lokaal opslaan en dat bestand dan gebruiken in plaats van bijvoorbeeld het via Google CDN (privacy) te gebruiken. Een voorbeeld met het font noto:
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/assets/fonts/noto.css
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/assets/fonts/noto.css
<syntaxhighlight lang="css" enclose="div">
<syntaxhighlight lang="css">
@font-face {
@font-face {
   font-family: 'Noto Sans';
   font-family: 'Noto Sans';
Line 292: Line 292:
*Voeg in je css-bestand twee classes toe:
*Voeg in je css-bestand twee classes toe:
<br>
<br>
<syntaxhighlight lang="css" enclose="div">
<syntaxhighlight lang="css">
.font-my_custom_font {
.font-my_custom_font {
  font-family: 'my_custom_font ';
  font-family: 'my_custom_font ';
Line 301: Line 301:
</syntaxhighlight>
</syntaxhighlight>
*In het XML-bestand van je thema, voeg een font optie toe (standaard wordt het my_custom_font) :
*In het XML-bestand van je thema, voeg een font optie toe (standaard wordt het my_custom_font) :
<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang="xml">
     <options>
     <options>
         ....
         ....
Line 309: Line 309:


* in bestand option.twig, voeg de font picker toe met de volgende regels. (Nog niet getest, klachten graag op ons forum):
* in bestand option.twig, voeg de font picker toe met de volgende regels. (Nog niet getest, klachten graag op ons forum):
<syntaxhighlight lang="html" enclose="div">
<syntaxhighlight lang="html">
              
              
             <div class='row ls-space margin top-15 bottom-15 action_hide_on_inherit'>
             <div class='row ls-space margin top-15 bottom-15 action_hide_on_inherit'>
Line 323: Line 323:
                                 <div class='col-sm-12'>
                                 <div class='col-sm-12'>
                                     <select class='form-control selector_option_value_field' id='simple_edit_font' name='font'>
                                     <select class='form-control selector_option_value_field' id='simple_edit_font' name='font'>
                                     {% if templateConfiguration.sid is not empty or templateConfiguration.gsid is not empty %}
                                     {% if templateConfiguration.sid is not empty or templateConfiguration.gsid is not empty %}   //Shouldn't this be "theme" in stead of "template"?
                                         {% set fontOptions = fontOptions ~ '<option value = "inherit" > Inherit</option>' %}
                                         {% set fontOptions = fontOptions ~ '<option value = "inherit" > Inherit</option>' %}
                                     {% endif %}
                                     {% endif %}
Line 357: Line 357:
https://github.com/LimeSurvey/LimeSurvey/blob/4c40b61afb0dba8fd80154b50f5831045df8d814/application/config/fonts.php#L47-L53
https://github.com/LimeSurvey/LimeSurvey/blob/4c40b61afb0dba8fd80154b50f5831045df8d814/application/config/fonts.php#L47-L53
<br>
<br>
<syntaxhighlight lang="php" enclose="div">
<syntaxhighlight lang="php">


     'font-noto' => array(
     'font-noto' => array(
Line 372: Line 372:
<br>
<br>
Merk de definitie van de class ".font-noto" onderaan op:
Merk de definitie van de class ".font-noto" onderaan op:
<syntaxhighlight lang="css" enclose="div">
<syntaxhighlight lang="css">
@font-face {
@font-face {
   font-family: 'Noto Sans';
   font-family: 'Noto Sans';
Line 388: Line 388:
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/config.xml#L79
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/config.xml#L79


<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang="xml">
         <packages>
         <packages>
             ....
             ....
Line 396: Line 396:
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/config.xml#L58
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/config.xml#L58
<br>
<br>
<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang="xml">
     <options>
     <options>
         ....
         ....
Line 405: Line 405:
Daarna wordt de body class font gedefinieerd met::
Daarna wordt de body class font gedefinieerd met::
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/views/layout_global.twig#L76
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/views/layout_global.twig#L76
<syntaxhighlight lang="html" enclose="div">
<syntaxhighlight lang="html">
<body class=" ...  font-{{  aSurveyInfo.options.font }} ... " ... >
<body class=" ...  font-{{  aSurveyInfo.options.font }} ... " ... >
</syntaxhighlight>
</syntaxhighlight>


Natuurlijk bevat het XML-bestand alleen de standaardwaarden van je sjabloonconfiguratie. Deze zijn gedefinieerd en worden gelezen in de database (table "template_configuration") als json-strings. Het bestand option.js file gebruikt alleen maar de waarde van de font-selector bij de eenvoudige opties om de waarde op scherm met de geavanceerde opties te wijzigen:
Natuurlijk bevat het XML-bestand alleen de standaardwaarden van je thema-configuratie. Deze zijn gedefinieerd en worden gelezen in de database (table "template_configuration")  (Vraag: "template_" van "theme_"?) als json-strings. Het bestand option.js file gebruikt alleen maar de waarde van de font-selector bij de eenvoudige opties om de waarde op scherm met de geavanceerde opties te wijzigen:
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/options/options.js#L148-L174
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/options/options.js#L148-L174


Line 418: Line 418:
<div class="simplebox">[[File:help.png]] We gebruiken weer het voorbeeld van het uitbreiden van het "bootswatch" thema in LimeSurvey versie 3.4.3.</div>   
<div class="simplebox">[[File:help.png]] We gebruiken weer het voorbeeld van het uitbreiden van het "bootswatch" thema in LimeSurvey versie 3.4.3.</div>   
=== Een aangepast thema maken  ===
=== Een aangepast thema maken  ===
#Extend het "bootswatch" thema zoals eerder is aangegeven.
# Extend het "bootswatch" thema zoals eerder is aangegeven.
#Kopieer <span style="color: #BA2121;">custom.css</span> naar het lokale sjabloon.
# Kopieer <span style="color: #BA2121;">custom.css</span> naar het lokale thema.
===Sjabloon-opties toevoegen===
===Thema-opties toevoegen===
#Kopieer de  inhoud van <span style="color: #BA2121;">/themes/survey/bootswatch/options/</span> naar <span style="color: #BA2121;">/upload/themes/survey/yourThemeName/options/</span>.
# Kopieer de  inhoud van <span style="color: #BA2121;">/themes/survey/bootswatch/options/</span> naar <span style="color: # BA2121;">/upload/themes/survey/yourThemeName/options/</span>.
#Open <span style="color: #BA2121;">/upload/themes/survey/yourThemeName/options/options.twig</span> in de editor en zoek naar "{# Bootstrap Bootswatch theme #}". Voeg direct voor het parent  <nowiki><div class='row'></nowiki> element, toe:<syntaxhighlight lang="html" enclose="div">
# Open <span style="color: #BA2121;">/upload/themes/survey/yourThemeName/options/options.twig</span> in de editor en zoek naar "{# Bootstrap Bootswatch theme #}". Voeg direct voor het parent  <nowiki><div class='row'></nowiki> element, toe:<syntaxhighlight lang="html">
{# Aangepaste enquête-naam in navigatie-taakbalk #}
{# Aangepaste enquête-naam in navigatie-taakbalk #}
<div class='row'>
<div class='row'>
Line 472: Line 472:
<hr/>
<hr/>
</div></syntaxhighlight>
</div></syntaxhighlight>
#Open <span style="color: #BA2121;">/upload/themes/survey/yourThemeName/config.xml</span> en voeg twee items toe aan het "options" blok, het ziet er dan uit als:<syntaxhighlight lang="xml" enclose="div">    <options>
#Open <span style="color: #BA2121;">/upload/themes/survey/yourThemeName/config.xml</span> en voeg twee items toe aan het "options" blok, het ziet er dan uit als:<syntaxhighlight lang="xml">    <options>
         <ajaxmode>aan</ajaxmode>
         <ajaxmode>aan</ajaxmode>
         ...
         ...
Line 483: Line 483:
#Maak de map <span style="color: #BA2121;">/upload/themes/survey/jeThemaNaam/views/subviews/header/</span> aan.
#Maak de map <span style="color: #BA2121;">/upload/themes/survey/jeThemaNaam/views/subviews/header/</span> aan.
#Kopieer <span style="color: #BA2121;">/themes/survey/vanilla/views/subviews/header/nav_bar.twig</span> naar die map.
#Kopieer <span style="color: #BA2121;">/themes/survey/vanilla/views/subviews/header/nav_bar.twig</span> naar die map.
#Open <span style="color: #BA2121;">/themes/survey/vanilla/views/subviews/header/nav_bar.twig</span> en zoek naar "{# Logo option #}". Wijzig het IF-statement daaronder voor het logo/survey-name, zodat het er uit ziet als:<syntaxhighlight lang="html" enclose="div">
#Open <span style="color: #BA2121;">/themes/survey/vanilla/views/subviews/header/nav_bar.twig</span> en zoek naar "{# Logo option #}". Wijzig het IF-statement daaronder voor het logo/survey-name, zodat het er uit ziet als:<syntaxhighlight lang="html">
{# Logo option #}
{# Logo option #}
         {% if( aSurveyInfo.options.brandlogo == "on") %}
         {% if( aSurveyInfo.options.brandlogo == "on") %}
Line 495: Line 495:
             </div>
             </div>
         {% endif %}</syntaxhighlight>
         {% endif %}</syntaxhighlight>
#Voeg iets als onderstaande toe aan <span style="color: #BA2121;">/upload/themes/survey/jeThemaNaam/css/custom.css</span>:<syntaxhighlight lang="css" enclose="div">.navbar-brand {
#Voeg iets als onderstaande toe aan <span style="color: #BA2121;">/upload/themes/survey/jeThemaNaam/css/custom.css</span>:<syntaxhighlight lang="css">.navbar-brand {
     line-height: 60px;
     line-height: 60px;
     font-size: 32px;
     font-size: 32px;
Line 504: Line 504:
#Maak de map <span style="color: #BA2121;">/upload/themes/survey/jeThemaNaam/views/subviews/survey/group_subviews</span> aan.
#Maak de map <span style="color: #BA2121;">/upload/themes/survey/jeThemaNaam/views/subviews/survey/group_subviews</span> aan.
#Kopieer <span style="color: #BA2121;">/themes/survey/vanilla/views/subviews/survey/group_subviews/group_container.twig</span> naar die map.
#Kopieer <span style="color: #BA2121;">/themes/survey/vanilla/views/subviews/survey/group_subviews/group_container.twig</span> naar die map.
#Open <span style="color: #BA2121;">/themes/survey/vanilla/views/subviews/survey/group_subviews/group_container.twig</span> en voeg een <nowiki><h1></nowiki> element voor de enquête-titel toe. Het lijkt dan op dit:<syntaxhighlight lang="html" enclose="div"><div class="{{ aSurveyInfo.class.groupcontainer }} space-col" {{ aSurveyInfo.attr.groupcontainer }}>
#Open <span style="color: #BA2121;">/themes/survey/vanilla/views/subviews/survey/group_subviews/group_container.twig</span> en voeg een <nowiki><h1></nowiki> element voor de enquête-titel toe. Het lijkt dan op dit:<syntaxhighlight lang="html"><div class="{{ aSurveyInfo.class.groupcontainer }} space-col" {{ aSurveyInfo.attr.groupcontainer }}>
   
   
     {# Custom survey name #}
     {# Custom survey name #}
Line 537: Line 537:
     {% endif %}
     {% endif %}
</div></syntaxhighlight>
</div></syntaxhighlight>
# Voeg iets als onderstaande toe aan <span style="color: #BA2121;">/upload/themes/survey/yourThemeName/css/custom.css</span>:<syntaxhighlight lang="css" enclose="div">.navbar-brand {
# Voeg iets als onderstaande toe aan <span style="color: #BA2121;">/upload/themes/survey/yourThemeName/css/custom.css</span>:<syntaxhighlight lang="css">.navbar-brand {
     line-height: 60ph1.custom-survey-name {
     line-height: 60ph1.custom-survey-name {
margin: 0;
margin: 0;
Line 553: Line 553:
Op dit moment geven we alleen enkele tips.
Op dit moment geven we alleen enkele tips.


==Themastructuur==
==Thema structuur==


===Bestanden en mappen===
===Bestanden en mappen===
Line 559: Line 559:
De verplichte css / js is standaard al toegevoegd (je kunt deze desgewenst nog steeds verwijderen).
De verplichte css / js is standaard al toegevoegd (je kunt deze desgewenst nog steeds verwijderen).


De lay-outbestanden die je thema moet hebben zijn:
De bestanden die je thema moet hebben zijn de lay-outbestanden:


* '''layout_global.twig''': maken van de pagina's voor het invullen van de enquête.
* '''layout_global.twig''': maken van de pagina's voor het invullen van de enquête.
Line 577: Line 577:
=== Inhoud ===
=== Inhoud ===


In Vanilla's layout_global.twig, you'll see we use a variable called "include_content" to decide what to show
In Vanilla's layout_global.twig, zie je dat er een variabele "include_content" gebruikt wordt om te bepalen wat er getoond wordt
https://github.com/LimeSurvey/LimeSurvey/blob/2398dda3b425da1a37d4611cd7963d39ac739987/themes/survey/vanilla/views/layout_global.twig#L114-L115
https://github.com/LimeSurvey/LimeSurvey/blob/2398dda3b425da1a37d4611cd7963d39ac739987/themes/survey/vanilla/views/layout_global.twig#L114-L115


<syntaxhighlight lang="php" enclose="div">
<syntaxhighlight lang="php">
                     {% set sViewContent =  './subviews/content/' ~ aSurveyInfo.include_content ~ '.twig' %}
                     {% set sViewContent =  './subviews/content/' ~ aSurveyInfo.include_content ~ '.twig' %}
                     {% include './subviews/content/outerframe.twig' with {'include_content': sViewContent } %}
                     {% include './subviews/content/outerframe.twig' with {'include_content': sViewContent } %}
</syntaxhighlight>
</syntaxhighlight>


aSurveyInfo.include_content tell you what action is currently going on: showing questions? showing submit result? showing clear all? etc
aSurveyInfo.include_content geeft aan welke actie momenteel uitgevoerd wordt. Toon je vragen? Resultaat tonen? Alles laten zien? enz.
As you can see, in vanilla, we create one file to include by action. So if you want to know the list of actions, just check the vanilla's directory '''views/subviews/content''', and remove the "twig" extension :
Zoals je ziet, creëren we in vanilla één bestand dat we includen. Dus als je de lijst met acties wilt weten, bekijk dan de '''views/subviews/content''' in de map vanilla en verwijder de extensie "twig":
https://github.com/LimeSurvey/LimeSurvey/tree/2398dda3b425da1a37d4611cd7963d39ac739987/themes/survey/vanilla/views/subviews/content
Https://github.com/LimeSurvey/LimeSurvey/tree/2398dda3b425da1a37d4611cd7963d39ac739987/themes/survey/vanilla/views/subviews/content


* '''clearall.twig'''     
* '''clearall.twig'''     
Line 605: Line 605:
* '''userforms.twig'''  
* '''userforms.twig'''  


If you already created a them for 2.x versions of LimeSurvey, you'll notice that most of them corresponds to the old pstpl files for limesurvey 2.x.  
Als je al een thema voor 2.x-versies van LimeSurvey hebt gemaakt, zul je merken dat de meeste van hen overeenkomen met de oude pstpl-bestanden voor LimeSurvey 2.x.
Again, there is no obligation for you in your theme to create those files, with those names, in this directory. You could for example just add a giant switch in layout_global.twig with the wanted HTML for each action.
Nogmaals, er is geen verplichting voor je in je thema om die bestanden, met die namen, in deze map aan te maken. Je kunt bijvoorbeeld gewoon een gigantische switch toevoegen in layout_global.twig met de gewenste HTML voor elke actie.


=== Het manifest config.xml ===
=== Het manifest config.xml ===


The manifest of the theme contains the main informations about your theme. When you install a theme, the content of the manifest will be loaded in the database, in two different tables: template and template_configuration. So each time you modify the manifest of a theme, you must uninstall and reinstall it (or just reset it). Because this process is annoying while developing a theme you can force the direct usage of the XML file rather than the DB entries. To do so, in config.phpn turn on debug mode and 'force_xmlsettings_for_survey_rendering' to true.
Het manifest van het thema bevat de belangrijkste informatie over het thema. Wanneer je een thema installeert, wordt de inhoud van het manifest in de database geladen in twee verschillende tabellen: template en template_configuration. Dus elke keer als je het manifest van een thema wijzigt, moet je het verwijderen en opnieuw installeren (of alleen opnieuw instellen). Omdat dit proces vervelend is bij het ontwikkelen van een thema, kun je het direct gebruiken van het XML-bestand forceren in plaats van het gebruik via de database. Hiertoe schakel je in config.php de debug-modus en ook de 'force_xmlsettings_for_survey_rendering' in.


==== De sectie metadata ====
==== De sectie metadata ====


Nothing complex: just the main infos about your theme. It will be pushed in the table templates_configuration   
Vrij eenvoudig: alleen de belangrijkste informatie over het thema. Het wordt in de tabel templates_configuration gepusht  


<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang="xml">
     <metadata>
     <metadata>
         <name>De naam van het thema</name>
         <name>De naam van het thema</name>
Line 634: Line 634:




Few remarks:
Wat opmerkingen:
* '''name''': will be used as a key in the db. So it must be unique, and it should not have any special chars (no spaces). Note that cases will not be taken in account
* '''Naam''': zal worden gebruikt als een sleutel in de database. Het moet dus uniek zijn en er mogen geen speciale tekens in voorkomen  (ook geen spaties). Let op: er wordt geen rekening gehouden met hoofdletters.
* '''Title''': will be used to display your theme name in the different lists. It can have special chars
* '''Titel''': wordt gebruikt om de themanaam in de verschillende lijsten weer te geven. Het mag speciale tekens bevatten.
* '''description''': will be used in the main list of survey theme. It can contains special chars, and even HTML code by using
* '''Beschrijving''': wordt gebruikt in de hoofdlijst van het enquête-thema. Het kan speciale tekens bevatten, en zelfs HTML-code.
* '''extends''': optional, it defines the parent themes. So if any file is not present in this theme (twig/js/css/jpg, etc) it will look for it in the parent theme
* '''Extends''': optioneel, het definieert de bovenliggende thema's. Dus als een bestand niet aanwezig is in dit thema (twig / js / css / jpg, etc) wordt het overgenomen uit het bovenliggende thema (de parent)




<div class="simplebox">[[File:help.png]] If you extended one of the the 3 core themes (Vanilla, Bootswatch, Fruity), you can change the "extends" value from one parent theme to the other. Of course, you'll have to reset the theme. </div>
<div class="simplebox">[[File:help.png]] Als je een van de 3 standaardthema's (Vanilla, Bootswatch, Fruity) hebt uitgebreid, kun je de waarde "extends" van de ene parent naar de andere veranderen. Natuurlijk moet je het thema opnieuw instellen. </div>




Line 649: Line 649:
==== De sectie files ====
==== De sectie files ====


This one is an important one. It will be pushed in the table template_configuration, in the field files_css, files_js, files_print_css as json arrays.   
Dit is een belangrijke. Het wordt in de tabel template-configuration  in het veld files_css, files_js, files_print_css als json-arrays opgeslagen.   


Eg: the files section of the Material Premium Theme:
Bijv .: het bestandsgedeelte van het thema 'Material Premium':


<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang="xml">
     <files>
     <files>
         <css>
         <css>
Line 676: Line 676:
</syntaxhighlight>
</syntaxhighlight>


All the CSS/JS files present in this section will be loaded at the launch of the survey (in ajax mode. If ajax mode is off, then of course all the files are reloaded at each page).  
Alle CSS / JS-bestanden in deze sectie worden (in ajax-modus) bij het starten van de enquête geladen. (Als de ajax-modus is uitgeschakeld, worden alle bestanden uiteraard op elke pagina opnieuw geladen).  




They will be added to a Yii Asset Packet based on the name of the theme. So when Asset Manager is on (debug mode being off), those files will be copied to the tmp directory with the rest of the theme (so you can use relative path in the CSS and JS to reach the image files).
Ze worden toegevoegd aan een Yii Asset-pakket op basis van de naam van het thema. Dus als Asset Manager is ingeschakeld (debug-modus is uitgeschakeld), worden die bestanden gekopieerd naar de tmp-map met de rest van het thema (zodat je het relatieve pad in de CSS en JS kunt gebruiken om de afbeeldingsbestanden te gebruiken).
About the Asset manager in Yii: https://www.yiiframework.com/wiki/148/understanding-assets  
Asset-manager in Yii: https://www.yiiframework.com/wiki/148/understanding-assets
About packages in Yii: http://www.yiiframework.com/doc/api/1.1/CClientScript#packages-detail
Packages in Yii: http://www.yiiframework.com/doc/api/1.1/CClientScript#packages-detail




They will use the inheritance system. It means that if you add a CSS/JS file to a theme, but it's not present in the theme, then the engine will look into all the mother themes of this theme and will use the first one it finds. So if a user extends your theme via the theme editor, all those files will be inherited in his theme. The keywords refer to this inheritance system.
Ze zullen het overervingssysteem gebruiken. Dit betekent dat als je een CSS / JS-bestand aan een thema toevoegt, maar het is niet in het thema aanwezig er in de mogelijk meerdere bovenliggende thema's van dit thema zal worden gezocht. De eerste die wordt gevonden, zal worden gebruikt. Dus als een gebruiker je thema uitbreidt via de thema-editor, zullen al die bestanden worden overgenomen in zijn thema. De keywords verwijzen naar dit systeem van inheritance.




* '''add''' : it will add the file to the theme, and to all its inherited theme
* '''add''': het zal het bestand toevoegen aan het thema en aan al zijn onderliggende thema's.
* '''replace''': it will replace the the file of its mother theme
* '''replace''': het zal het bestand van zijn bovenliggende thema vervangen.
* '''remove''': it will remove the file from '''any''' package, even the core package (since 3.14)
* '''remove''': het zal het bestand uit '''elk''' package verwijderen, zelfs uit het core-pakket (sinds 3.14)


<div class="simplebox">[[File:help.png]]   Remember you can set in config.php 'force_xmlsettings_for_survey_rendering' so configuration is read from XML instead of DB (no reset needed). This will make easier to test the modifications of the XML files, and will avoid you to uninstall/reinstall theme at each modification of the XML </div>
<div class="simplebox"> [[File:help.png]] Je kunt in config.php 'force_xmlsettings_for_survey_rendering' instellen, zodat de configuratie wordt gelezen vanuit XML in plaats van uit de database (geen reset nodig). Dit maakt het eenvoudiger om wijzigingen van de XML-bestanden te testen en zal voorkomen dat je het thema bij elke wijziging van de XML moet verwijderen en installeren</div>




Few remarks on those keywords:  
Enkele opmerkingen over de keywords:  




===== Inheritance tips =====
===== Inheritance tips=====
As explained before, the "add" keyword can refer to a file being in one of the mother theme. So you can "add" a file in this section, and still not having this file in your theme, but in one of its parents theme. The engine will look into all its parent themes and will use the first one it finds. If it can't find the file, and debug mode is on in config, and js frontend debug mode is on in global setting, a message in console will warn you. Eg: if we add in a my_theme: <add>css/unexisting.css</add>, in the console we'll see:
Zoals eerder uitgelegd, kan het keyword "add" verwijzen naar een bestand in een parent van het thema. Dus je kunt een bestand in deze sectie "toevoegen", en nog steeds het bestand uit de parent gebruiken. Er wordt gekeken naar alle bovenliggende thema's en de eerste die wordt gevonden, wordt gebruikt. Als het bestand niet kan worden gevonden en de debug-modus is ingeschakeld in de configuratie, en de javascript frontend debug-modus is ingeschakeld bij de de algemene instellingen, krijg je een waarschuwing in het console. Bijv .: als we in een thema my_theme toevoegen: <add> css / unexisting.css </add> , zien we in het console:


<syntaxhighlight lang="" enclose="div">
<syntaxhighlight lang="">
  (¯`·._.·(¯`·._.· Theme Configuration Error  ·._.·´¯)·._.·´¯)  
  (¯`·._.·(¯`·._.· Theme Configuration Error  ·._.·´¯)·._.·´¯)  


Line 706: Line 706:
</syntaxhighlight>
</syntaxhighlight>


If the debug mode is off, then no error at all will be seen. The engine will just ignore the wrong add statements.
Als de debug-modus is uitgeschakeld, is er helemaal geen fout te zien. De verkeerde toevoeginstructies worden alleen maar overgeslagen.




Line 712: Line 712:
===== Wanneer gebruik ik add, replace of gebruik ik de parent (bovenliggende thema)? =====
===== Wanneer gebruik ik add, replace of gebruik ik de parent (bovenliggende thema)? =====


First: add and replace are the very same keyword. You can use the one or the other, the engine will just do the same. They are distinct for human readers, so they understand what was your intention.  
Ten eerste: 'add' en ' replace' doen eigenlijk hetzelfde. We maken dit onderscheid om het onszelf duidelijker te maken wat de bedoeling is.  




You can't add a file with the same name as the mother theme: it will always replace it. eg: If you have a file called "my_mother_theme/foo.css" and you add a file called "foo.cs" in the daughter theme, only  "daughter_theme/foo.css" will be added to the theme. If you want to keep "my_mother_theme/foo.css", just choose another name for "daughter_theme/foo.css", like "daughter_theme/bar.css". So the keyword "add" can be used as a "replace" keyword.  
Je kunt geen bestand met dezelfde naam als het bovenliggende thema toevoegen: dan wordt dat bestand vervangen, bijv.: Als je een bestand "my_mother_theme/foo.css" hebt en je voegt een bestand met de naam "foo.cs" toe aan het onderliggende thema, dan wordt alleen "daughter_theme/foo.css" aan het thema toegevoegd. Als je "my_mother_theme/foo.css" wilt behouden, kies je gewoon een andere naam voor "daughter_theme/foo.css", zoals "daughter_theme/bar.css". Dus het keyword "add" kan worden gebruikt als een "replace" -woord.  




If you wonder why: this make much easier the automatic generation of inherited theme, copying the file section works out of the box (no need to rename "add" to "replace" when extending one the file).  
Als je je afvraagt waarom: dit maakt het automatisch genereren van een overgeërfd thema gemakkelijker, het kopiëren van de bestandssectie werkt out of the box (het is niet nodig om "add" te hernoemen naar "replace" wanneer je het bestand uitbreidt).  




To make it clear, let's take the Fruity example. Here its css file section:
We gebruiken weer het thema Fruity als voorbeeld. De sectie css:




<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang="xml">
         <css>
         <css>
             <add>css/variations/sea_green.css</add>
             <add>css/variations/sea_green.css</add>
Line 734: Line 734:




If you look to the custom.css file in fruity, it is exactly the same as the vanilla one. We could delete the custom.css file inside fruity, the one of vanilla would loaded. We could remove the statement <replace>custom.css</replace> from the Fruity manifest, the statement from vanilla will be used, and the vanilla custom.css would be loaded.  
Als je het bestand custom.css in fruity bekijkt, is het precies hetzelfde als het vanilla-bestand. We kunnen het bestand custom.css binnen fruity verwijderen, het bestand met vanilla wordt dan gebruikt. We kunnen het statement <replace> custom.css </replace> verwijderen van het Fruity-manifest, dan wordt vanilla custom.css geladen.  




So why do we use the statement  <replace>custom.css</replace> inside the fruity manifest? The answer is easy: because we want the end user to be able to extend the fruity theme, to modify the file in his local theme, and to load this modified file from his inherited theme. To understand, just extend fruity and have a look to the extended theme. THe extended theme doesn't even have the file custom.css. So the one of fruity will be used. But: if the user create this file in the extended theme (by clicking on "extend" in the theme editor), then this file will be loaded from his theme.  
Dus waarom gebruiken we de verklaring <replace>custom.css</replace> in het manifest fruity? Het antwoord is eenvoudig: omdat we willen dat de eindgebruiker het thema fruity kan uitbreiden, het bestand in zijn lokale thema kan wijzigen en dit gewijzigde bestand van zijn overgenomen thema kan laden. Om het te begrijpen, moet je fruity uitbreiden en naar het uitgebreide thema kijken. Het uitgebreide thema heeft niet eens het bestand custom.css. Dus dat van fruity zal worden gebruikt. Maar: als de gebruiker dit bestand in het uitgebreide thema maakt (door in de themabewerker op "extend" te klikken), wordt dit bestand uit zijn thema geladen.  




So in general:  
Dus in het algemeen:
if you create a theme from scratch not extending any theme, just use the add statement to add your css/js files. Easy peasy.
Als je een nieuw thema maakt zonder een thema uit te breiden, gebruikt je 'add' om je CSS / JS-bestanden toe te voegen. Gemakkelijk.
if you create a theme extending another theme, and you don't want the users to be able to extends the css/js file from the mother theme: don't use the add statement in your manifest. THe files will still be loaded from the mother theme configuration.
Als je een thema maakt dat een ander thema uitbreidt, en je niet wilt dat de gebruikers het css / js-bestand uit het bovenliggende thema kunnen uitbreiden: gebruik dan niet 'add' in je manifest. De bestanden worden nog steeds geladen vanuit de bovenliggende thema-configuratie.
if you create a theme extending another theme, and you want to replace a file from the mother theme: use the replace keyword (the add keyword will have the same result)
Als je een thema maakt dat een ander thema uitbreidt en je een bestand wilt vervangen door het bovenliggende thema: gebruik dan 'replace'. ('add' heeft hetzelfde resultaat)
if you create a theme extending another theme, if you don't replace a given file from css/js, but you want the users to be able to extend this file: then use the "replace" statement in your manifest for this file. Even if you don't replace the file, by using the keyword replace in the manifest: you allow the user to do it if he wants to do it.   
Als je een thema maakt dat een ander thema uitbreidt, als je een bepaald bestand niet vervangt door css / js, maar je wilt dat de gebruikers dit bestand kunnen uitbreiden: gebruik dan 'replace' in je manifest voor dit bestand. Zelfs als je het bestand niet vervangt, gebruik je 'replace' in het manifest: je staat de gebruiker toe om het te doen zoals hij het wil doen.   




Only this very last case needs a bit of mental gymnastic ot understand, all the other cases are trivial.
Alleen dit laatste geval is verrassend, de andere gevallen zijn triviaal.






<div class="simplebox">[[File:help.png]]  
<div class="simplebox"> [[File:help.png]]
You can also register CSS and JS files directly from the twig code. Those files will be loaded only when the twig file is asked. If you want the users to be able to inherit those JS/Css files from the theme editor, remember to use the functions {{registerTemplateCssFile('my_style.css')}} and {{registerTemplateScript('my_script.js')}}. If you don't use those functions, your theme may work, but inheritance on it will be broken. It is the same logic as the {{image('my_picture.jpg')}} function
Je kunt ook CSS- en JS-bestanden rechtstreeks van de twig-code registreren. Die bestanden worden alleen geladen als het twig-bestand wordt gevraagd. Als je wilt dat de gebruikers die JS / CSS-bestanden van de thema-editor kunnen erven, vergeet dan niet om de functies {{registerTemplateCssFile ('my_style.css')}} en {{registerTemplateScript ('my_script.js')}} te gebruiken . Als je deze functies niet gebruikt, werkt je thema mogelijk, maar het overerven wordt verbroken. Het is dezelfde logica als de functie {{image ('my_picture.jpg')}}
</div>
</div>


===== Het keyword remove  =====
===== Het keyword remove  =====


The remove keyword is available only since 3.14. With this one, you can remove any css/file from any package, even the core ones. It is used in Material Premium Theme to remove the Awseome Bootstrap Checkbox's files:
Het keywoord 'remove' is beschikbaar sinds versie 3.14. Hiermee kun je elk CSS / bestand uit elk package verwijderen, zelfs de kernbestanden. Het wordt gebruikt in Material Premium Theme om de Awseome Bootstrap Checkbox-bestanden te verwijderen:


<syntaxhighlight lang="xml" enclose="div">
<syntaxhighlight lang="xml">
<remove>awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css</remove>
<remove>awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css</remove>
</syntaxhighlight>
</syntaxhighlight>


so you should use the very same syntax as the package's file (eg: "awesome-bootstrap-checkbox.css" alone without it's folder path would not work). You'll find the complete list of core packages and their files in /application/config/packages.php and config/third_party.php. For example, for awesome-bootstrap-checkbox.css:
dus zou je dezelfde syntax moeten gebruiken als het package-bestand (bijv .: "awesome-bootstrap-checkbox.css" zou zonder het pad niet werken). Je vindt de volledige lijst met standaard packages en hun bestanden in /application/config/packages.php en config / third_party.php. Bijvoorbeeld, voor awesome-bootstrap-checkbox.css:
https://github.com/LimeSurvey/LimeSurvey/blob/2398dda3b425da1a37d4611cd7963d39ac739987/application/config/packages.php#L54-L56
https://github.com/LimeSurvey/LimeSurvey/blob/2398dda3b425da1a37d4611cd7963d39ac739987/application/config/packages.php#L54-L56


<syntaxhighlight lang="php" enclose="div">
<syntaxhighlight lang="php">
         'css'=> array(
         'css'=> array(
             'awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css',
             'awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css',
Line 773: Line 773:




Another way to find the exact name to use in the remove tag is to turn asset manager on (turning debug mode off or setting 'use_asset_manager'=>true in the config). Then, the path to use will be the one just after the random directory in the tmp directory. For example, for awesome-bootstrap-checkbox.css:
Een andere manier om de exacte naam te vinden die in de 'remove'-tag moet worden gebruikt, is om asset-manager in te schakelen (de debug-modus uit te schakelen of 'use_asset_manager' => true in de config in te stellen). Vervolgens zal het pad dat je gebruikt net na de willekeurige map in de tmp-directory zijn. Bijvoorbeeld, voor awesome-bootstrap-checkbox.css:
<syntaxhighlight lang="html" enclose="div">
<syntaxhighlight lang="html">
<link rel="stylesheet" type="text/css" href="/tmp/assets/cbc4e3cb/awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css" />
<link rel="stylesheet" type="text/css" href="/tmp/assets/cbc4e3cb/awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css" />
</syntaxhighlight>
</syntaxhighlight>


Files you should not remove:
Bestanden die je niet moet verwijderen:


'''jquery-3.1.1.min.js''' : vereist
'''jquery-3.1.1.min.js''' : vereist
Line 788: Line 788:
'''moment-with-locales.min.js''' : vereist voor o.a. vraagtype Datum
'''moment-with-locales.min.js''' : vereist voor o.a. vraagtype Datum


'''em_javascript.js''' : vereist voor Expressiebeheer JavaScript
'''em_javascript.js''' : vereist voor ExpressionScript JavaScript


==== De sectie options ====
==== De sectie options ====


This section is relative to the option of your theme. It will be used to feed the filed "options" of the table template_configuration as a json array.
Dit gedeelte is gerelateerd aan de optie van het thema. Het zal worden gebruikt om de ingediende "opties" van de tabel template_configuration als een json array te vullen.


=== Meer informatie ===
=== Meer informatie ===
Line 804: Line 804:
'''NB''':  je kunt dat voorkomen door niet de database te laten gebruiken maar de XML. Je kunt dat instellen door in ''config.php'' de debug mode aan te zetten en de onderstaande regel niet op commentaar te zetten:
'''NB''':  je kunt dat voorkomen door niet de database te laten gebruiken maar de XML. Je kunt dat instellen door in ''config.php'' de debug mode aan te zetten en de onderstaande regel niet op commentaar te zetten:


''''force_xmlsettings_for_survey_rendering' => true, // Uncomment if you want to force the use of the XML file rather than DB (for easy theme development)'''
'force_xmlsettings_for_survey_rendering' => true, // Maak deze regel actief als je het XML-bestand wil gebruiken in plaats van de database (voor gemakkelijker ontwikkeling van het thema)  


Wees voorzichtig: alles wordt geladen uit XML (inclusief opties, enz.).
Wees voorzichtig: alles wordt geladen uit XML (inclusief opties, enz.).

Latest revision as of 16:07, 24 June 2022

Other languages:

Inleiding

NB: In eerder versies van LimeSurvey noemden we de bestanden die definieerden hoe de enquête eruit zag, dus de kleuren, lettertypes, lay-out en het gedrag een template/sjabloon. Naar nieuwe inzichten noemen we dit nu een "thema". Template/sjabloon is gereserveerd voor voorbeeld enquêtes.

Op deze pagina leggen we uit hoe je:

  • gebruik maakt van het nieuwe thema-systeem in LimeSurvey 3.0
  • gebruik maakt van overerving (inheritance) bij je eigen thema's
  • een afbeelding toevoegt
  • thema-opties beheert voor je enquêtes en enquête-groepen

In LimeSurvey 3 is er een geheel nieuw thema-systeem, gebaseerd op Twig 1.29, Bootstrap, waarin overerving van thema's en bijbehorende opties mogelijk is. Het oude systeem met keywords is vervangen, Alle HTML van de front-end kan nu aangepast worden. Vroeger was er een keyword {ASSESSMENTS} dat vervangen werd door een stukje HTML op het moment van uitvoering. Een ontwikkelaar kon dit alleen aanpassen met JavaScript. Nu is er een bestand assessments.twig met de logica (geschreven in Twig) om de HTML aan te maken. Op deze pagina beschrijven we hoe je dit systeem kunt gebruiken.

We geven geen uitgebreide beschrijving hoe Twig werkt. Het is een eenvoudige constructie in PHP die een goede beveiliging biedt dankzij het “sandbox” systeem (dat zien we later uitgebreider terug als het over de core-code hebben). Het gebruik is eenvoudig, zeker als je wat kennis van PHP hebt. Documentatie van Twig 1.X: https://twig.symfony.com/

Aanpassen met gebruik van het beheerinterface

Thema-lijst

Op het administratiescherm is er een box om de lijst met thema's te benaderen:

De lijst thema's na een verse installatie van versie RC3


De lijst heeft 5 kolommen:

  • Een voorvertoning van het thema: dit is alleen het plaatje. “preview.png” in de rootmap van het thema.
  • De titel van het thema zoals aangegeven in het manifest (config.xml in de rootmap van het thema).
  • Een beschrijving: een tekst in het manifest.
  • Type thema: Core (aangeleverd bij LimeSurvey), User (toegevoegd in map upload), XML (niet geladen in de database).
  • Extends: indien het een uitbreiding is van een ander thema, de naam van dat thema.
  • Enkele knoppen voor acties:
    • Installatie: Het laad het manifest van een thema om het toe te voegen aan de database zodat het beschikbaar voor selectie bij een enquête.
    • Verwijderen: de registratie van het thema in de database wordt verwijderd.
    • Thema-editor: link naar de thema-editor.
    • Thema-opties: link naar de globale configuratie van de bijbehorende opties.

Thema-editor

Hier gaan we ervan uit dat je het gebruik van het oude systeem kent.


De editor is zo veel als mogelijk gelijk gebleven. Als je een standaardthema opent, dan kun je het wijzigen. Er is nu geen knop kopieer maar een knop uitbreiden (extend).

Nu spreken we van het uitbreiden van een thema
Nu spreken we van het uitbreiden van een thema

Overerving ( inheritance )

In versie 3 kan een thema overerven van een ander thema, het is een uitbreiding van een ander thema. Dit betekent dat de thema-map bijna leeg is, het bevat alleen de bestanden (views, stylesheets, scripts, resources enz.) die anders zijn dan het origineel. Hierdoor kun je snel veel thema's maken voor je verschillende gebruikers zonder veel werk te krijgen aan het onderhoud van veel thema's. Je kunt een eigen thema maken en daar dan per bedrijf een variant van maken (met een ander logo, style, misschien een link naar een website in de footer enz.). Als je dan de CSS of de globale lay-out van je eigen basisthema wijzigt, dan worden alle wijzigingen geërft door de bedrijfsthema's. Je kunt onbeperkt overerven, een onderdeel van een bedrijf kan een eigen thema hebben en dan kan het bedrijfsthema weer de basis voor het onderdeel zijn.

Je kunt ook een eigen thema maken door een standaardthema uit te breiden. Dan zou een update van het standaardthema geen problemen moeten geven.

Toevoegingen aan de gebruikersinterface

Om het Monochrome thema van LimeSurvey uit te breiden, ga naar de thema-lijst, klik op de knop “Thema-editor” van dit thema. Klik daarna op “uitbreiden” en pas de naam “extends_monochrome” aan.

Als je nu naar de uploadmap gaat (eventueel met je file/ftp client), zie je dat er een map upload/themes/extends_monochrome is aangemaakt. Het bevat een XML-bestand en mappen, maar de meeste zijn leeg. Er zijn geen views, CSS of JavaScript. Maar je kunt het nieuwe thema al wel selecteren bij een enquête, het is nu nog 100% gelijk aan het thema monochrome.

De boomstructuur net na het aanmaken. Praktisch leeg.
De boomstructuur net na het aanmaken. Praktisch leeg.
De bronnen (jpg, png enz.) van het originele thema worden bij het uitbreiden gekopieerd. Dit moet omdat als je een CSS-bestand kopieert en er zijn referenties (bijvoorbeeld bij een background-image) dan moeten die in het huidige thema-pad te vinden zijn.

De thema-editor ziet er voor het thema extends_monochrome uit als:

Wijzigen thema extends_monochrome
Wijzigen thema extends_monochrome



De belangrijkste verschillen met de oude versie zijn:  

  • Het keyword inherited op de bestandslijst. Het geeft geen bestand in de thema-map aan, maar dat het bestand van het originele thema wordt gebruikt.


  • De editor zelf ( ACE editor ) toont de inhoud van het geselecteerde bestand. Een bestand bevat naast HTML, CSS en JavaScript ook Twig-statements. Deze Twig-statements maken het mogelijk om logica vanuit de oude core naar de views te verplaatsen, die logica kan nu worden aangepast.
Twig-code, voor Enquête-lijst
Twig-code, voor Enquête-lijst


  • Hierdoor heb je nu meer schermtypes beschikbaar in de dropdownlijst van het menu. Er zijn nu pagina's als ‘Survey List’, ‘Load’, ‘Save’, ‘Error’, ‘Registration’, ‘Assessments’, ‘Print Answers’ beschikbaar gekomen die eerder nauwelijks gewijzigd konden worden.
Je kunt nu alle schermen aanpassen.
Je kunt nu alle schermen aanpassen.


  • De link ‘tip’ onderaan de bestandslijst geeft je de mogelijkheid om op de Twig-manier een afbeelding in je HTML toe te voegen.


  • De knop ‘Bewaar wijzigingen’ heeft nu als tekst Kopieer naar lokaal thema en wijzigingen opslaan.

Voorbeeld: toevoegen van een afbeelding

De knop Kopieer naar lokaal thema en wijzigingen opslaan doet wat het zegt. Als je iets in het bestand wijzigt dan wordt de wijziging in dat bestand opgeslagen.
Als je klikt op het bestand layout_global.twig en daarin net voor de regel met {% block content %} de tekst “TEST” toevoegt en dan op de knop tikt, zie je dat het keyword bij dit bestand is gewijzigd van “inherited” in “local”, de knoptekst is nu ook weer Bewaar wijzigingen.

net na het klikken op de knop
net na het klikken op de knop


Als je naar de map upload/themas/extends_monochrome/views/ gaat, dan zie je dat daar maar een bestand in staat, het bestand layout_global.twig met de tekst “TEST”.

Het bestand is aanwezig in je thema
Het bestand is aanwezig in je thema



We voegen nu een afbeelding toe in plaats van een tekst. Klik op de link tip:
Om een afbeelding in een twig-bestand te gebruiken: {{ image('./files/myfile.png', 'alt-text for my file', {"class": "myclass"}) }}
Je hebt natuurlijk de Twig-documentatie al eens gelezen en je weet dan ook dat bij {{ }} de inhoud tussen de haakjes, dus hier het resultaat van de function image( ) op het scherm wordt getoond.

Als je de code eens een keer wilt zien: versie RC3

Maar je hoeft alleen maar te weten hoe je het moet aanroepen.


De function image() wordt gebruik om:

  • de afbeelding te vinden die in het thema gebruikt wordt. De functie zoekt indien nodig ook in het thema (meerdere niveaus mogelijk) waar het thema van afstamt.
  • dit gaat met gebruik van de asset-manager voor een betere performance van het thema. Meer informatie hierover: http://www.yiiframework.com/wiki/148/understanding-assets/

Dus om een afbeelding in je thema toe te voegen:

  • indien nodig, eerst een bestand uploaden en dan op de plek waar je het wilt hebben toevoegen in een twig-bestand met:

{{ image('./files/myfile.png') }}

  • Je kunt beter ook het veld ALT invullen, deze tekst wordt getoond als het plaatje ontbreekt (ook voor screen-reader en HTML validatie):

{{ image('./files/myfile.png'), ‘bedrijfslogo’ }}

  • Je kunt er ook nog een class attribuut en een id aan toevoegen:

{{ image('./files/myfile.png'), ‘bedrijfslogo’, {“class”: “a_nice_css_class”, “id”: “any_id”} }}

Onze wensen (TO-DO lijst)

  • De gebruikers een aangepaste voorvertoningsbestand in de editor laten upladen.
  • Een knop om het lokale bestand te verwijderen en terug te keren naar de opdracht inherited.
  • Alleen de afbeeldingen in de CSS-bestanden laten kopiëren (door een lijst toe te voegen in het manifest)
  • Herinneren welke thema's het huidige als basis gebruiken (indien die er zijn).

Thema-opties

Ook nieuw in versie 3 is de pagina thema-optie. Iemand die een thema maakt kan eigen opties maken en zelfs een eigen optie-pagina, dat lichten we later toe. Eerst laten we zien doe de optie-pagina bij de standaardthema's werkt. Klik op : “thema-opties” in de thema-lijst.

Geavanceerde opties

Other languages:

Op de tab Thema opties kun je kiezen tussen de Eenvoudige opties en de Geavanceerde opties. De Geavanceerde opties is alleen maar een scherm waarop je de hoofdvelden van de thema-instellingen van de database kunt benaderen. Als je de werking beter wilt begrijpen lees dan over het XML-bestand en het aanmaken vanaf het begin van een thema. Echt iets voor op dat punt ervaren gebruikers.

Maar je kunt natuurlijk op de tab Geavanceerde opties klikken



  • Files css: De CSS-bestanden die toegevoegd moeten worden aan het template.
  • Files js: De JavaScript-bestanden die toegevoegd moeten worden aan het template.
  • Files Print Css: De CSS-bestanden die gebruikt moeten worden bij het afdrukken van een template.
  • Options: Dit veld bevat de opties (en hun waarde) die doorgegeven moeten worden aan de template view.
  • CssFramework Name: De naam van het te laden CSS-framework. Dit enige mogelijke waarden zijn nu : Bootstrap of niet ingevuld.
  • Cssframework Css: Je kunt de standaard bootstrap.css vervangen door hier een eigen versie daarvan hier in te vullen.
  • Cssframework Js: Je kunt de standaard bootstrap.js vervangen door hier een eigen versie daarvan hier in te vullen.
  • Packages To Load: Als je nog wat core asset packages van LimeSurvey wilt laden, dan kan dat hier.

Je ziet bovenaan een knop upload, waarmee je een bestand kunt toevoegen aan de map met het thema. De parameters kunnen gebruikt worden om de werking van het thema in te stellen.

  Waarschuwing! : Doe dit alleen als je echt weet wat je doet!


Eenvoudige opties

De pagina Eenvoudige opties krijg je bij het thema zelf. Het wordt aangemaakt met een twig-bestand en wat JavaScript in de map themes/options/ : https://github.com/LimeSurvey/LimeSurvey/tree/develop/templates/default/options

Deze pagina kan er bij een ander thema heel anders uitzien, ook zal elke maker van een thema een eigen stijl hebben wat betreft opmaak e.d.



Op deze pagina wordt de geavanceerde scherminvoer ingevoerd. Je kunt hier een instelling aan of uitzetten en kijken wat de gevolgen zijn. In de standaardpagina eenvoudige opties kun je het Bootswatch-thema wijzigen in “Darkly” en dan (zelfs het het eerst op te slaan) op de tab van de geavanceerde opties klikken, je ziet dan dat het veld “Cssframework Css” gewijzigd is van

{"replace": [["css/bootstrap.css","css/flatly.css"]]}
in
{"replace": [["css/bootstrap.css","css/darkly.css"]]}
De eenvoudige opties op een standaardthema zijn:

  • Ajax mode: De volgende pagina laden via Ajax (sneller) of via herladen pagina (beter als je wilt debuggen)
  • Achtergrondplaatje: Indien Ja, het plaatje pattern.png dat wordt geladen (wordt later vervangen bij een bestandskeuze).
  • Box container: Indien Nee, de vragen worden niet in een box getoond, je kunt dan vragen langer dan het scherm maken.
  • Logo: Indien Nee, de naam van de enquête wordt getoond in de kopregel, anders wordt er een (door je geselecteerde) afbeelding getoond.
  • Animeren body: Bij Ja kun je een animatie kiezen die gebruikt wordt bij het laden van de body van de enquête.
  • Animeren vraag: als bij body.
  • Animeren waarschuwing: als bij body.
  • Bootstrap thema: Het te laden Bootstrap thema, afkomstig van https://bootswatch.com/3/


De library die voor animaties gebruikt wordt (animate.css): https://daneden.github.io/animate.css/. Het animeren is optioneel en je kunt andere animaties gebruiken.

Het thema monochrome gebruikt dezelfde bootstrap kleurthema als de beheerders-interface. Ze gebruiken niet het CSS-framework vervangingssysteem, maar voegen eenvoudig een CSS-bestand toe. Dit is een alternatieve manier om met aangepaste thema's om te gaan voor aanbieders van thema's.

Inheritance

Hiervoor hebben we gezien dat een thema een ander thema kan extenden. Dit kan ook voor de configuratie van het thema. Je kunt dan voor het thema een configuratie hebben op

  • op globaal niveau (die hebben we net via de thema-lijst gezien)
  • op enquête-groepsniveau
  • minstens 1 op enquête-niveau

Elke parameter op een niveau kan erven van het bovenliggende niveau. We gaan het eerst bekijken op enquête-groepsniveau.

Op enquête-groepsniveau

Een van de mooiste uitbreidingen in LimeSurvey3 is het werken met enquête-groepen. Je kunt je enquêtes nu in groepen indelen. Ga naar de enquête-lijst en klik op de tab Enquête-groep:

De tab Enquête-groep


In deze lijst zijn er 2 knoppen. Als de groep leeg is, dan kun je de groep verwijderen. Je kunt de groep altijd wijzigen, door te klikken op de knop wijzigen ga je naar de instellingenpagina van de enquête-groep:

Wijzigen standaard enquête-groep


De derde tab op deze pagina is “Thema-opties bij deze enquête-groep”. Als je er op klikt krijg je dezelfde lijst met thema's als in de thema-lijst, er is nu maar één knop zichtbaar (de thema-editor kan alleen via de hoofdlijst worden aangeroepen).
Als je nu klikt op de optie voor het standaardthema krijg je dit scherm:

Standaard worden op enquête-groepsniveau de thema-opties geërft


  • Alles betekent dat de configuratie van de globale instellingen wordt overgenomen.
  • Op de pagina met de geavanceerde opties zie je welke velden dan worden overgenomen.
  • "Nee" in de eenvoudige opties zorgt ervoor dat je een pagina krijgt als die bij de globale opties. Je kunt dan per veld aangeven ja, nee of inherited om de optie in te stellen (ja/nee) of toch de waarde van de globale instellingen over te nemen.
Elke instelling kan de optie inherited (overerven) hebben

.

Een enquête-groep kan onderdeel zijn van een enquête-groep. De enquête-groep erft dan van de bovenliggende groep, de groep waar het dus deel van uitmaakt.

Op enquête-niveau

Als je een enquête wijzigt staat er in het linkermenu de nieuwe optie “Thema-opties”. Die geeft toegang tot een pagina waar je de opties van het thema voor de huidige enquête kunt instellen. Ook hier is, net als bij enquête-groepen, sprake over overerving (inheritance). Hier wordt geërft van de betreffende enquête-groep.

Thema-opties op enquête niveau

De praktijk

Stel dat we een thema zowel voor bedrijf A als bedrijf B gebruiken. Je stelt wat opties in op globaal niveau (bijv.: ajax aan, animeer body met een schuif, waarschuwen met een pulse). Je maakt dan een enquête-groep aan voor bedrijf A en ook een voor bedrijf B. Elke groep bevat de enquêtes die dat bedrijf doet. Je stelt hierbij in de groep alleen het logo en de achtergrond in en laat de andere opties overerven. Je kunt voor een enquête van een van de bedrijven de achtergrond aanpassen naar aanleiding van de enquête zelf, dus op enquête-niveau. Als bedrijf B dan stelt dat het pulseren lelijk te vinden en liever iets met vervagen te zien dan kun je de animatie op groepsniveau van de groep van dat bedrijf aanpassen. De enquêtes van bedrijf B gebruiken dan de nieuwe manier van animeren. Je kunt ook eenvoudig op 1 plek het logo van een bedrijf aanpassen in alle enquêtes als een bedrijf een nieuwe logo neemt.

Deze voorbeelden zijn op basis van het huidige basisthema. Maar je kunt als ontwerper met twig natuurlijk eigen opties toevoegen. Je kunt een optie “info footer” toevoegen waarin je gegevens toevoegt als bedrijfswebsite of een telefoonnummer van het bedrijf. Als een bedrijf dan verschillende afdelingen heeft met verschillende telefoonnummers, maar wel enquêtes houden dan kun je ook subgroepen per afdeling aanmaken. Het telefoonnummer wordt dan een optie.

Veel gestelde vragen over het aanpassen van een thema

We hebben hier wat vragen neergezet die door gebruikers op ons forum gesteld zijn en die je kunnen helpen om je thema aan te passen.

Aanpassen CSS/JavaScript: werken met de asset-manager ("Waarom werken mijn aanpassingen niet?")

Als je de CSS/JavaScript van een thema probeert aan te passen in een editor dan kan het gebeuren dat je wijzigingen niet meegenomen lijken te worden.


Vanaf versie 2.50 gebruikt LimeSurvey de Yii asset-manager.

Daardoor komen de CSS/JavaScript-bestanden van het thema in een submap met een willekeurige naam bijvoorbeeld tmp/1ef64ml/. Dus als je een css/js-bestand wijzigt en dat bekend is in de asset-manager, dan worden de bestanden geplaatst in een nieuwe submap. Dit voorkomt dat de gebruiker de cache van de webbrowser moet verversen, er wordt immers een nieuw bestand gebruikt, de gebruiker ziet dan direct de nieuwe versie.


De CSS-links in de header met de asset-manager:

Je ziet de referentie naar de submap tmp.


De CSS-links in header zonder asset-manager:

Zoals je ziet verwijzen ze naar de bestanden van het thema.


Een nadeel is natuurlijk wel dat je het de Asset-Manager moet vertellen dat je het bestand gewijzigd hebt, anders krijgt de gebruiker de oude versie in de toenmalige submap te zien.

Je kunt dus op meerdere manieren de CSS/JavaScript van een thema wijzigen:

  • met de LimeSurvey Thema-editor: die werkt met de asset-manager, je hoeft je dus dan daar geen zorgen over te maken dan je een oude versie krijgt bij gebruik
  • je kunt gaan debuggen: je schakelt de asset-manager uit, de css/js bestanden van je thema's worden gebruikt. Je moet dan als gebruiker de cache verversen na elke aanpassing
  • Je kunt de cache verversen: bij de algemene instellingen -> Algemeen -> Cachegeheugen voor assets wissen

Wij bevelen het gebruik van de thema-editor aan om de CSS aan te passen.


Door het gebruik van de thema-editor krijg je een goed beeld van de architectuur van het nieuwe thema-systeem. Wees voorzichtig als je de CSS in het thema fruity aanpast, de meeste definities gebruiken de selector ".fruity" (een class van de body).

Aangepaste fonts toevoegen aan het thema

De gemakkelijke weg : gebruik Google Font CDN

Het bootswatch thema gebruikt Google Font CDN. We kijken hoe dat werkt: https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/bootswatch/css/variations/flatly.min.css 

@import url("https://fonts.googleapis.com/css?family=Lato:400,700,400italic");

Daarna wordt in de CSS het Lato font gebruikt: https://github.com/thomaspark/bootswatch/blob/master/dist/flatly/bootstrap.css#L72 

body {
  ...
 font-family: "Lato";
 ...
}

Je kunt elke Google font op die manier in je eigen thema gebruiken. Je moet dan wel de font selector bij de opties in je thema verwijderen. Verwijder in options.twig deze regels: https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/options/options.twig#L209-L230

Gebruik lokaal font

Je kunt een font-bestand natuurlijk ook lokaal opslaan en dat bestand dan gebruiken in plaats van bijvoorbeeld het via Google CDN (privacy) te gebruiken. Een voorbeeld met het font noto: https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/assets/fonts/noto.css 

@font-face {
  font-family: 'Noto Sans';
  font-weight: 300;
  font-style: normal;
  src: url('./font-src/Noto/NotoSans-Regular.ttf');
}
...

Je kunt een soortgelijke definitie in je eigen css-bestand van het thema gebruiken, en het bestand NotoSans-Regular.ttf in de map css/font-src/ van je thema te plaatsen.

Gebruik dat font in de body (of een ander element) zoals boven aangegeven en verwijder de standaard-optie font-selector.

Een eigen font-selector

Je kunt nu niet eenvoudig de font-selector toevoegen aan je eigen fount in opties. Wij moeten eerst de eindgebruiker de mogelijkheid geven om aangepaste packages te uploaden (Zie : De Fruity font-selector nader bekeken.)
Hoe nu verder:

  • Voeg twee fonts (my_custom_font en my_custom_other_font) toe aan je thema, gebruikmakend van de CDN of je lokale server
  • Voeg in je css-bestand twee classes toe:


.font-my_custom_font {
 font-family: 'my_custom_font ';
}
.font-my_custom_other_font {
 font-family: 'my_custom_other_font';
}
  • In het XML-bestand van je thema, voeg een font optie toe (standaard wordt het my_custom_font) :
    <options>
        ....
        <font>my_custom_font</font>
    </options>
  • in bestand option.twig, voeg de font picker toe met de volgende regels. (Nog niet getest, klachten graag op ons forum):
            
            <div class='row ls-space margin top-15 bottom-15 action_hide_on_inherit'>
                <hr/>
            </div>
            <div class='row action_hide_on_inherit'>
                <div class='col-sm-12'>
                    <div class='panel panel-default'>
                        <div class='panel-heading'>{{ "My custom fonts" | t }}</div>
                        <div class='panel-body'>
                            <div class='form-group row'>
                                <label for='simple_edit_font' class='control-label'>{{ "Select font:" | t }}</label>
                                <div class='col-sm-12'>
                                    <select class='form-control selector_option_value_field' id='simple_edit_font' name='font'>
                                    {% if templateConfiguration.sid is not empty or templateConfiguration.gsid is not empty %}   //Shouldn't this be "theme" in stead of "template"?
                                        {% set fontOptions = fontOptions ~ '<option value = "inherit" > Inherit</option>' %}
                                    {% endif %}
                                   <optgroup  label="{{ "My Custom fonts" | t }}">
                                   <option class="font-my_custom_font"     value="custom_font"   data-font-package=""  >Custom</option>
                                  <option class="font-my_custom_other_font" value="my_custom_other_font" data-font-package=""  >Other</option>
                                  </optgroup>
                                   
                                    </select>
                                </div>
                            </div>
                        </div>
                    </div>
                </div>
            </div>


Je gebruikers zouden nu uit die 2 fonts moeten kunnen kiezen.

De Fruity font-selector

Later krijgt de gebruiker de mogelijkheid om zelf eigen asset packages te uploaden, ook voor een font package. Dan wordt het eenvoudig om een font te wijzigen.
Uitleg over Yii-Packages:
http://www.yiiframework.com/doc/api/1.1/CClientScript#packages-detail

LimeSurvey packages worden gedefinieerd in verschillende bestanden. Fonts packages: https://github.com/LimeSurvey/LimeSurvey/blob/4c40b61afb0dba8fd80154b50f5831045df8d814/application/config/fonts.php
Voorbeeld: het Noto font package is hier gedefinieerd: https://github.com/LimeSurvey/LimeSurvey/blob/4c40b61afb0dba8fd80154b50f5831045df8d814/application/config/fonts.php#L47-L53 

    'font-noto' => array(
        'devBaseUrl' => 'assets/fonts/',
        'basePath' => 'fonts',
        'css' => array(
            'noto.css',
        ),
    ),


Het bestand noto.css staat hier: https://github.com/LimeSurvey/LimeSurvey/blob/4c40b61afb0dba8fd80154b50f5831045df8d814/assets/fonts/noto.css
Merk de definitie van de class ".font-noto" onderaan op: 

@font-face {
  font-family: 'Noto Sans';
  ...
}
...
.font-noto{
    font-family: 'Noto Sans';
}


Voeg in het thema Vanilla dan het gebruik van het font noto toe door het package toe te voegen en de font-optie te definiëren:
https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/config.xml#L79 

        <packages>
             ....
            <add>font-noto</add>
        </packages>

https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/config.xml#L58 

    <options>
        ....
        <font>noto</font>
    </options>


Daarna wordt de body class font gedefinieerd met:: https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/views/layout_global.twig#L76 

<body class=" ...  font-{{  aSurveyInfo.options.font }} ... " ... >

Natuurlijk bevat het XML-bestand alleen de standaardwaarden van je thema-configuratie. Deze zijn gedefinieerd en worden gelezen in de database (table "template_configuration") (Vraag: "template_" van "theme_"?) als json-strings. Het bestand option.js file gebruikt alleen maar de waarde van de font-selector bij de eenvoudige opties om de waarde op scherm met de geavanceerde opties te wijzigen: https://github.com/LimeSurvey/LimeSurvey/blob/70a1d99cd2ebe411597231a8bc746b4ca9e19584/themes/survey/vanilla/options/options.js#L148-L174

Dus in de toekomstige versie waar je een package kunt uploaden wordt het eenvoudiger om in een script te zoeken naar alle bestaande font packages en die dan toe te voegen aan de font-selector.

Thema-opties toevoegen om het plaatsen en tonen van enquête-onderdelen te besturen

Met deze uitleg willen we tonen hoe je opties kunt toevoegen aan een uitgebreid thema om enquête-onderdelen te tonen op een bepaalde plaats. We willen de titel van de enquête op twee verschillende plaatsen kunnen tonen.

We gebruiken weer het voorbeeld van het uitbreiden van het "bootswatch" thema in LimeSurvey versie 3.4.3.

Een aangepast thema maken

  1. Extend het "bootswatch" thema zoals eerder is aangegeven.
  2. Kopieer custom.css naar het lokale thema.

Thema-opties toevoegen

  1. Kopieer de inhoud van /themes/survey/bootswatch/options/ naar /upload/themes/survey/yourThemeName/options/.
  2. Open /upload/themes/survey/yourThemeName/options/options.twig in de editor en zoek naar "{# Bootstrap Bootswatch theme #}". Voeg direct voor het parent <div class='row'> element, toe:
    		{# Aangepaste enquête-naam in navigatie-taakbalk #}
		<div class='row'>
			<div class='col-sm-12 col-md-6'>

				<div class='form-group row'>
					<label for='simple_edit_options_surveyname1' class='control-label'>Survey name in navbar</label>
					<div class='col-sm-12'>
						<div class="btn-group" data-toggle="buttons">
							<label class="btn btn-default">
								<input name='surveyname1' type='radio' value='on' class='selector_option_radio_field ' data-id='simple_edit_options_surveyname1'/>
								Ja
							</label>
							<label class="btn btn-default">
								<input name='surveyname1' type='radio' value='off' class='selector_option_radio_field ' data-id='simple_edit_options_surveyname1'/>
								Nee
							</label>
						</div>
					</div>
				</div>
			</div>
		</div>
		<div class='row'>
			<hr/>
		</div>

		{# Custom survey name below progress bar #}
		<div class='row'>
			<div class='col-sm-12 col-md-6'>

				<div class='form-group row'>
					<label for='simple_edit_options_surveyname2' class='control-label'>Survey name below progress bar</label>
					<div class='col-sm-12'>
						<div class="btn-group" data-toggle="buttons">
							<label class="btn btn-default">
								<input name='surveyname2' type='radio' value='aan' class='selector_option_radio_field ' data-id='simple_edit_options_surveyname2'/>
								Ja
							</label>
							<label class="btn btn-default">
								<input name='surveyname2' type='radio' value='uit' class='selector_option_radio_field ' data-id='simple_edit_options_surveyname2'/>
								Nee
							</label>
						</div>
					</div>
				</div>
			</div>
		</div>
		<div class='row'>
			<hr/>
		</div>
  3. Open /upload/themes/survey/yourThemeName/config.xml en voeg twee items toe aan het "options" blok, het ziet er dan uit als:
        <options>
        <ajaxmode>aan</ajaxmode>
        ...
        <surveyname1>aan</surveyname1>
        <surveyname2>aan</surveyname2>
    </options>
  4. Je moet nu twee nieuwe opties hebben in het scherm Thema-opties:

Aangepaste view voor enquête-titel in de taakbalk

  1. Maak de map /upload/themes/survey/jeThemaNaam/views/subviews/header/ aan.
  2. Kopieer /themes/survey/vanilla/views/subviews/header/nav_bar.twig naar die map.
  3. Open /themes/survey/vanilla/views/subviews/header/nav_bar.twig en zoek naar "{# Logo option #}". Wijzig het IF-statement daaronder voor het logo/survey-name, zodat het er uit ziet als:
    		{# Logo option #}
        {% if( aSurveyInfo.options.brandlogo == "on") %}
            <div class="{{ aSurveyInfo.class.navbarbrand }} logo-container"  {{ aSurveyInfo.attr.navbarbrand }}  >
                {{ image(aSurveyInfo.options.brandlogofile, aSurveyInfo.name, {"class": "logo img-responsive"}) }}
            </div>
        {% endif %}
        {% if( aSurveyInfo.options.surveyname1 == "on") %}
            <div class="{{ aSurveyInfo.class.navbarbrand }}"  {{ aSurveyInfo.attr.navbarbrand }} >
                {{ aSurveyInfo.name }}
            </div>
        {% endif %}
  4. Voeg iets als onderstaande toe aan /upload/themes/survey/jeThemaNaam/css/custom.css:
    .navbar-brand {
    line-height: 60px;
    font-size: 32px;
}
  5. Zet de thema-optie tonen enquête-naam in taakbalk op "Ja".
  6. Je zou nu moeten zien:

Aangepaste view voor enquête-titel onder voortgangsindicatie

  1. Maak de map /upload/themes/survey/jeThemaNaam/views/subviews/survey/group_subviews aan.
  2. Kopieer /themes/survey/vanilla/views/subviews/survey/group_subviews/group_container.twig naar die map.
  3. Open /themes/survey/vanilla/views/subviews/survey/group_subviews/group_container.twig en voeg een <h1> element voor de enquête-titel toe. Het lijkt dan op dit:
    <div class="{{ aSurveyInfo.class.groupcontainer }} space-col" {{ aSurveyInfo.attr.groupcontainer }}>
 
    {# Custom survey name #}
    {% if( aSurveyInfo.options.surveyname2 == "on") %}
    	<h1 class="custom-survey-name">{{ aSurveyInfo.name }}</h1>
    {% endif %}
 
    {# Group Name #}
    {{ include('./subviews/survey/group_subviews/group_name.twig') }}
 
    {# Group Description #}
    {{ include('./subviews/survey/group_subviews/group_desc.twig') }}
 
    {#
        PRESENT THE QUESTIONS
 
        This is the main part. It will render each question for this group
     #}
 
    <!-- PRESENT THE QUESTIONS -->
    {% for  aQuestion in aGroup.aQuestions %}
         {{ include('./subviews/survey/question_container.twig') }}
    {% endfor %}
 
    <!-- Hidden inputs -->
    {% if aGroup.show_last_group == true %}
        <input type='hidden' name='lastgroup' value='{{ aGroup.lastgroup }}' id='lastgroup' />
    {% endif %}
 
    {% if aGroup.show_last_answer == true %}
        <input type='hidden' name='lastanswer' value='{{ aGroup.lastanswer }}' id='lastanswer' />
    {% endif %}
</div>
  4. Voeg iets als onderstaande toe aan /upload/themes/survey/yourThemeName/css/custom.css:
    .navbar-brand {
    line-height: 60ph1.custom-survey-name {
	margin: 0;
	text-align: center;
}
  5. Zet de thema-optie enquête-titel onder voortgangsindicatie op "Ja"
  6. Je zou nou moeten zien :

Downloads

Een nieuw thema aanmaken

Moet nog uitgewerkt worden.

Op dit moment geven we alleen enkele tips.

Thema structuur

Bestanden en mappen

Wanneer je een nieuw thema maakt, hoef je niet de structuur (bestand/map/css/js) van Vanilla te gebruiken. De verplichte css / js is standaard al toegevoegd (je kunt deze desgewenst nog steeds verwijderen).

De bestanden die je thema moet hebben zijn de lay-outbestanden:

  • layout_global.twig: maken van de pagina's voor het invullen van de enquête.
  • layout_survey_list.twig: maak de enquête-lijst (als dit thema als standaard is ingesteld).
  • layout_errors.twig: gebruikt om fouten weer te geven die het opbouwen van enquêtes blokkeren (verkeerde onderzoeks-id, lege groep in preview-groep, enz.).
  • layout_user_forms.twig: maakt gebruikersformulieren o.a.: token (deelnemer aan de enquête) en registreren.
  • layout_print.twig: gebruikt om de enquête af te drukken als pdf.
  • layout_printanswers.twig: print de antwoorden.

De inhoud van die bestanden, de bestanden die ze wel of niet bevatten, jij bepaalt het. Alle andere bestanden en mappen die je op Vanilla vindt zijn puur optioneel, voel je vrij om je code te organiseren zoals jij dat wilt.

Als je de frontend-rendercode leest, zie je dat die bestandsnamen er rechtstreeks in staan. Dat is waarom ze verplicht zijn.

Bijv.: https://github.com/LimeSurvey/LimeSurvey/blob/2398dda3b425da1a37d4611cd7963d39ac739987/application/helpers/SurveyRuntimeHelper.php#L462

Inhoud

In Vanilla's layout_global.twig, zie je dat er een variabele "include_content" gebruikt wordt om te bepalen wat er getoond wordt https://github.com/LimeSurvey/LimeSurvey/blob/2398dda3b425da1a37d4611cd7963d39ac739987/themes/survey/vanilla/views/layout_global.twig#L114-L115 

                    {% set sViewContent =  './subviews/content/' ~ aSurveyInfo.include_content ~ '.twig' %}
                    {% include './subviews/content/outerframe.twig' with {'include_content': sViewContent } %}

aSurveyInfo.include_content geeft aan welke actie momenteel uitgevoerd wordt. Toon je vragen? Resultaat tonen? Alles laten zien? enz. Zoals je ziet, creëren we in vanilla één bestand dat we includen. Dus als je de lijst met acties wilt weten, bekijk dan de views/subviews/content in de map vanilla en verwijder de extensie "twig": Https://github.com/LimeSurvey/LimeSurvey/tree/2398dda3b425da1a37d4611cd7963d39ac739987/themes/survey/vanilla/views/subviews/content

  • clearall.twig
  • firstpage.twig
  • load.twig
  • mainrow.twig
  • main.twig
  • optin.twig
  • optout.twig
  • outerframe.twig
  • printanswers.twig
  • quotas.twig
  • register.twig
  • save.twig
  • submit_preview.twig
  • submit.twig
  • userforms.twig

Als je al een thema voor 2.x-versies van LimeSurvey hebt gemaakt, zul je merken dat de meeste van hen overeenkomen met de oude pstpl-bestanden voor LimeSurvey 2.x. Nogmaals, er is geen verplichting voor je in je thema om die bestanden, met die namen, in deze map aan te maken. Je kunt bijvoorbeeld gewoon een gigantische switch toevoegen in layout_global.twig met de gewenste HTML voor elke actie.

Het manifest config.xml

Het manifest van het thema bevat de belangrijkste informatie over het thema. Wanneer je een thema installeert, wordt de inhoud van het manifest in de database geladen in twee verschillende tabellen: template en template_configuration. Dus elke keer als je het manifest van een thema wijzigt, moet je het verwijderen en opnieuw installeren (of alleen opnieuw instellen). Omdat dit proces vervelend is bij het ontwikkelen van een thema, kun je het direct gebruiken van het XML-bestand forceren in plaats van het gebruik via de database. Hiertoe schakel je in config.php de debug-modus en ook de 'force_xmlsettings_for_survey_rendering' in.

De sectie metadata

Vrij eenvoudig: alleen de belangrijkste informatie over het thema. Het wordt in de tabel templates_configuration gepusht 

    <metadata>
        <name>De naam van het thema</name>
        <title>De titel van het thema</title>
        <creationDate>10/05/2019</creationDate>
        <author>Je naam</author>
        <authorEmail>your@email.org</authorEmail>
        <authorUrl>http://www.yourwebsite.org</authorUrl>
        <copyright>Copyright </copyright>
        <license>Licentie van je thema</license>
        <version>Versie van je thema</version>
        <apiVersion>3</apiVersion>
        <description>Beschrijving van je thema</description>
        <extends>parent_theme</extends>
    </metadata>


Wat opmerkingen:

  • Naam: zal worden gebruikt als een sleutel in de database. Het moet dus uniek zijn en er mogen geen speciale tekens in voorkomen (ook geen spaties). Let op: er wordt geen rekening gehouden met hoofdletters.
  • Titel: wordt gebruikt om de themanaam in de verschillende lijsten weer te geven. Het mag speciale tekens bevatten.
  • Beschrijving: wordt gebruikt in de hoofdlijst van het enquête-thema. Het kan speciale tekens bevatten, en zelfs HTML-code.
  • Extends: optioneel, het definieert de bovenliggende thema's. Dus als een bestand niet aanwezig is in dit thema (twig / js / css / jpg, etc) wordt het overgenomen uit het bovenliggende thema (de parent)


Als je een van de 3 standaardthema's (Vanilla, Bootswatch, Fruity) hebt uitgebreid, kun je de waarde "extends" van de ene parent naar de andere veranderen. Natuurlijk moet je het thema opnieuw instellen.



De sectie files

Dit is een belangrijke. Het wordt in de tabel template-configuration in het veld files_css, files_js, files_print_css als json-arrays opgeslagen.

Bijv .: het bestandsgedeelte van het thema 'Material Premium': 

    <files>
        <css>
            <add>css/bootstrap-material-design.css</add>
            <add>css/ripples.min.css</add>
            <replace>css/ajaxify.css</replace>
            <replace>css/theme.css</replace>
            <replace>css/custom.css</replace>
            <remove>awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css</remove>
        </css>
        <js>
            <replace>scripts/theme.js</replace>
            <replace>scripts/ajaxify.js</replace>
            <add>scripts/material.js</add>
            <add>scripts/ripples.min.js</add>
            <replace>scripts/custom.js</replace>
        </js>
        <print_css>
            <add>css/print_theme.css</add>
        </print_css>
    </files>

Alle CSS / JS-bestanden in deze sectie worden (in ajax-modus) bij het starten van de enquête geladen. (Als de ajax-modus is uitgeschakeld, worden alle bestanden uiteraard op elke pagina opnieuw geladen).


Ze worden toegevoegd aan een Yii Asset-pakket op basis van de naam van het thema. Dus als Asset Manager is ingeschakeld (debug-modus is uitgeschakeld), worden die bestanden gekopieerd naar de tmp-map met de rest van het thema (zodat je het relatieve pad in de CSS en JS kunt gebruiken om de afbeeldingsbestanden te gebruiken). Asset-manager in Yii: https://www.yiiframework.com/wiki/148/understanding-assets Packages in Yii: http://www.yiiframework.com/doc/api/1.1/CClientScript#packages-detail


Ze zullen het overervingssysteem gebruiken. Dit betekent dat als je een CSS / JS-bestand aan een thema toevoegt, maar het is niet in het thema aanwezig er in de mogelijk meerdere bovenliggende thema's van dit thema zal worden gezocht. De eerste die wordt gevonden, zal worden gebruikt. Dus als een gebruiker je thema uitbreidt via de thema-editor, zullen al die bestanden worden overgenomen in zijn thema. De keywords verwijzen naar dit systeem van inheritance.


  • add: het zal het bestand toevoegen aan het thema en aan al zijn onderliggende thema's.
  • replace: het zal het bestand van zijn bovenliggende thema vervangen.
  • remove: het zal het bestand uit elk package verwijderen, zelfs uit het core-pakket (sinds 3.14)
Je kunt in config.php 'force_xmlsettings_for_survey_rendering' instellen, zodat de configuratie wordt gelezen vanuit XML in plaats van uit de database (geen reset nodig). Dit maakt het eenvoudiger om wijzigingen van de XML-bestanden te testen en zal voorkomen dat je het thema bij elke wijziging van de XML moet verwijderen en installeren


Enkele opmerkingen over de keywords:


Inheritance tips

Zoals eerder uitgelegd, kan het keyword "add" verwijzen naar een bestand in een parent van het thema. Dus je kunt een bestand in deze sectie "toevoegen", en nog steeds het bestand uit de parent gebruiken. Er wordt gekeken naar alle bovenliggende thema's en de eerste die wordt gevonden, wordt gebruikt. Als het bestand niet kan worden gevonden en de debug-modus is ingeschakeld in de configuratie, en de javascript frontend debug-modus is ingeschakeld bij de de algemene instellingen, krijg je een waarschuwing in het console. Bijv .: als we in een thema my_theme toevoegen: <add> css / unexisting.css </add> , zien we in het console: 

 (¯`·._.·(¯`·._.· Theme Configuration Error  ·._.·´¯)·._.·´¯) 

Can't find file 'css/unexisting.css' defined in theme 'my_theme'

Als de debug-modus is uitgeschakeld, is er helemaal geen fout te zien. De verkeerde toevoeginstructies worden alleen maar overgeslagen.


Wanneer gebruik ik add, replace of gebruik ik de parent (bovenliggende thema)?

Ten eerste: 'add' en ' replace' doen eigenlijk hetzelfde. We maken dit onderscheid om het onszelf duidelijker te maken wat de bedoeling is.


Je kunt geen bestand met dezelfde naam als het bovenliggende thema toevoegen: dan wordt dat bestand vervangen, bijv.: Als je een bestand "my_mother_theme/foo.css" hebt en je voegt een bestand met de naam "foo.cs" toe aan het onderliggende thema, dan wordt alleen "daughter_theme/foo.css" aan het thema toegevoegd. Als je "my_mother_theme/foo.css" wilt behouden, kies je gewoon een andere naam voor "daughter_theme/foo.css", zoals "daughter_theme/bar.css". Dus het keyword "add" kan worden gebruikt als een "replace" -woord.


Als je je afvraagt waarom: dit maakt het automatisch genereren van een overgeërfd thema gemakkelijker, het kopiëren van de bestandssectie werkt out of the box (het is niet nodig om "add" te hernoemen naar "replace" wanneer je het bestand uitbreidt).


We gebruiken weer het thema Fruity als voorbeeld. De sectie css: 


        <css>
            <add>css/variations/sea_green.css</add>
            <replace>css/animate.css</replace>
            <replace>css/theme.css</replace>
            <replace>css/custom.css</replace>
        </css>


Als je het bestand custom.css in fruity bekijkt, is het precies hetzelfde als het vanilla-bestand. We kunnen het bestand custom.css binnen fruity verwijderen, het bestand met vanilla wordt dan gebruikt. We kunnen het statement <replace> custom.css </replace> verwijderen van het Fruity-manifest, dan wordt vanilla custom.css geladen.


Dus waarom gebruiken we de verklaring <replace>custom.css</replace> in het manifest fruity? Het antwoord is eenvoudig: omdat we willen dat de eindgebruiker het thema fruity kan uitbreiden, het bestand in zijn lokale thema kan wijzigen en dit gewijzigde bestand van zijn overgenomen thema kan laden. Om het te begrijpen, moet je fruity uitbreiden en naar het uitgebreide thema kijken. Het uitgebreide thema heeft niet eens het bestand custom.css. Dus dat van fruity zal worden gebruikt. Maar: als de gebruiker dit bestand in het uitgebreide thema maakt (door in de themabewerker op "extend" te klikken), wordt dit bestand uit zijn thema geladen.


Dus in het algemeen: Als je een nieuw thema maakt zonder een thema uit te breiden, gebruikt je 'add' om je CSS / JS-bestanden toe te voegen. Gemakkelijk. Als je een thema maakt dat een ander thema uitbreidt, en je niet wilt dat de gebruikers het css / js-bestand uit het bovenliggende thema kunnen uitbreiden: gebruik dan niet 'add' in je manifest. De bestanden worden nog steeds geladen vanuit de bovenliggende thema-configuratie. Als je een thema maakt dat een ander thema uitbreidt en je een bestand wilt vervangen door het bovenliggende thema: gebruik dan 'replace'. ('add' heeft hetzelfde resultaat) Als je een thema maakt dat een ander thema uitbreidt, als je een bepaald bestand niet vervangt door css / js, maar je wilt dat de gebruikers dit bestand kunnen uitbreiden: gebruik dan 'replace' in je manifest voor dit bestand. Zelfs als je het bestand niet vervangt, gebruik je 'replace' in het manifest: je staat de gebruiker toe om het te doen zoals hij het wil doen.


Alleen dit laatste geval is verrassend, de andere gevallen zijn triviaal.


Je kunt ook CSS- en JS-bestanden rechtstreeks van de twig-code registreren. Die bestanden worden alleen geladen als het twig-bestand wordt gevraagd. Als je wilt dat de gebruikers die JS / CSS-bestanden van de thema-editor kunnen erven, vergeet dan niet om de functies Template:RegisterTemplateCssFile ('my style.css') en Template:RegisterTemplateScript ('my script.js') te gebruiken . Als je deze functies niet gebruikt, werkt je thema mogelijk, maar het overerven wordt verbroken. Het is dezelfde logica als de functie Template:Image ('my picture.jpg')

Het keyword remove

Het keywoord 'remove' is beschikbaar sinds versie 3.14. Hiermee kun je elk CSS / bestand uit elk package verwijderen, zelfs de kernbestanden. Het wordt gebruikt in Material Premium Theme om de Awseome Bootstrap Checkbox-bestanden te verwijderen: 

<remove>awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css</remove>

dus zou je dezelfde syntax moeten gebruiken als het package-bestand (bijv .: "awesome-bootstrap-checkbox.css" zou zonder het pad niet werken). Je vindt de volledige lijst met standaard packages en hun bestanden in /application/config/packages.php en config / third_party.php. Bijvoorbeeld, voor awesome-bootstrap-checkbox.css: https://github.com/LimeSurvey/LimeSurvey/blob/2398dda3b425da1a37d4611cd7963d39ac739987/application/config/packages.php#L54-L56 

        'css'=> array(
            'awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css',
        ),


Een andere manier om de exacte naam te vinden die in de 'remove'-tag moet worden gebruikt, is om asset-manager in te schakelen (de debug-modus uit te schakelen of 'use_asset_manager' => true in de config in te stellen). Vervolgens zal het pad dat je gebruikt net na de willekeurige map in de tmp-directory zijn. Bijvoorbeeld, voor awesome-bootstrap-checkbox.css: 

<link rel="stylesheet" type="text/css" href="/tmp/assets/cbc4e3cb/awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css" />

Bestanden die je niet moet verwijderen:

jquery-3.1.1.min.js : vereist

jquery-migrate-3.0.0.min.js : vereist

survey.js : vereist

moment-with-locales.min.js : vereist voor o.a. vraagtype Datum

em_javascript.js : vereist voor ExpressionScript JavaScript

De sectie options

Dit gedeelte is gerelateerd aan de optie van het thema. Het zal worden gebruikt om de ingediende "opties" van de tabel template_configuration als een json array te vullen.

Meer informatie

Enkele opmerkingen

NB: als je het XML-bestand van een thema aanpast, dan moet je de registratie van het thema verwijderen en opnieuw installeren om de wijziging in te laten gaan.

NB: je kunt dat voorkomen door niet de database te laten gebruiken maar de XML. Je kunt dat instellen door in config.php de debug mode aan te zetten en de onderstaande regel niet op commentaar te zetten:

'force_xmlsettings_for_survey_rendering' => true, // Maak deze regel actief als je het XML-bestand wil gebruiken in plaats van de database (voor gemakkelijker ontwikkeling van het thema)

Wees voorzichtig: alles wordt geladen uit XML (inclusief opties, enz.).


NB: als je handmatig CSS/JavaScript-bestanden aanpast (niet via de thema-editor) en de debug-mode is off, kun je nu afdwingen dat de cache wordt gewist (flushed). In "Instellingen de tab "Algemeen" klik op de knop "Cachegeheugen voor assets wissen".

OPMERKING: als je de sectie verwijdert

Retrieved from "http://manual.limesurvey.org/index.php?title=New_Template_System_in_LS3.x/nl&oldid=174198"