Theme editor/pt

=Introdução=

LimeSurvey has a basic template and style system providing a theme-like capability found in many browser-based applications. They are simply termed Templates here. The Templates allow control over the look and feel of pages during a survey. A survey administrator can select the template to use for each survey to thus personalize that survey's look and feel. Changes to a Template can be as simple as adding a unique logo on the welcome page, changing background colors, or maybe new text colors for specific types of questions.

LimeSurvey comes with a set of templates right out of the box. These initial templates are defined by directories within the LimeSurvey installation "templates" directory. Each template has it's own directory. Within the main directory of a template are numerous files: templates (.pstpl), cascading style sheets (.css), images (.jpg or .png) and maybe others.

Like in other theme-based systems, fragments of HTML code are stored in the .pstpl template files. These fragments are read in and used to construct the page to display to the end user during the operation of a survey. Often keywords surrounded by curly braces are included in the files that are then replaced with the relevant text. The following gives an example of a template file content and its result when used in a survey page:

One gets a result that looks like:

My New Survey This is a survey written by me to find out what sort of chocolate people like.

Templates, being HTML code, tend to define the positioning and type of text to be displayed and similar structural features of the page. They often reference or include other files. Most reference a common cascading style sheets (CSS) file that defines the font style, color, size, background and similar parameters common to all pages in the survey. Style sheets reference HTML class parameters that are associated with the various types of objects in the HTML code. This allows the style sheet to describe once how to display each of the many types of text or other objects that may appear in multiple places. There are unique classes for each question type in LimeSurvey and thus giving detailed control over the appearance of each. Image files, like logos or special progress-bar constructors, may be referenced as well in the Template file. Finally, special Keywords in curly braces are replaced with text defined in the Survey for each of its corresponding language translations (for example, the Survey Title or Question Text for each language defined).

If you create a new custom template, please consider contributing it back to the LimeSurvey community, and make it available to others. With your help, we can grow our repository of templates, surveys, and other add-ons, to make LimeSurvey even better! See our LimeSurvey template repository where you can share your templates.

=Creating a new template=

To be able to create a new template (or edit an existing template), you need Template Editing user permission in LimeSurvey as well as permission to manipulate the files in the underlying operating system hosting your LimeSurvey installation.

Note of Warning: As template changes can affect all surveys in an installation. Templates are an advanced feature that can take some experimentation to get correct if you are not familiar with HTML code methods.

The preferred way to create a new template is through the Template Editor (see below) via the web Admin interface. Some people may like to work directly with template files so that they can use their favorite text editor instead of the web interface. In this case, still use the Template Editor to first create your new template. This will create a new base template with all the files you need in the LimeSurvey_web_root/upload/templates/your_new_template directory. From there you can use your text editor to manually adjust the template files.

Permissions Note: on unix/linux systems, these template files will be owned by the group and user who the web server is running as (may be "www" for some systems). So make sure you have access to edit these files, and when you save them make sure they don't change ownership, so you can still use the web Template Editing interface if needed

Template files may seem complex to understand at first. You have to likely understand HTML code, possibly CSS.

A number of the 'public' elements of LimeSurvey can be adjusted by a series of templates. The next section provides a very brief explanation of these templates.

=The LimeSurvey template editor=

To ease the understanding and quick update of a Template, LimeSurvey provides a Template Editor in the main administrative toolbar of the application. This Template Editor is only available to users given the privilege in the User Security settings and to superadministrators. A template effects all surveys and can render a survey inoperable if not constructed properly.

The LimeSurvey template editor allows you to edit the contents of your templates online. Start the Template Editor by clicking on Template editor in the Configuration menu.



The main screen is similar to the LimeSurvey Survey Administration screen. It allows you to select the template to edit/view. Once this has been selected you can then select from one of the different public survey pages. You are then presented with a list of the template files that make up that particular page.



The template menu

 * Create: Allows you to create a new template. To not have to start from scratch the template 'default' is copied.
 * Import: Allows you to import a template from a ZIP file.
 * Export: Allows you to export the current template to a ZIP file.
 * Copy: Allows you to make a new template by copying the current one.
 * Rename: Allows you to change the name of the template. Generally used after copying  or importing a template.

The "Screen" drop-down list on the right allows you to choose which particular survey page insie that template you are currently looking at.

Import/export/copy a template
When you export a template, this will create a ZIP-file archive with all the files your template consists of (.pstpl files, images, css files, ...). You can simply import the exported zip-file at other LimeSurvey systems by using the import feature or you can manually copy the archive to another installation and extract it into the corresponding template directory there.

However it is preferred use the LimeSurvey template import/export/copy functions in the template editor.

Page Structure / Template Use

 * The Welcome Page: startpage.pstpl, welcome.pstpl, privacy.pstpl, navigator.pstpl, endpage.pstpl
 * The Questions Pages: startpage.pstpl, survey.pstpl, startgroup.pstpl, groupdescription.pstpl, question.pstpl, endgroup.pstpl, endpage.pstpl
 * The Final Page: startpage.pstpl, assessment.pstpl, completed.pstpl, endpage.pstpl

Template Files
The following template files are used to produce your public survey and must exist in any new template folder you create:
 * startpage.pstpl: Produces the start of each html page. It starts at the " " tag, and should not contain the " " tag. This 'very beginning' of a standard html page is written by the scripts. Please ensure that your startpage.pstpl files contains a tag, even though many browsers do not require strict adherence to the W3 HTML standards, the LimeSurvey script needs to find a tag, to run certain javascript elements. It is not expected that many 'keywords' will be used in the startpage.pstpl file, however you may wish to put the {SURVEYNAME} into the title. The startpage.pstpl file can contain code that ends in the corresponding endpage.pstpl file, so you can start a table in this file and close the table in the endpage.pstpl file. The startpage.pstpl and endpage.pstpl files wrap around every possible page used by LimeSurvey.
 * survey.pstpl: This template is the second used on most pages, and provides a space to put the survey name and description. This template does not have a corresponding 'closing' template, and subsequently you should close all tags opened in this template file (ie: don't leave a table open here because there is nowhere else to close it)
 * welcome.pstpl: This template is only used in the welcome screen (which is also on the main page for 'all in one' surveys). You can use this to print out the welcome text, and other information that should be provided in the introduction. Like the 'survey.pstpl' file, there is no corresponding 'closing' template, so all tags opened in this template file should be closed as well.
 * startgroup.pstpl: This template can provide a 'summary' wrap around for questions within a group. It has a matching 'endgroup.pstpl' template that can be used to close any opened tags in this file, so you can open a table within this.
 * groupdescription.pstpl: This template file is used to display a description of a group. Please note that in the survey settings you can set if the group description should be shown or not. If not then this file is not included at all.
 * question.pstpl: This file contains the question, answer and help text sections of your survey, and in the "group by group" and "all in one" surveys this template is cycled repeatedly with each question. There is no corresponding closing file for this and all tags should be closed.
 * question_start.pstpl: This file contains the individual elements found at the start of a question. It is included within 'question.pstpl' via the {QUESTION} keyword. It is intended to allow template designers more control over the layout of a question. This template sits outside the normal templating system and was superseeded (as of LS1.87). All keywords from this template are now available directly in question.pstpl. NOTE: templates using question_start.pstpl will still work at least for a couple more versions of LS 1.x
 * completed.pstpl: This page is displayed as the final page when the survey responses have been saved and the survey is over. It can be used to display a "forwarding link" as set in the survey setup.
 * endgroup.pstpl: This file closes the group, and can be used to close off any tags opened in the startgroup.pstpl file
 * navigator.pstpl: This file contains the buttons that navigate through the survey, "next", "prev", "last", "submit", "save so far"  and the "clear all" link. It is used in all pages except the completed page.
 * printanswers.pstpl: This file has the HTML wrapper for the print version of the survey.
 * print_group.pstpl: This file is the same as startgroup.pstpl endgroup.pstpl but for the print version of the survey.
 * print_question.pstpl: This file is the same as question.pstpl but for the print version of the survey.
 * print_survey.pstpl: This file is the same as survey.pstpl but for the print version of the survey.

CSS and Javascript
Two files are allways used for template : template.css for css and template.js for javascript.
 * {TEMPLATECSS}: Add lines for default css, template.css and template-rtl.css for rtl language.
 * {TEMPLATEJS}: Add lines for default javascript files, template.js and all js files needed for LimeSurvey.

Using Bootstrap
LimeSurvey has Bootstrap 3 embedded, so you can style all your templates with the well documented Bootstrap classes. For more information please refer to the Bootstrap documentation.

Also included is the Awesome-Bootstrap-Checkbox plugin. With it you can use the typical Bootstrap color-classes (info,warning,danger,etc.) also with the suffix "-checkbox", or "-radio", though styling checkboxes and radios as you prefer.

Replacing default css or javascript
Some question use specific files for javascript or css. If you need to replace a function, you add to use cascading system. For javascript function, last function read is the function used.

Other Template Files
The privacy.pstpl, invitationemail.pstpl, reminderemail.pstpl and confirmationemail.pstpl are no longer used by LimeSurvey and defaults are instead set in the applicable language files. The email messages can now be edited on a survey by survey basis.

Standard Pages
There are ten standard pages that a survey participant may see in the course of taking or accessing the LimeSurvey application. Each is constructed from a number of common Template files from the Template specified in the survey's settings. The table below indicates which template files are used in constructing each of these pages.

* NOTE: In versions 1.90 and up this replaces question.pstpl AND question_start.pstpl. If you are using an old custom template, you need to add the following line to the beginning of question.pstpl: And then add the corresponding closing tag to the end of question.pstpl:

* NOTE: In version 1.91 and earlier, LimeSurvey js files are not included by the template. In version 2, you have to use {TEMPLATEJS} in your one of your template file to add the link to the js file. You can add it in startpage.pstpl or in endpage.pstpl. You can remove the {TEMPLATEURL}/template.js line and you have to replace with {TEMPLATEJS} to update a personal template.

The File Control Section
In the "file control" window on the left, you can click on one of the template files that is used to compile the page. The HTML code for that file will then appear in the "Now editing" window in the center. If the template is editable (determined by directory permissions) you can then make any changes and save them.

The "Other files" window shows a list of all other files in the template directory. You can use the right side to upload and select image files (your pics, logos,...) or other files needed to create your template. Note: Instead of a link directly to each picture in your template you can use the field string {TEMPLATEURL}. So instead of:

You can use :

In LimeSurvey versions before 2.50 use:

A "sample" of the template page you are editing will be visible at the bottom of the screen. There is no way to to delete a template from the template editor. This must be done by accessing the underlying directory and deleting the file there.

Note: The shipped templates cannot be edited using the template editor. If you want to modify them, create a copy first and modify the copy.

Location of template files
LimeSurvey stores each of the 'standard' templates in their own distinct sub-directory within the /templates directory that is kept in the public directory with the other LimeSurvey public files. Customized user templates are stored in the /upload/templates directory.

To create a new template, use the according icon in the template editor.

There should ALWAYS be a "default" directory in the templates directory. This template is used by default and as a fall-back if a template folder doesn't exist, or can't be found. The "default" directory comes with the package.

You can use any image files that you upload into the template management area with syntax like this:

=Styling questions with CSS=

Styling of questions in CSS has become much easier. Each question type now has a unique class. Mandatory question's also have an additional mandatory class. For example, for a non-mandatory question:

and if the question is mandatory

and if the question is mandatory but the user didn't answer it or if there is validation on a question

and if the question has validation applied but the user hasn't answered correctly

Global classes for question part
These classes are used for each question type. Some question types use only one or two class, but others can use much more.

Some example of question part with classes
text-short question type: Multiple short text Array question type

The full list of validation classes
Note:  Prior to 1.92, only .mandatory and .input-error classes were available.

These apply to the help and/or validation tip messages so that each type can be individually styled.

The .hide-tip option and .input-error options, by default, interact so that you can have validation tips start hidden, but appear when there validation errors, and disappear again when those errors are rectified.

All of these are designed to eliminate the need for pop-up alert messages. Instead, tips can appear/disappear as needed, and are color-coded to indicate whether the answers pass the validation criteria.

Furthermore, when you first visit a page that has unmet validation criteria, you can color-code the tips in a pleasing color to show which validation criteria have not been med; then re-display the page using a harsher color if the person submits the page with lingering validation errors.

Importing styles into your custom template
The custom question styles are near the bottom of each template's CSS file and start with:

If you're styling your own custom template, you should be able to copy everything after the above from templates/default/template.css (for tables based layouts) or /templates/limespired/template.css (for CSS based layouts) into your own style sheet without any impact on your other styles.

Internet Explorer conditional style sheets
Because of the marked discrepancies in rendering between IE6, IE7 and most other browsers, there are special IE conditional style sheets included for each template.

You should include the above code within your startpage.pstpl and copies of both the IE style sheets from either /templates/default/ or /templates/limespired for Tables base layout and CSS based layout respectively.

Note: If you copy the styles into your own style sheet you will almost certainly need to tweak them.

Alternative solution for Internet explorer
You can put conditional class for body in startpage.pstpl, and use this class in your template.css. This method is used in citronade template. Adding a js / no-js class to have javascript / no javascript system.

And in template.css use

Right-to-Left (RTL) Languages and justify
The text editor within LimeSurvey is able to format RTL Text. However, the editor itself shows the RTL language in a left to right format when justified. This is just an editor display issue. The RTL and justified question or text will display correctly from right to left, even when justified, in your survey or on preview.

Keywords
Keywords within a template file get replaced by the current survey information. They are surrounded by curly brackets, for example: {SURVEYNAME}

The following strings will be replaced by LimeSurvey when parsing the template file and presenting it to survey users. These field strings will work on almost every template except for the 'Completed Page'. (Most of these strings can be found in the common.php file. If it's not there, look in the index.php file.)

Input/Buttons
Each "input" type in a survey has been given its own class name, so that you can add CSS to your "startpage.pstpl" file, and have some control over the appearance of form buttons and inputs. These class names are as follows:
 * submit (Submit Buttons)
 * text (Text Inputs - for short free text, date and numerical type)
 * answertext (Text of answers)
 * radio (Radio Buttons)
 * checkbox (Check Boxes)
 * select (Select / List Boxes)
 * textarea (Large text inputs - for long free text)
 * clearall (The "Exit and Clear Survey" link)
 * rank (The rank style question. Doesn't set the colour of the select box or the text boxes (these are set by relevant section above) but does allow changing of background colour, text colour and size etc for the rest of the ranking question)
 * graph (The "percentage completed" graph table)
 * innergraph (The table inside the graph table - this contains the 0% and 100% text. Use this for changing the size of this text)
 * question (General settings for any question that is displayed within a table. Generally you should use this to make sure that their font size and colour is the same as you have used elsewhere as a default)
 * mandatory  (Mandatory questions)
 * input-error (User input error - for if a user has made a mistake with a mandatory question or question with validation)
 * array1 and array2 (These two styles are cycled when presenting the range of answers for an array type question. This allows you to set an alternating background colour for these question types. Array1 is also used for the column headings in these question types)
 * errormandatory (Sets the colour and style of the "This question is mandatory" error message)
 * warningjs (Sets the colour and style of the warning message displayed if the participant's browser has javascript disabled)

There are also some elements that can be accessed using the ID of the element (#ID in CSS):
 * surveycontact (The contact message shown on the start page)
 * tokenmessage (used for messages inside the survey, e.g. the session expired error message)

An example of using these classes with style sheets can be found in the "bubblegum" template that comes with the LimeSurvey application.

Because you can edit all the HTML aspects, there's no reason to surround your templates with a  and then define a css for that new_name class.

Styling the progress bar
Before version 1.87:

The chart.jpg file is a simple one pixel image file which is used to create the progress bar image in the 'PERCENTCOMPLETE' table. If the file does not exist, LimeSurvey will use the default 'maroon' coloured image in the public directory. If you want to create a bar to match your own colour scheme, then you should save the color in this file. Remember it should be a JPEG file, 1 pixel x 1 pixel, in the colour desired.

Version 1.87 and newer:

The progress bar appearance can be modified with CSS.

To change the background colour of the bar, add something like the following to the end of your template.css file.

To change the border colour of the bar, add something like the following to the end of your template.css file.

Advanced Features Available to Developers
Starting with version 0.99, LimeSurvey has integrated some user-made patches that allow for some special changes. These very advanced features generally require changes to the underlying code base of LimeSurvey and should be done carefully so as not to introduce security holes.

Basic CMS Integration support
Deprecated: This function is not available anymore in version 2.0 or later

To be able to integrate LimeSurvey into another CMS, use the following options in config.php:

// Set $embedded to true and specify the header and footer functions if the survey is to be displayed embedded in a CMS

$embedded = false; $embedded_inc = "";               // path to the header to include if any $embedded_headerfunc = "";        // e.g. COM_siteHeader for geeklog $embedded_footerfunc = "";        // e.g. COM_siteFooter for geeklog

Set $embedded = true; to enable CMS-embedding. By using the $embedded_inc variable one can include their own .php files. By setting $embedded_headerfunc or $embedded_footerfunc, one can call functions from within included files that output the relevant headers or footers instead of LimeSurveys default ones.

Support for your own Javascript functions
Some users may need to run Javascript on the survey pages, but calling checkconditions in the BODY element made it impossible to do so. This call has been replaced with a small JavaScript function in the HEAD that sniffs for the existence of checkconditions and template_onload before calling each. This way a template author can create their own template_onload function in the HEAD that replaces the default one.

Version 1.87 and newer:
 * Disable XSS filter - in Global settings -> Security, set "Filter HTML for XSS" to No.
 * Enter your script in the source of a question or group description.
 * There are more details in the workaround section.

=Videos on Templates=

This video will demonstrate the basic and advanced template functions that are available to all LimeSurvey users. This includes changing the appearance of certain forms and inserting custom graphics. Additionally, it will thoroughly walk you through on how to edit and preview specific page templates, importing/exporting templates, modify appearance of questions in the CSS, customizing survey description page, and completed page.

LimeSurvey training video - template customization

=Tips & Tricks=

Some language specific element
If you want to have some language specific sentence in a survey, for example a help at end of each page, you can add in a .pstl file a sentence and hidding it for other language. And hidding it in the template.css, we can use the pseudo selector :lang, but for best compatibility, we use some class.

Example for a help sentence at bottom of the page, in french and english, put this on endpage.pstpl:

and in template.css

You can use it to for other sentence in your question before 1.92 ( in 1.92, there are better solutions).

Change the layout of the survey page
When editing a template this template can be assigned to a single survey while the survey list page, which is shown at www.yourdomain.org/limesurveyinstallfolder, lists all your surveys.

To use your current template for this page you have change the according setting at the Global Settings screen; at older versions this change can be done by editing the $defaulttemplate setting at the config file: Copy this setting from config-defaults.php to config.php which overrides config-defaults.php and edit this setting to $defaulttemplate = 'yourtemplatename';

Import/Export of templates: Mac users
Mac users, please note: Mac OSX default archive utility may have problems with zip folders "generated on the fly".

a work around is to unix'es unzip from the command line:

$ unzip template.zip -d template

Archive: template.zip

inflating: template/startpage

inflating: ...

or scripts in their mac-compiled counterparts:

http://homepage.mac.com/roger_jolly/software/

Changing your templates traffic light from red to green
If you haven't already, set the admin directory to read/write/execute (777). The files within it, however, may be set to read/execute only (chmod 755).

GO to file directory ie file manager, find templates directory.

1 change permission on eg"vallendar" (or any template of your choice) directory to read 777

2 voila! the red traffic light on "vallendar" is now green.

3 NOTE: to restrict access for safety, when finished editing template files, change all templates files back to what they were eg 644

Replacing the help icon
When a question help text is shown then an help.gif image is used from the default template folder.

You can replace this image by uploading a new help.gif, help.png or help.jpg in your custom template folder. It then will be automatically used instead of the default help icon.

Replacing an existing logo
Note: In the default-Template of 2.50 there is no preembedded logo, please go to Adding your own logo

1. To edit the logo go to the &bdquo; template.css &rdquo; file which you can find it here:



2. Click the search button to find occurrences of logo related styles.



3. Search for #logo



4. Edit the main style file

You will see something similar to:



If you want to change the image just replace logo.gif with another image link. Example: ( logo.png or logo.jpg ).

If you want change the image size adjust width and height (in pixels) like this:

Adding your own logo
1. Find and open the &bdquo; startpage.pstpl &rdquo; template file.



2. After the  tag add this line to &bdquo; startpage.pstpl &rdquo;:

3. To upload your own logo go to the template editor and upload your logo.



To position your logo please use one of the following css classes:

If you want the logo to be placed at left side:

If you want the logo to be placed at right side:

If you want to center the logo

Use the same template with different logos
If you want to use the same template for all surveys and just want to change the logo for each survey, you can use the {SID} placeholder in the template .pstpl file and thereby refer to different images:

Remove the default help to all question (hide_tip)
There are 3 solutions to remove the default help:
 * 1) like a hide_tip attribute but for all question and survey.
 * 2) you can remove the {QUESTIONHELP} and is container from the file question.pstl, but it can be a bad idea for screenreader.
 * 3) for the default template and some other, add this at the end of tempate.css

Display custom favicon
A favicon is the little icon you see in the browser's address bar, list of bookmarks or tab. You can display your own icon as follows:
 * 1) Create a favicon - google will find you lots of free favicon generators
 * 2) Name your new favicon "favicon.ico" and place it in your template /files directory
 * 3) Add the following code to your startpage.pstpl before the tag

Different appearance for survey-/question-pages
(Version 1.91 and newer)

If you want LimeSurvey to change the appearance of every second page (i.e. of even and odd survey pages) you can use .page-odd class in your css file to change the appearance of odd pages.

example from default template of LimeSurvey 1.91+

To not differentiate even and odd pages at the (default) template find all instances of .page-odd in template.css and remove those styles.

Create a vertical separator  border for dual scale array
To create a vertical separator border for a dual scale array you can add the following lines to your template.css-file.

header_separator is used to adress the separator for the header "td" and "dual_scale_separator" is used to adress the separator column in the dual scale array.

Hide the survey contact message shown on the start page/survey list
To hide the "Please contact ..." message on the start page (with the survey list) you can add the following to the $(document).ready function in the template.js of your used design template:

Remove the survey contact message shown on error messages
If you want to remove the survey contact message from error messages it'll be trickier. You can add the following function call to the $(document).ready function in the template.css of your used design template:

and add the following function to your *template.js* file

It will probably not work for a survey in English language and has to be extended when used for multilingual surveys. But it's an idea/tip how to solve this.

How to deal with multilingual question attributes (before version 2.0 at which those were added)
If you have a multilingual survey and e. g. want to use a different string for the "other" field, this could only be done for the base language (until this feature was added at LimeSurvey 2.0). To work around this, paste in the field to change the label for "other"

At the template.css of your template (at /limesurvey/upload/templates/ /template.css) add:

=Custom Question Views (version 2.5)=

Note: This is a temporary feature to be replaced in the future by question plugins. It is disabled by default.

As of version 2.5, you can create template-specific custom views for questions and some of their incorporated elements. This is useful if you want to modify the HTML layout of a particular question type for one or more surveys.


 * In application/config/config.php, find 'config'=>array and add this line to the array : 'allow_templates_to_overwrite_views'=>1
 * In /{your_template}/config.xml, set "overwrite_question_views" to true
 * Copy application/views/survey/* to template/{your_view_directory}/survey/
 * Note that you only need to copy the files that you intend to modify but the file structure must remain the same as in application/views/survey/