Theme editor/vi

Giới thiệu

LimeSurvey có hệ thống phong cách và chủ đề nâng cao cung cấp cho các nhà phát triển một cách hiệu quả để tùy chỉnh giao diện khảo sát. Kể từ LS3, thuật ngữ "mẫu" đã được thay thế bằng thuật ngữ "chủ đề". Chủ đề cho phép kiểm soát phong cách của các trang khảo sát. Quản trị viên khảo sát có thể chọn một chủ đề mặc định sẽ được sử dụng cho mỗi cuộc khảo sát để cá nhân hóa nó hơn nữa. Chủ đề đi kèm với các tùy chọn cung cấp cho quản trị viên không cần kỹ năng mã hóa một cách đơn giản để thêm biểu tượng trên trang chào mừng, thay đổi màu nền, chọn phông chữ, v.v.

LimeSurvey có 3 chủ đề. Các chủ đề ban đầu này được xác định bởi các thư mục nằm trong thư mục "themes/survey/" cài đặt LimeSurvey. Mỗi chủ đề có thư mục riêng. Trong thư mục chính của một chủ đề, bạn sẽ tìm thấy một tệp cấu hình bằng XML và nhiều thư mục chứa các chế độ xem themes (.twig), cascading style sheet (.css), 'scripts, hình ảnh ('.jpg hoặc .png) và có thể những thứ khác.

Kể từ LimeSurvey 2.50, công cụ chủ đề sử dụng Bootstrap 3 làm khung CSS. Vì Bootstrap 3 là một framework tiêu chuẩn nên các nhà phát triển sẽ tìm thấy rất nhiều tài liệu, hướng dẫn và chủ đề diễn đàn về nó trên internet.

Kể từ LimeSurvey 3, công cụ chủ đề sử dụng Twig nên nhà phát triển chủ đề có thể thay đổi logic của kết xuất khảo sát một cách an toàn và dễ dàng. Twig thay thế hệ thống từ khóa thay thế cũ đã được sử dụng trong các phiên bản trước. Logic được sử dụng để tạo HTML của từ khóa hiện có sẵn trong chế độ xem của chủ đề.

Đoạn trích từ Chủ đề Vanilla:

 <div class="{{ aSurveyInfo.class.answercontainer }} col-xs-12" {{ aSurveyInfo.attr.answercontainer }}> 
 {# LƯU Ý: Nếu bạn muốn tùy chỉnh kết xuất câu hỏi, hãy sử dụng chủ đề câu hỏi #}
 {{ aQuestion.answer | thô }}
</div>

Chủ đề, là mã HTML và Twig, có xu hướng xác định vị trí và loại văn bản sẽ được hiển thị cũng như các đặc điểm cấu trúc tương tự của trang. Họ thường tham khảo hoặc bao gồm các tập tin khác. Hầu hết trong số chúng đều tham chiếu đến tệp biểu định kiểu xếp tầng (CSS) phổ biến xác định kiểu phông chữ, màu sắc, kích thước, nền và các tham số tương tự chung cho tất cả các trang trong khảo sát. Các biểu định kiểu tham chiếu các tham số HTML class được liên kết với các loại đối tượng khác nhau trong mã HTML. Điều này cho phép biểu định kiểu xác định cách hiển thị từng loại văn bản hoặc các đối tượng khác có thể xuất hiện ở nhiều nơi. Có các lớp duy nhất cho từng loại câu hỏi trong LimeSurvey và do đó cung cấp khả năng kiểm soát chi tiết về hình thức của từng loại câu hỏi. Các tệp hình ảnh, như logo hoặc các hàm tạo thanh tiến trình đặc biệt, cũng có thể được tham chiếu trong tệp Chủ đề. Cuối cùng, các từ khóa đặc biệt trong dấu ngoặc nhọn được thay thế bằng văn bản được xác định trong khảo sát cho từng người dịch ngôn ngữ (ví dụ: 'Tiêu đề khảo sát' hoặc 'Văn bản câu hỏi' cho từng ngôn ngữ được xác định).

Nếu bạn tạo một chủ đề tùy chỉnh mới, vui lòng cân nhắc việc đóng góp chủ đề đó lại cho cộng đồng LimeSurvey và cung cấp chủ đề đó cho những người khác. Với sự giúp đỡ của bạn, chúng tôi có thể phát triển kho chủ đề, khảo sát và các tiện ích bổ sung khác để làm cho LimeSurvey trở nên tốt hơn nữa! Xem kho lưu trữ mẫu LimeSurvey của chúng tôi, nơi bạn có thể chia sẻ các mẫu của mình.

Tạo chủ đề mới

Để có thể tạo chủ đề mới (hoặc chỉnh sửa chủ đề hiện có), bạn cần Quyền người dùng chỉnh sửa mẫu trong LimeSurvey cũng như quyền thao tác các tệp trong hệ điều hành cơ bản hệ thống lưu trữ cài đặt LimeSurvey của bạn.

Lưu ý cảnh báo: Nếu bạn thay đổi chủ đề, bạn cũng có thể ảnh hưởng đến tất cả các khảo sát hiện có từ quá trình cài đặt LimeSurvey của mình. Chủ đề là một tính năng nâng cao đòi hỏi kinh nghiệm và kiến thức về HTML.

Cách ưa thích để tạo chủ đề mới là thông qua Trình chỉnh sửa chủ đề (xem bên dưới), nằm trong Cấu hình trên thanh công cụ trên cùng. Một số người dùng thích làm việc trực tiếp với các tệp chủ đề để họ có thể sử dụng trình soạn thảo văn bản yêu thích của mình thay vì giao diện web. Trong trường hợp này, trước tiên bạn vẫn sử dụng Trình chỉnh sửa chủ đề để tạo chủ đề mới. Điều này sẽ tạo một chủ đề cơ sở mới với tất cả các tệp bạn cần trong thư mục LimeSurvey_web_root/upload/themes/survey/your_new_template. Từ đó, bạn có thể sử dụng trình soạn thảo văn bản của mình để điều chỉnh các tệp mẫu theo cách thủ công.

Lưu ý về quyền: trên hệ thống unix/linux, các tệp chủ đề này sẽ thuộc sở hữu của nhóm và người dùng nơi máy chủ web đang chạy (có thể là "www" đối với một số hệ thống). Vì vậy, hãy đảm bảo bạn có quyền thích hợp để chỉnh sửa các tệp này. Khi bạn lưu chúng, hãy đảm bảo rằng chúng không thay đổi quyền sở hữu! Bằng cách này, bạn vẫn có thể sử dụng giao diện Chỉnh sửa chủ đề web nếu cần.

Một số yếu tố 'công khai' của LimeSurvey có thể được điều chỉnh theo một loạt chủ đề. Phần tiếp theo sẽ giải thích rất ngắn gọn về các mẫu này.

Trình chỉnh sửa chủ đề LimeSurvey

Trình chỉnh sửa chủ đề: Cấu hình > Chủ đề> Trình chỉnh sửa chủ đề Trình chỉnh sửa chủ đề chỉ khả dụng cho người dùng với quyền Mẫu và cho quản trị viên cấp cao.

Template:Cảnh báo

Trình chỉnh sửa chủ đề LimeSurvey cho phép bạn chỉnh sửa nội dung chủ đề của mình trực tuyến. Để khởi động Trình chỉnh sửa chủ đề: nhấp vào Chủ đề trong menu Cấu hình, sau đó nhấp vào nút Trình chỉnh sửa chủ đề bên cạnh chủ đề bạn muốn chỉnh sửa hoặc mở rộng.

Nút truy cập trình chỉnh sửa chủ đề cho chủ đề Bootswatch

Trang soạn thảo mẫu cho phép bạn chọn mẫu bạn muốn chỉnh sửa/xem.

Lựa chọn tiếp theo đã khả thi:

• Tạo: Cho phép bạn tạo mẫu mới. Để không phải bắt đầu lại từ đầu, mẫu 'mặc định' đã được sao chép.
• Import: Cho phép bạn nhập mẫu từ tệp ZIP.
• Export : Cho phép bạn xuất mẫu hiện tại sang tệp ZIP.
• Copy: Cho phép bạn tạo mẫu mới bằng cách sao chép mẫu hiện tại.
• Rename: Cho phép bạn thay đổi tên của mẫu. Nó thường được sử dụng sau khi sao chép hoặc nhập một mẫu.
• Template: Một danh sách thả xuống hiển thị tất cả các mẫu có sẵn nằm trong bản cài đặt LimeSurvey của bạn.

• Màn hình: Danh sách thả xuống cho phép bạn chọn trang khảo sát cụ thể nào của mẫu mà bạn muốn xem.
• Quay lại bảng quản trị.

Import/Export/Copy a template

When you export a template, a ZIP-file archive with all template files your will be created (.pstpl files, images, css files, ...). You can import the exported zip-file into another LimeSurvey installation by using the import feature or you can manually copy the archive into another LimeSurvey installation and extract it into the corresponding template directory there.

However, it is best to 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 "<head>" tag, and should not contain the "<html>" tag. This 'very beginning' of a standard html page is written by the scripts. Please ensure that your startpage.pstpl files contains a <body> tag. Even though many browsers do not require strict adherence to the W3 HTML standards, the LimeSurvey script needs to find a <body> tag to run certain javascript elements. It is not common to see many 'keywords' 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. For example, 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 (i.e.: 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 (access the Presentation & navigation settings by clicking the Presentation tab) 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. 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 LimeSurvey 1.87). All keywords from this template are now available directly in question.pstpl.
• 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 necessary for the print version of the survey.
• print_group.pstpl: This file is the same as startgroup.pstpl and 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 that are always used in a template are 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.

The Awesome-Bootstrap-Checkbox plugin is also included. 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 questions use specific files for Javascript or CSS. If you need to replace a function, use a cascading system. For javascript function, the 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 settings of the survey. The table below indicates which template files are used in constructing each of these pages.

Survey Pages/ Template Files	Survey List	Welcome	Question	Completed	Clear All	Register	Load	Save	Print Answers	Print Survey
SurveyList
Welcome
Privacy
Navigator
Survey
StartGroup
GroupDescription
Question*
EndGroup
Assessment
Completed
ClearAll
Register
Load
Save
PrintAnswers
Print Survey
Print Group
Print Question
StartPage EndPage Template.css

*NOTE: In version 1.90+, 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:

<div {QUESTION_ESSENTIALS} class="{QUESTION_CLASS}{QUESTION_MAN_CLASS}{QUESTION_INPUT_ERROR_CLASS}">

And then add the corresponding closing tag to the end of question.pstpl:

</div>

*NOTE: In version 1.91 and earlier, LimeSurvey js files are not included in the template. In version 2, you have to use {TEMPLATEJS} in 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 one of the template files that is used to compile the page. You can see the Screen part, JavaScript, and CSS files. 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 from 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.

Instead of using a link for each picture, utilize the field string {TEMPLATEURL}. So, instead of:

img src='/limesurvey/templates/yourtemplate/files/mypicture.jpg'

You can use ^{(New in 2.50 )}:

img src='{TEMPLATEURL}files/mypicture.jpg'

In LimeSurvey versions before 2.50 use:

img src='{TEMPLATEURL}mypicture.jpg'

A "sample" of the template page you are editing will be visible in the bottom of the screen. There is no way to delete a template from the template editor. This must be done by accessing the underlying directory and deleting manually the files from there. You also have the possibility to select different screen resolutions in order to better evaluate the feel and look of the template.

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

Template files location

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.

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. It comes installed by default.

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

{TEMPLATEURL}filename.xyz

Styling questions with CSS

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

<div id="question5" class="gender">
...
</div>

and if the question is mandatory:

<div id="question5" class="gender mandatory">
...
</div>

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

<div id="question5" class="gender mandatory input-error">
...
</div>

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

<div id="question6" class="text-short input-error">
...
</div>

Global classes for question part

These classes are used for each question type. Some question types use only one or two classes, while others may use much more.

Global classes

Class name	Part	Question type	Examples	Note
.question (Obsolete since 3.0)	All question block	All question type	<p class="question">, <ul class="question">, <table class="question">
.ls-answers (New in 3.0 )	All question block	All question type	<div class="ls-answers ">, <ul class="ls-answers ">, <table class="ls-answers">
.subquestions-list	List of subquestion	Multi choice question, array question type	<ul class="subquestions-list">, <table class="subquestions-list">	.questions-list is used too
.answers-list	List of answers	Single choice question, array question type, Multi input text question	<ul class="answers-list">, <table class="answers-list">
.answer-item	The answer part: one answer	Single choice question, array question type, Multi input text question	<li class="answer-item">, <td class="answer-item">
.noanswer-item	The answer part for no answer	Single choice question, array question type	<li class="noanswer-item">, <td class="noanswer-item">	No answer is an answer too, then have double class noanswer-item and answer-item
.question-item	The question part: one question	Multi text question, array question type	<li class="question-item">, <tr class="question-item">	Some answers are questions too. Then we have a lot of class="question-item answer-item"
.button-list	A list of button	Yes no and Gender question	<ul class="button-list">
.button-item	The answer part with a button	Yes no and Gender question	<li class="button-item">
.checkbox-list	A list of checkbox	Multi choice question, array number (checkbox) question type	<ul class="checkbox-list">, <tr class="checkbox-list">	Some question types use multi-list class, like checkbox with comment: class="checkbox-list text-list"
.checkbox-array (New in 3.0 )	A array of checkbox	Array (numbers) with checkbox option	<table class="checkbox-list">
.checkbox-item	The answer part with a checkbox	Multi choice question, array number (checkbox) question type	<li class="checkbox-item">, <td class="checkbox-item">
.radio-list	A list of radio item	Single choice question, array question type (each row)	<ul class="radio-list">, <tr class="radio-list">
.radio-array (New in 3.0 )	A array of radio item	Array question type	<table class="radio-array">
.radio-item	The answer part with a radio	Single choice question, array question type	<li class="radio-item">,
.text-list	A list of text input	Multi text question type, array of text	<ul class="text-list">, <tr class="text-list">
.text-item	The answer part of a text input	Multi text question type, array of text	<li class="text-item">,
.numeric-list	A list of text input with numeric only answer	Multi numeric question type, array of number	<ul class="text-list numeric-list">, <tr class="text-list numeric-list">
.number-list	A list of text input with numeric only answer (each row)	Multi numeric question type, array of number	<ul class="text-list numeric-list">, <tr class="text-list numeric-list">
.number-array (New in 3.0 )	The answer part of a numeric input	Array of number	<table class="number-array">
.select-list (Obsolete since 2.50)	A list of select	Array numbers, Dual scale array (select)	<table class="select-list">
.dropdown-list (New in 2.50 )	A list of select	Array numbers, Dual scale array (select) (each row)	<table class="dropdown-list">
.dropdown-array (New in 3.0 )	A array of dropdown	Array numbers, Dual scale array (select)	<table class="dropdown-array">
.select-item (Obsolete since 2.50)	The answer part of a select	Array numbers, Dual scale array (select), single choice with select	<p class="select-item">, <td class="select-item">
.dropdown-item (New in 2.50 )	The answer part of a select	Array numbers, Dual scale array (select), single choice with select	<p class="dropdown-item">, <td class="dropdown-item">
.hide (Obsolete since 3.0)	Used for accessibility: hidden with css but read by screenreader, since 2.50 : you can use sr-only from bootstrap	Short text question	<label class="hide">	Can be used for other purposes
.ls-js-hidden (New in 3.0 )	Used for part to be hidden if javascript is activated	Button for example	<div class="ls-js-hidden">	LimeSurvey core used it, but you can use it too in your template
.ls-js-hidden-sr (New in 3.0 )	Used for accessibility: hide it if js is activated, but always show if user use a screenreader	Button for example	<a class="ls-js-hidden-sr">	Button
.ls-no-js-hidden (New in 3.0 )	Used for part to be hidden if javascript is not activated	Link	<a class="ls-no-js-hidden">	LimeSurvey core used it for inactive link if javascript is not activated
.ls-label-xs-visibility (New in 3.0 )	Label to be hidden in big screen, but show with little screen (with no more table) and to screenreader	label	<label class="ls-no-js-hidden">	Used for label inside table cell of array question type
.ls-input-group-extra (New in 3.0 )	Same usage of boostrap input-group-addon, but without the border and the background.	right suffix	<div class="ls-input-group-extra">	Used for right and left suffix (global)
.checkbox (Obsolete since 3.0)	input[type=checkbox]	Question with checkbox	<input type="checkbox" class="checkbox">	With modern browser: not needed, but some old browser need this
.radio (Obsolete since 3.0)	input[type=radio]	Question with radio	<input type="radio" class="radio">	With modern browser: not needed, but some old browser need this
.text	input[type=text]	Question with input text, or textarea	<textarea class="text">
.answertext	Array question type	Answer part of array question type	<th class="answertext">
.col-answers	Array question type	Column of answers	<col class="col-answers">
.odd .even (Obsolete since 2.50)	Array question type	Alternation for column	<col class="odd">
.array1 .array2 (Obsolete since 3.0)	Array question type	Alternation for line	<tr class="array1">
.ls-odd .ls-even (New in 3.0 )	Array question type	Alternation for subquestion and Y axis	<tr class="ls-odd">

Some examples of question part with classes

Text-short question type:

<p class="question answer-item text-item ">
<label class="hide label" for="answerSGQA">Answer</label><input type="text" value="" id="answerSGQA" name="SGQA" size="50" class="text  empty">
</p>

Multiple short text

<ul class="subquestions-list questions-list text-list">
  <li class="question-item answer-item text-item" id="javatbdSGQA">
    <label for="answerSGQA">Some example subquestion</label>
     <span><input type="text" value="" id="answerSGQA" name="SGQA" size="20" class="text empty"></span>
  </li>
</ul>

Array question type

<table class="question subquestion-list questions-list ">
	<caption class="hide read">Some explanation for accessibility.</caption>
	<colgroup class="col-responses">
		<col width="50%" class="col-answers">
		<col width="25%" class="odd">
		<col width="13.3%" class="col-no-answer even">
	</colgroup>
	<thead>
		<tr class="array1 dontread">
			<td>&nbsp;</td>
			<th>1</th>
			<th>No answer</th>
		</tr>
	</thead>
	<tbody>
		<tr class="array2 answers-list radio-list" id="javatbdSGQ">
			<th width="20%" class="answertext">Some example subquestion
			</th>
			<td class="answer_cell_001 answer-item radio-item">
				<label for="answerSGQA" class="hide read">1</label>
				<input type="radio" value="1" id="answerSGQA" name="SGQA" class="radio">
			</td>
			<td class="answer-item radio-item noanswer-item">
				<label for="answerSGQA" class="hide read">No answer</label>
				<input type="radio" value="" id="answerSGQA" name="SGQA" class="radio">
			</td>
		</tr>
	</tbody>
</table>

The full list of question classes

Question Type	Question Class	Question ID
5 point choice	.choice-5-pt-radio	5
Array (10 point choice)	.array-10-pt	B
Array (5 point choice)	.array-5-pt	A
Array (Flexible Labels) dual scale	.array-flexible-duel-scale	1
Array (Increase, Same, Decrease)	.array-increase-same-decrease	E
Array (Multi Flexible) (Numbers)	.array-multi-flexi	:
Array (Multi Flexible) (Text)	.array-multi-flexi-text	;
Array (Yes/No/Uncertain)	.array-yes-uncertain-no	C
Array (flexible labels)	.array-flexible-row	F
Array (flexible labels) by column	.array-flexible-column	H
Boilerplate question	.boilerplate	X
Date	.date	D
Equation	.equation	*
Gender	.gender	G
Huge free text	.text-huge	U
Language switch	.language	I
List (dropdown)	.list-dropdown	!
List (radio)	.list-radio	L
List with comment	.list-with-comment	O
Long free text	.text-long	T
Multiple numerical input	.numeric-multi	K
Multiple options	.multiple-opt	M
Multiple options with comments	.multiple-opt-comments	P
Multiple short text	.multiple-short-txt	Q
Numerical input	.numeric	N
Ranking	.ranking	R
Short free text	.text-short	S
Yes/No	.yes-no	Y

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 interact by default so that you can have validation tips hidden. However, they do appear when there are 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 met yet; then re-display the page using a harsher color if the person submits the page with lingering validation errors.

Purpose	CSS Class	Description
Mandatory	.mandatory	the question is mandatory
User input error	.input-error	the question had at least one validation error
Hide Tip	.hide-tip	added if you use the hide_tip option
defrault type	.em_default	for default tip set ( numeric value etc …)
Num answers	.em_num_answers	for for min_answers and max_answers
Value range	.em_value_range	for min/max_num_value_n and multiflexible_min/max
Sum range	.em_sum_range	for min/max/equals_num_value
Regex validation	.em_regex_validation	for regular-expression validation of the question
Question-level validation function	.em_q_fn_validation	for the em_validation_q option
Subquestion-level validation function	.em_sq_fn_validation	for the em_validation_sq option
Other comment mandatory	.em_other_comment_mandatory	for other_comment_mandatory option - shows when "other" is selected but associated comment is missing.

Importing styles into your custom template

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

/* --------------------------- START: Question styles  ------------------------------ */

If you're styling your own custom template, you should be able to copy everything after the above one from templates/default/template.css (for table-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 the other browsers, there are special IE conditional style sheets included for each template.

<!--[if IE]>
  <link rel="stylesheet" type="text/css" href="{TEMPLATEURL}IE_fix_all-versions.css" />
<![endif]-->
<!--[if lt IE 7]>
  <link rel="stylesheet" type="text/css" href="{TEMPLATEURL}IE_fix_older-than-7.css" />
<![endif]-->
<!--[if IE 8]>
		<link rel="stylesheet" type="text/css" href="{TEMPLATEURL}ie_fix_8.css" />
<![endif]-->

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 a conditional class for body in startpage.pstpl and use this class in your template.css. This method is used in the citronade template ^{(Obsolete since 2.06)}. Adding a js / no-js class to have javascript / no javascript system.

<!--[if lt IE 7 ]> <body class="lang-{SURVEYLANGUAGE} {SURVEYFORMAT} ie ie6 ielt7 ielt8 ielt9 no-js"> <![endif]-->
<!--[if IE 7 ]> <body class="lang-{SURVEYLANGUAGE} {SURVEYFORMAT} ie ie7 ielt8 ielt9 no-js"> <![endif]-->
<!--[if IE 8 ]> <body class="lang-{SURVEYLANGUAGE} {SURVEYFORMAT} ie ie8 ielt9  no-js"> <![endif]-->
<!--[if IE 9 ]> <body class="lang-{SURVEYLANGUAGE} {SURVEYFORMAT} ie ie9 no-js"> <![endif]-->
<!--[if gt IE 9]><!--><body id="body" class="lang-{SURVEYLANGUAGE} {SURVEYFORMAT} no-js"><!--<![endif]-->
<script type='text/javascript'>/*<![CDATA[*/(function(H){ H.className=H.className.replace(/\bno-js\b/,'js') })(document.getElementsByTagName('body')[0]);/*]]>*/</script>

And in template.css use:

.ie6{/*specific for internet explorer 6*/}
.ielt8{/*specific for internet explorer 6 and 7*/}
.ie{/*specific for all internet explorer */}

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

  This features is deprecated in version 3.0.

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.)

Keyword	Template files	Description
{SURVEYNAME}	All Files	The survey title
{SURVEYDESCRIPTION}	All Files	The survey description
{WELCOME}	All files (mainly for welcome.pstpl)	The survey 'welcome' text
{PERCENTCOMPLETE}	survey.pstpl	A small graph showing the percentage of the survey completed
{GROUPNAME}	startgroup.pstpl, groupdescription.pstpl, endgroup.pstpl	Displays the current group name
{GROUPDESCRIPTION}	startgroup.pstpl, groupdescription.pstpl, endgroup.pstpl	Displays the current group description
{NUMBEROFQUESTIONS}	welcome.pstpl	Displays the total number of questions in the survey (just the number)
{THEREAREXQUESTIONS}	welcome.pstpl	Displays the sentence "There are X questions in this survey" - from the relevant language file. The X is replaced with the number of questions. Note that this will also work appropriately for singular or plural. If there is only 1 question, it will print "There is 1 question in this survey".
{CHECKJAVASCRIPT}	All files (mainly for welcome.pstpl)	Warning message when end-user browser have javascript disabled
{QUESTION}	Question.pstpl	(Has been superseeded as of LS1.87) Displays the current question text (The format of {QUESTION} can customised by editing 'question_start.pstpl') Use the following: {QUESTION_TEXT}, {QUESTION_MANDATORY}, {QUESTION_HELP}, {QUESTION_MAN_MESSAGE}, {QUESTION_VALID_MESSAGE}, {QUESTION_INPUT_ERROR_CLASS}, and appropriate wrapping HTML instead of {QUESTION}
{ANSWER}	question.pstpl, print_question.pstpl	presents the answer form for the current question
{SGQ}	question.pstpl, question text	Can be used in the question text itself to reference the input field of the question dynamically by displaying the Survey-Group-Question id for the current question. (as of svn build 9755)
{QUESTIONHELP}	question.pstpl, print_question.pstpl	Displays help text (predefined tip for question type) for the current question
{QUESTION_CLASS}	question.pstpl, print_question.pstpl	unique class for each question type. (To be included in the question's wrapping tag.)
{QUESTION_CODE}	question.pstpl, print_question.pstpl	Displays the current question code
{QUESTION_ESSENTIALS}	question.pstpl	the question ID and (if a question is conditional), 'style="display:none;"'. (To be included in the question's wrapping tag.)
{QUESTION_HELP}	question.pstp, question_start.pstpl	Displays the user defined help text for the current question
{QUESTION_TYPE_HELP}	print_question.pstp	Displays the user defined help text for the current question
{QUESTION_INPUT_ERROR_CLASS}	question.pstp, question_start.pstpl	Provides a class if there was user input error
{QUESTION_ID}	print_question.pstp	Provides a unique ID for each question to allow styling for specific questions
{QUESTION_TEXT}	question.pstp, print_question.pstp, question_start.pstpl	Displays the text for the current question
{QUESTION_MANDATORY}	question.pstp, print_question.pstp, question_start.pstpl	Displays the translated 'Mandatory' text for the current question
{QUESTION_MAN_CLASS}	question.pstpl, print_question.pstpl	class if a question is mandatory. (To be included in the question's wrapping tag.)
{QUESTION_MAN_MESSAGE}	question.pstp, print_question.pstp, question_start.pstpl	Displays the translated 'Mandatory' help message text for the current question
{QUESTION_NUMBER}	print_question.pstpl	Incremental count of questions.
{QUESTION_VALID_MESSAGE}	question.pstp, print_question.pstp, question_start.pstpl	Displays the translated valid help message text for the current question
{QUESTION_SCENARIO}	print_question.pstp	Prints out the 'scenario' text for conditional questions.
{NAVIGATOR}	navigator.pstpl	Displays navigation buttons (next, prev, last)
{CLEARALL}	All files (but intended for navigator.pstpl)	Displays the "Exit and Clear Results" link
{COMPLETED}	completed.pstpl	Displays the 'completed' message for registering, will change depending on whether the attribute_1 and attribute_2 fields are set.
{URL}	completed.pstpl	Displays the survey 'url' and 'url text'
{PRIVACYMESSAGE}	privacy.pstpl	The privacy message is shown if you set your survey to be anonymous. The text can be edited/translated in the language files. This can also be changed manually by editing the privacy.pstpl template you wish to use.
{TEMPLATEURL}	All Files	The URL to the current template location (useful for referencing image files in your template)
{SURVEYRESOURCESURL}	All Files	The URL to the current uploaded files for this survey location (useful for referencing image files in your question, group, ....)
{SUBMITCOMPLETE}	endpage.pstpl	The statement (from the language files) that tells the user they have completed the survey, and to press the "Submit" button
{SUBMITREVIEW}	survey.pstpl	The statement (from the language files) that tells the user they can review/change the answers they have made by clicking "<< prev"
{SAVEDID}	All Files	Displays 'Response ID' of user
{QUEXMLPDF}	All Files	Displays button to export the queXML PDF of questionnaire including answers entered up until the point that has been completed in the survey.
{TOKEN:FIRSTNAME}	All Files	***If survey answers are NOT ANONYMOUS - gets replaced with the users first name from the tokens table
{TOKEN:LASTNAME}	All Files	***If survey answers are NOT ANONYMOUS - gets replaced with the users last name from the tokens table***
{TOKEN:EMAIL}	All Files	***If survey answers are NOT ANONYMOUS - gets replaced with the users email from the tokens table***
{TOKEN:ATTRIBUTE_1}	All Files	***If survey answers are NOT ANONYMOUS - gets replaced with the users attribute_1 from the tokens table***
{TOKEN:ATTRIBUTE_2}	All Files	***If survey answers are NOT ANONYMOUS - gets replaced with the users attribute_2 from the tokens table***
{ANSWERSCLEARED}	Preferably in navigator.pstpl	The "Answers Cleared" statement from the language files
{RESTART}	clearall.pstpl	URL to restart the survey
{REGISTERERROR}	register.pstpl	Shows any error messages in the register page (ie: "You must include an email address")
{REGISTERMESSAGE1}	register.pstpl	The statement "You must be registered to complete this survey" from the language files
{REGISTERMESSAGE2}	register.pstpl	Details about registering from the language files
{REGISTERFORM}	register.pstpl	The actual form for registering, will change depending on whether the attribute_1 and attribute_2 fields are set.
{SAVE}	Works suitable on navigator.pstpl	Displays the 'Save your responses so far' button to offer the user to save and come back later to continue the survey. If the Save option is deactivated in the survey properties the tag will not be shown and ignored.
{LANGUAGECHANGER}	survey.pstpl	Displays a switch in multilingual surveys to change the question.

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, but it does allow the changing of background colour, text colour, 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 color 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 color for these question types. Array1 is also used for the column headings in these question types)
• errormandatory (Sets the color and style of the "This question is mandatory" error message)
• warningjs (Sets the color 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)

Because you can edit all the HTML aspects, there's no reason to surround your templates with a

<div class='new_name'></div>

and then define a css for that new_name class.

Styling the progress bar

The progress bar appearance can be modified with CSS.

To change the background color of the bar, add something like the following to the end of your custom.css file (example for fruity theme):

.fruity .progress-bar {
 background-color: #3300FF;
}

To change the border color of the bar, add something like the following to the end of your custom.css file (example for fruity theme):

.fruity .progress-bar {
 border: 1px solid #FF0000;
}

Advanced features available to developers

LimeSurvey has integrated some user-made patches that permits some special changes. These very advanced features (generally) require changes to the underlying code base of LimeSurvey and should be done carefully in order not to introduce security holes.

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 them. In this way, a template author can create his or her own template_onload() function in the HEAD that replaces the default one.

• 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.

For further details, see the workaround section.

Tips & tricks

Language specific element

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

Below, there are two help sentences, in French and English. Put this on endpage.pstpl:

<div class="fr" lang="fr">Pour de l'aide en direct appelez le 000000</div>
<div class="en" lang="en">For some help, please call 000000</div>

and in template.css:

.lang-fr .en{display:none}
.lang-en .fr{display:none}

Change the layout of the survey page

After editing and saving a template, it applies to a survey list page only if it is selected from the settings of the survey. To make it the default template, go under the General tab located in the Global settings of your LimeSurvey installation and choose the desired template. From this point on, all the templates that use the "default" option as template, plus the ones that are going to be newly created, will use the newly selected default template.

To use your current template for this page, you must change the appropriate setting from Global settings. In older versions, this change can be done by editing the $defaulttemplate setting from 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 that the Mac OSX default archive utility may have problems with zip folders "generated on the fly".

A workaround is to unix'es unzip from the command line:

$ unzip template.zip -d template

Archive: template.zip

 inflating: template/startpage

 inflating: ...

Another workaround is to use scripts in their mac-compiled counterparts.

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:

<img src="{TEMPLATEURL}files/logoImage-{SID}.png">

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 - You can use Google to find 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 </head> tag.

<link rel="shortcut icon" href="{TEMPLATEURL}files/favicon.ico" type="image/x-icon">
<link rel="icon" href="{TEMPLATEURL}files/favicon.ico" type="image/x-icon">

Different appearance for survey-/question-pages

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

An example from default template of LimeSurvey 1.91+:

.page-odd table.question-group {
 background-color: #D2F2D3;
}

If you do not want differentiate even and odd pages, 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.

table.question thead td.header_separator,
table.question tbody td.dual_scale_separator
{
   border-right:solid 1px #00A8E1;
}

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

Adding your own logo to the survey list

1. First please open the theme editor for the theme you like to use.
2. We recommend to use fruity, it is our best theme currently.
3. Then extend the theme and give it a name you will recognize.
4. In the following view you may upload the logo you want to use.
5. Select the editor screen `Survey List´ in the Screen dropdown in the top right corner.
6. Then select `layout_survey_list.twig´ in the left side menu.
7. In the editor scroll to line 126 and change the marked part to the filename of the image you uploaded to the theme before.
8. Save your file.
9. Change default theme to your extended theme.

Align logo to the centre of the survey page

This example is for the "extends_fruity" template. For other templates the required CSS may be different.

1. Login to the LimeSurvey admin area
2. Browse to the theme editor: Configuration > Themes
3. Find "LimeSurvey Fruity Theme" in the list and click the "Theme Editor" button
4. Click "custom.css" in the files list on the left at near the bottom of the page
5. Copy the following CSS into that file and press "Save Changes"

.navbar-fixed-top > div.navbar-header {
    width: 100% !important;
}

.navbar-fixed-top > div.navbar-header > div {
    width: 100% !important;
}

.navbar-fixed-top > div.navbar-header > div > img {
    margin: 0 auto 0 auto !important;
}

Custom question views ^{(New in 3.0 )}

Note: This is a temporary feature to be replaced in the future by question object (it will be very easy to move custom views to question object). 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/

Insert custom CSS or JavaScript files for template

As of version 2.50, you can use the config.xml File to Automatically Load Plugin Files.

• Upload your files to the template /css or /scripts folder
• In /{your_template}/config.xml, add the file paths to the <css> or <js> blocks, something like this:

  <css>
  	<filename>css/jquery-ui-custom.css</filename>
  	<filename>css/bootstrap-slider.css</filename>
  
  	<filename>css/awesome-bootstrap-checkbox/awesome-bootstrap-checkbox.css</filename>
  	<filename>css/flat_and_modern.css</filename>
  
  	<filename>css/template.css</filename>
  
  	<filename>css/myCustomPlugin.css</filename>
  </css>
  <js>
  	<filename>scripts/template.js</filename>
  	<filename>scripts/bootstrap-slider.js</filename>
  
  	<filename>scripts/myCustomPlugin.js</filename>
  </js>
  

Class definitions (for Developers)

answer-list

Question	Question Type	elements
arrays/5point	A	tr
arrays/10point	B	tr
arrays/array	F	tr
arrays/column	H	tr and col
arrays/dualscale	1	tr
arrays/increasesamedecrease	E	tr
arrays/yesnouncertain	C	tr
gender	G	div and ul
list_with_comment	O	div
ranking	R	ul and div
yesno	Y	ul and div
ranking_advanced	R	ul and div
listradio	L	div
5pointchoice	5	ul
multiplechoice	M	div

radio-list

Question	Question Type	elements
yesno	Y	ul
gender	G	ul
arrays/yesnouncertain	C	tr
arrays/increasesamedecrease	E	tr
arrays/dualscale	1	tr
arrays/5point	A	table and tr
arrays/10point	B	tr
arrays/array	F	tr
arrays/column	H	col
listradio	L	div
list_with_comment	O	div followed by ul

radio-item

Question	Question Type	elements
arrays/yesnouncertain	C	td
5pointchoice	5	li
arrays/10point	B	td
arrays/5point	A	td
arrays/array	F	td
arrays/column	H	td
arrays/dualscale	1	td
arrays/increasesamedecrease	E	td
gender	G	li
listradio	L	li
yesno	Y	li
listradio	L	li and div
image_select-listradio	L	li and div
list_with_comment	0	li

list-group

Question	Question Type	elements
yesno	Y	ul
5pointchoice	5	ul
gender	G	ul
ranking	R	ul
ranking_advanced	R	ul and div
question_index_group_buttons		div
question_index_questions_buttons		div

list-group-horizontal

Question	Question Type	elements
yesno	Y	ul
5pointchoice	5	ul
gender	G	ul

list-unstyled

Question	Question Type	elements
list_with_comment	0	ul
listradio	L	ul
multiplechoice	M	ul
multiplechoice_with_comments	P	ul
multiplenumeric	K	ul
multipleshorttext	Q	ul
ranking	R	ul
ranking_advanced	R	ul
bootstrap_buttons_multi	M	ul
image_select-multiplechoice	M	ul
inputondemand/multipleshorttext	Q	ul
register_error		ul
register_message		ul
layout_survey_list		ul
load		ul
save		ul
captcha		ul

select-list

Question	Question Type	elements
ranking	R	ul
ranking_advanced	R	ul

checkbox-item

Question	Question Type	elements
multiflexi (Array numbers)	:	td
multiplechoice	M	li
multiplechoice_with_comments	P	div
image_select-listradio	L	li
image_select-multiplechoice	M	li and div
navigator		span

checkbox-text-item

Question	Question Type	elements
multiplechoice_with_comments	P	li
multiplechoice	M	li
image_select-multiplechoice	M	li