LimeSurvey Manual - User contributions [en]

Survey settings

2014-06-11T09:03:20Z

Southcot:

<languages />
<translate>


__TOC__

=Overview= 


Some of this settings can be set when creating a new survey. Click on the Add button [[File:add.png]] on the right side of the administration button bar and a "Create New Survey" screen will appear.

You can edit all of these settings later again by click the 'Edit survey settings' icon [[File:token_manage_30.png]] in the 'Survey properties' dropdown menu of the survey toolbar.

=Settings= 


All survey settings and functions are organized in tabs. The following is a description of each tab and field.

==General== 
#'''Base language''': This sets the base language for the survey. Once saved, you cannot change it later. The language-set is the base language for possible translations of the survey. That way you can have multilingual surveys. During survey creation you cannot add additional languages. You will be able do that if you edit the survey properties again, later.
#'''Additional languages''': To choose addintinal language. <span class="alert">Only available when survey is created.</span>
#'''Title''': This is the brief descriptive name of the survey (ie: "Enterprise Bargaining Survey 2003", or "Views on Ice Cream"). This title will be displayed on every page of the public survey.<span class="alert">Only available at survey creation. After available in Edit survey text elements</span>
#'''Description''': This allows you to enter a description of the survey. (ie: "A survey to collect your ideas on the next round of enterprise bargaining" or "A survey to find out the popularity of chocolate ice cream"). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor. By default, description is used on invitation email.<span class="alert">Only available at survey creation. After available in Edit survey text elements</span>
#'''Welcome message''': This allows you to enter a message that will display when a participant first logs into your survey. (ie: "Thank you for taking the time to participate in this survey..") You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.<span class="alert">Only available at survey creation. After available in Edit survey text elements</span>
#'''End message''': This allows you to enter a message that will display when a participant completes your survey. (ie: "Thank you for completing our survey. We will publish results soon."). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.<span class="alert">Only available at survey creation. After available in Edit survey text elements</span>
#'''End URL''': This URL will be presented as a link at the end of the survey, and allows you to direct your participants back to your home page (or, in fact, anywhere). The End URL has to be entered with "http://" at the beginning, eg. http://www.limesurvey.org. <br />You can use they placeholder {SAVEDID}, {TOKEN}, {SID} and {LANG} in this URL.<br />SAVEDID is the id assigned to this particular submission, TOKEN is the token used to participate in the survey, SID is the survey ID and LANG is the language code<br />eg. http://www.limesurvey.org/test.php?var1={SAVEDID}&var2;={TOKEN}&var3;={SID}&lang;={LANG} <br />From version 1.82+ you can use [[URL fields]] with this field to pass parameters from the start URL to then end URL. <br />You can also use {INSERTANS:SGQA} in this URL (since 1.82+). This allows adding the response to a specific question in the survey to the final url. This can be useful for sending a response to an external script (ie an email address collected during the survey). eg: "http://www.limesurvey.org/test.php?email={INSERTANS:1234X56X7}".<span class="alert">Only available at survey creation. After available in Edit survey text elements</span>
#'''URL description''': The description for the link using the End URL.<span class="alert">Only available at survey creation. After available in Edit survey text elements</span>
#'''Administrator''': This is the name of the contact person who administers the survey. It will be included in emails sent out inviting participants to respond.
#'''Admin email''': This is the email address of the administrator (as above) and is used as the 'reply to:' address on any emails sent. You can also enter several email addresses separated with a semicolon - that way survey administrator notifications are sent to more than one person. (Example: "firstaddress@test.com;secondaddress@test.com")
#'''Bounce email''': This is the email address where a delivery error notification email should be sent. By default, this is the same as the administrator's email address. If you want to use a custom script to parse delivery error emails, then use a special Bounce Email address here and automatically process emails reaching this address with your script. This script could then update the Email Status field of the token line corresponding to this email address (see tokens).
#'''Fax to''': This field is used to give a fax number on the "printable survey" - ie: when you want to send someone a hard copy because they cannot use the online survey.


<div class="simplebox">'''Caution''': the HTML WYSIWYG editor doesn't allow you to upload files during the survey creation process. Trying to do so will end up with an error message like: "''This file uploader is disabled''". If you need to upload pictures or any other ressources, please do so after survey creation, by editing the newly created survey.</div>

==Presentation & navigation== 
#'''Format''': Choose from "Question by question", "Group by group" or "All in one".
#:[[File:Setting_Pres_Format_EN.png]]
#*'''Question by Question''': Public survey will display one question per page.
#*'''Group by Group''': Public survey will display all questions in a group per page. Group at a time surveys still have a separate "welcome" page and "submit" page, like "Question by Question" surveys.
#*'''All in one''': Public survey will display all questions in one single page. Activated All in one surveys do not have a "welcome" page or "submit" page - the welcome message and submit button all appear on the same page.
#'''Template''': Choose from the installed templates in your system. The default template is rather dull, but functional. More information on creating your own templates is available [[The template editor|here]].
#'''Show welcome screen''': Yes/No. If Yes, then the welcome message defined in Text Elements section will be displayed. Default is Yes.
#'''Navigation delay''': Number of seconds before Previous and Next buttons are enabled. Default 0 seconds
#'''Show <nowiki>[</nowiki><< Prev] button''': This option defaults to yes, however if you set it to "No" then users will not have the option of moving to a previous page while completing the survey.
#'''Show question index / allow jumping''': Yes/No. Default No. When Yes, an index will be displayed on the right side. Users can jump to any section in the survey. In 2.05 the options have changed to Disabled / Incremental / Full. Disabled and Incremental represent the current No and Yes options. Full always shows all groups / questions, this allows the user to freely navigate through the survey. This might not work for all kinds of conditions.
#'''Keyboard-less operation''': By activating this setting there will be a virtual keyboard available for certain question types.
#'''Show progress bar''': Yes/No. Default Yes. Allow the administrator to turn off the Progress bar
#'''Participants may print answers?''': This option defaults to no. When it is set to yes, a participant can print a summary of responses at submit time.
#'''Public statistics''': Yes/No. Default No. If set to "Yes" users who have submitted the survey will be presented a link to statistics of the current survey. The admin can set which questions should be included at these statistics by [[Advanced question settings#public_statistics|applying the according question attribute]].
#'''Show graphs in public statistics''': (''since 1.80'') Determines if public statistics for this survey include graphs or only show a tabular overview. Creating graphs for huge surveys with lots of answers takes some time and server resources so this is the switch to turn them on/off (default setting: ''off'').
#'''Automatically load URL when survey complete''': Yes/No. Default No. If yes, when the survey is submitted, it will automatically redirect to the End URL. The end URL can be defined in the Text Elements Section. Please note that this only works on an active survey.
#'''Show "There are X questions in this survey"''': Yes/No. Default Yes. If Yes, the message will be displayed on the Welcome Screen. This option will not affect the print version.
#'''Show group name and/or group description''': Will control the display of Group Names and Descriptions. This option will not affect the print version. Four Options:
#*'''Show Both''' - Default
#*'''Show Group Names Only'''
#*'''Show group description Only'''
#*'''Hide Both'''
#'''Show question number and/or code''':
#*'''Show Both''' - Default
#*'''Show Question Number Only'''
#*'''Show Question Code Only'''
#*'''Hide Both'''
#'''Show "No answer"''': Yes/No. Default Yes. When Yes, the No Answer will be displayed as the default option for non-mandatory single-select questions. Be aware that if you switch this off, the participant won't be able to unselect a chosen answer option in a non-mandatory question.

==Publication & access control== 
#'''List survey publicly''': Yes/No. Default No. When it is set to yes, your survey will be listed in the 'available surveys' portal
# '''Start date/time''': Set this to some date if you want your survey to start on a certain date. The survey will start on midnight of that day and only then will people be able to answer to it. To disable this just clear the date from the input field.
#'''Expiry date/time''': Set this to some date if you want your survey to expire on a special date. This is the last date on which the public survey script will let people participate. (Example: If you set it for the 31st of December, then people will no longer be able to use the survey script on the 1st of January). To disable this just clear the date from the input field.
#'''Set cookie to prevent repeated participation?''': If you set this to 'Yes', and your survey does not use a tokens table to control participant access, then a cookie will be saved to the client computer of each survey participant once they have submitted a survey. This cookie will stop the same user on that computer from accessing the survey more than once. There are inherent limitations in the 'security' strength of such a system, but, in general, it allows you to retain some control over multiple entries on public surveys.
#'''Use CAPTCHA for''': With this option you can decide when you want a CAPTCHA to be used. Default is to enable CAPTCHA only for the public Registration page, but you can also enable it before accessing the survey, and before Load/Saving partial answers.

==Notification & data management== 
#'''Send basic admin notification email to:''' and '''Send detailed admin notification email to:''' These fields allow you to send notifications or survey responses to additional email addresses once the survey is submitted. You can edit the templates for these emails under 'Email templates'. Multiple recipients can be set by seperating the entries with a semicolon (;) - eg "yourname@test.com; myname@test.com;hisname@test.com" OR when using placeholders "yourname@test.com;{INSERTANS:82733X12X73};{TOKEN:EMAIL}". Make sure that at least your administrator email is set properly in the survey settings - otherwise no email will be sent or there will be an 'Invalid address:' message when a participant finishes a survey. Please note that there are three different ways for entering an address:
##Enter a specific ''email address'' (ie: yourname@test.com)
##Enter a ''SGQA code'' and the response will be sent to an email address entered as an answer to that particular question (use the format {INSERTANS:9999X88X12}, in the same way you would [[Adding a question#Information from previous answers|Re-use information from previous answers]])
##Enter a ''Token code'' (only possible if your survey is ''not'' anonymous) and the response will be sent to an email address retrieved from a token field (use the format {TOKEN:EMAIL} or {TOKEN:ATTRIBUTE_1} in the same way you would [[Adding a question#Information from tokens table|Re-use Information from the Tokens Table]])
##''As of Version 1.92:'' Enter a valid expression conforming to [[Expression Manager|Expression Manager]] syntax. This lets you use question code instead of SGQA syntax (for easier readability), plus conditional logic (e.g. route the notifications to different people depending upon the data entered into the survey).
#'''Date stamp?''': This field allows you to determine whether the survey will datestamp all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the time and date that the response was made. (See configuration settings for $timeadjust setting.)
#'''Save IP address?''': This field allows you to determine whether the survey will save an IP-address for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the ip-address of the participant.
#'''Save referrer URL?''': This field allows you to determine whether the survey will save the referrer URL for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response where this URL is saved. A referrer URL is the URL from which the user was led to your survey URL.
#'''Enable assessment mode?''': With this setting you can enable/disable [[Assessments|assessments]] for this survey.
#'''Save timings''': If activate then on survey activation a separate table will be created where timings for your questions will be saved, e.g. how long a user stays on one page during taking the survey.
#'''Participant may save and resume later?''': This setting allows a participant to save his responses and resume to answer the survey at a later time. Please note that this makes most sense with open surveys or surveys with anonymized answer. If you are using tokens and the survey is not anonymous in most cases it is better to activate 'Token-based response persistence' in the token tab.
#'''Google Analytics API Key for this survey''': Allows for integration with Google Analytics. The API key can be inserted into templates using {GOOGLE_ANALYTICS_API_KEY}. The full JavaScript that Google Analytics expects (including the key) can be included in templates via {GOOGLE_ANALYTICS_JAVASCRIPT}
#'''Google Analytics Style for this Survey''': Choices are:
##'''Do not use Google Analytics''' - so {GOOGLE_ANALYTICS_JAVASCRIPT} is an empty string
##'''Default Google Analytics''' - {GOOGLE_ANALYTICS_JAVASCRIPT} uses the standard Google Analytics code, inserting the proper Google Analytics Key
##'''SurveyName-<nowiki>[</nowiki>SID]/GroupName''' - {GOOGLE_ANALYTICS_JAVASCRIPT} contains customized Google Analytics code to log the URL as {SURVEYNAME}-<nowiki>[</nowiki>{SID}]/{GROUPNAME}. This can be helpful if you want to analyze navigation paths through your survey, time spent per page, and drop-off rates per page.


'''Google API howto''':
# Register/login on Google Analytics (GA): [http://www.google.com/analytics/ www.google.com/analytics/]
# Create a key (the site should not point to the survey, but to the part before 'index.php?') The key should be UA-xxxxx.
# Go to your survey's global settings in LimeSurvey.
# Put the key in appropriate field (Google Analytics API Key). It's probably the best to set GA Style to track all pages as you can have more info.
# You don't need to do anything in shipped templates, as the {GOOGLE_ANALYTICS_JAVASCRIPT} part is already there.
# Activate the survey.
# Do the survey.
# Go to GA panel mainsite. (select appropriate account in left-hand upper corner if you have more than one). You should see some graphs with the statistics. Beware of the dates in upper right corner.

==Tokens== 


*'''Anonymized responses?''': This allows you to determine whether responses to your survey are matched up with information from your surveys tokens table, or kept 'anonymous'. The default is 'No'. If you choose 'Yes' then your survey is set to radically anonymize responses - there is really no way to connect answers and participants. Even the admin can't link response data and participant/token data. However you will always be able to specifically view each response entered by your participants in the survey. Thus individual, but anonymous, statistics is still possible to do. '''''Attention:''''': If this feature is activated the response submission date and the token completed date are always set to 1980-01-01 00:00, no matter of other settings. Why? Invalidating the submission date ensures no match with webserver logs where the token key might show up when a survey is started. Invalidating the token completed date makes sure that you can't align the order of submitted responses to the order of the token date/time.


*'''Allow multiple responses or update responses with one token?''': Default: No . If you activate this setting the participants may return to his survey by clicking the invitation link, even if he already submitted the survey. If survey is anonymous or Enable token-based response persistence is set to NO, this adds a new responses. If survey is not anonymous and Enable token-based response persistence is Yes, user update existing responses.


*'''Enable token-based response persistence''': If your survey uses tokens and your responses are not anonymized, then you may want to enable this feature. If you turn this on, then your participants can leave your survey and resume later at any time without using the 'Resume later' function - for example if he/she gets distracted or his browser crashes. Upon clicking the invitation link again he will find his survey answers so far still in place when returns to the survey and will even continue on the last page seen.


*'''Allow public registration''': If you use tokens to control access to your survey, the only people who can use the survey are those who have an entry and a unique token from the token table. If you would like to use tokens, but also allow public registration, set this to "Yes". The "Yes" setting will allow a visitor to register his name and email address. The script will create a new entry in your tokens table for this person, then send them an invitation email. The script will ensure that only one person per email address can complete your survey.


*'''Use HTML format for token emails?''': When set to yes, all emails sent by the token management interface (invite, reminder, confirmation) will be formatted as HTML. You'll then be able to use rich formatting for this emails. Default is Yes at survey creation. Caution, when you switch on/off this feature, you'll have to double check that your email templates are still displayed as you want.


*'''Set token length to''': Usually you don't need to change this, the default setting of 15 digits (max. supported value: 99) is fine. If changing this setting please enter a number (X) which should be greater than 5 (if the number entered is <5 it will be converted to the default value of 15). When generating tokens all tokens will use a length of X digits.

==Import== 


Alternatively you can [[Importing a survey structure|import a survey structure]] from this tab on survey creation. You have the option to let LimeSurvey automatically convert relative URLs to local images/media files and INSERTANS tags (recommended).

==Copy== 


Alternatively you can copy an existing survey from this tab on survey creation. You have the option to let LimeSurvey automatically convert relative URLs to local images/media files and INSERTANS tags (recommended). The other options are pretty self-explaining. Please note that when copying a survey the start date and the end date of a survey cleared.

==Panel integration (URL parameters)== 


<div class="simplebox"> Please note that this tab is currently not visible on survey creation but only when you edit the survey settings after saving them for the first time.</div>


On this tab you can set which additional URL parameters will be accepted by your survey. If you like you can also save the value as a response of a "Short text question" or "Multiple short text question" type (you will be able to select any short text question to save it to). Even if you do NOT save the value of the URL parameter you will be able to use this parameter in the end URL. Please have a look at the documentation of the [[URL_fields#Passthrough_fields_.28LimeSurvey_2.x_or_later.29|End-URL]] for further information.

==Resources== 


This tab lets you manage files (pictures, media files) that were uploaded in the HTML Editor and it is only visible if you edit a survey - not during survey creation.


You can:
* Browse available files
* Export files as a ZIP archive
* Import a ZIP archive of files


Important hints:
* Authorized files extensions are defined in config-defaults.php.
* Files for the survey are in the upload/surveys/<sid> subdirectory.
* Uploaded files will only been seen while browsing resources on this survey (groups, questions, answers) not in other surveys or objects (labels).
* Do not expect this limited visibility to ensure confidentiality of the resources as they are reachable with a simple browser to anyone who know the URL to the file.
* You can't import a ZIP file containing subdirectories.

=Additional languages= 


To add more language to a survey you have to create and save it - then edit it again. Now you can add and remove additional languages to the survey. If you remove a language from a survey the complete contents of that language in that survey is deleted permanently so be careful what you are doing.


By clicking on the button 'Save and continue' on the first page in the survey settings you will be taken to the language-specific page which lets you change all texts for each language like ''Survey name'', ''Welcome Text'', etc. You can also edit the date format which should be used for a certain language.

</translate>

Surveys - introduction

2014-06-11T09:00:00Z

Southcot:

<languages /> <translate>

__TOC__

=Overview=

To create a new survey, click on the Add button [[File:add.png]] on the right side of the administration button bar and a "Create New Survey" screen will appear. You can edit most of these settings later again by click the 'Edit survey settings' icon [[File:token_manage_30.png]] in the 'Survey properties' dropdown menu of the survey toolbar.

=Video tutorials= 


There are a number of tutorial videos for LimeSurvey out there. This is a list of the ones we think that are the best. You are welcome to create a new tutorial and add it here.
*[[LimeSurvey Video-Tutorial|Tutorial A]] - this video tutorial was made available to us by Andreas Pursche ([http://www.paul-consultants.de/ PAUL Consultants e.V.] of University of Technology Dresden).
*[http://www.youtube.com/watch?v=KWE0wAoyvak Tutorial 'How to get started - a first survey' ] - this one is really nice and available on YouTube and should be viewed in HD
*[http://youtu.be/Uk3FQyDTIY0 LimeSurvey training video - template customization] - A very good introduction on how to customize a Limesurvey template

=Sample Surveys= 


One easy way to learn LimeSurvey is to experiment with working surveys. Here are a [[Expression Manager Sample Surveys|dozen surveys]] that demonstrate all of the key features, including the new (1.92+ and above) [[Expression Manager|Expression Manager]]-based functionality for relevance-based navigation/branching; tailoring/piping/reporting; and validation.


We also provide [[Expression Manager HowTos|How To]] and [[Expression Manager Examples|Examples ]]pages to help orient users to Expression Manager.


Simply import those surveys into your installation (or into the [http://www.limesurvey.org/en/demo public LimeSurvey demo]), and test the survey. One of the easiest ways to review the survey logic is via the new [[Show Logic File|Show Survey Logic]] feature.

=Basic survey elements= 


A '''survey''' has three integral elements, each of which must exist:
*A survey name
*At least one group
*At least one [[Question types|question]]


Optional elements to a new '''survey''' include:
*Applicable answers to each question
*Modifiable labels (known as label sets)
*Conditions that determine whether a question should be asked

==Survey name== 


The '''survey name''' provides the unique title to a '''survey''' and becomes the handle to access various option settings that apply to the survey as a whole. Settings such as the welcome message on the opening screen, the description of the survey, contact information for the survey administrator, and what format the questions are to be asked.

==Question Groups== 


A '''survey''' requires each question to be a member of a '''group''' (and only that '''group'''). Depending on the number of questions in the survey, '''Groups''' can be used to define logical sections, common subject themes, or possibly pages on the screen. A group can have questions about a similar subject or simply be setup as a manageable number of questions.


<div class="simplebox">'''Note''':<br />This whole chapter deals with '''question groups'''. Do not confuse a '''question group''' with a '''user group'''. Each is very different and used in different ways, based on the object being grouped.</div>


A question '''group''' has a title and an optional description. You must have at least one '''group''' in each survey, even if you do not wish to divide the survey into multiple groups.

==Questions== 


'''Questions''' are the core of your survey. There is no real limit to the number of '''questions''' you can have in your '''survey''' or in a '''group'''. '''Questions''' include the actual question text as well as settings that determine what form of answer you will accept. You can also specify a short 'help' explanation for each question and determine whether the question is mandatory (that is, must be answered) or optional. For more details check the [[Question types|question types]] section.

=Basics of navigating the survey administrative interface= 


The '''LimeSurvey''' tool presents horizontal tool bars to the survey creator in their web browser. These toolbars are the header of a window allowing interaction.

==Administrative Tool Bar== 


The top toolbar is usually the '''Administrative Tool Bar''' providing top level, global actions. One of the key items there is the drop down list of surveys along with a '''Create New (Survey)''' button; if available and enabled for your login account. Both are on the right side of the toolbar.


[[File:SystemAdmin.png]]


<div class="simplebox">'''Hint''':<br />Want to know more about a particular icon button in a tool bar? Hover over the icon to see its name or click on the Help button [[File:help-button.png]] in the '''Administrative Tool Bar''' to see a description of icons in the currently active toolbar.</div>


If the '''Administrative Tool Bar''' does not appear to be on top, click the home button [[File:button-home.png]] to get back to it. The Labelset [[File:button-labelset.png]] and Template [[File:button-template-editor.png]] editors, available in this tool bar, are the only ones that can replace the '''Administrative Tool Bar'''.


By clicking the '''Create New (Survey)''' button [[File:CreateSurvey-button.png]] or selecting an existing survey, you minimize the Administrative window and open a new tool bar below to manage the '''Survey'''.


[[File:GroupToolbarSmall.png]]

==Survey Tool Bar== 


Similar to before, one can click on the drop down list of question '''Groups''' or on the '''Create New (Group)''' button [[File:CreateSurvey-button.png]] on the '''Survey''' toolbar. Either selection will bring up the question '''Group''' toolbar below the '''Survey''' toolbar.


[[File:SurveyToolbarSelectGroupSmall.png]]

==Group Tool Bar== 


In the Question Group, you can click on the drop down list of '''Questions''' or click the '''Create New (Question)''' button [[File:CreateSurvey-button.png]] to add a fourth toolbar to now edit a '''Question'''.


[[File:GroupToolbarSelectQuestion.png]]

==Common Buttons== 


In these nested toolbars are some common, navigational buttons. There is an '''Edit''' button [[File:edit-button.png]] to edit the object you selected. By default, you will be put in the editor if you create the object. There is a '''Delete''' button [[File:delete-button.png]] to delete the object. For '''Groups''' and '''Questions''', there is a '''Reorder''' button [[File:change-order-button.png]] to change the order the object appears in during the survey execution. Finally, there is an '''Export''' button [[File:export-button.png]] to export a survey, question group or question that you can import back into another survey. Note that the '''Create''' button [[File:CreateSurvey-button.png]] also allows you to import a previously exported object.


[[File:QuestionToolbar.png]]


Finally, there are two to three small buttons to the far right [[File:CommonButtons.png]] to minimize, maximize, and close the window of a toolbar. The maximize button will take you back to the summary window of the currently selected object.


As seems natural, the window of the current toolbar is automatically minimized when you select a lower level object to edit. Only the current toolbar and its window can be closed. You can open a previous toolbar and window by clicking on its maximize button. And you can jump around by selecting or creating a new object in another toolbar without having to close the currently open window first.


We will discuss navigating through a survey itself later on in the section on testing the survey.

=Survey settings= 


Now that we have some basics down, lets move on and create our first survey. When doing so, we first have to define the basic [[Survey settings|survey settings]].
</translate>

Questions - introduction

2014-06-09T16:46:13Z

Southcot:

<languages /> <translate>


__TOC__

=Introduction= 


Once you have [[Creating a question group|created your groups]], you can start adding questions within each group. Create a new question by clicking on the add icon [[File:add.png]] on the right hand side of the "Group" menu bar.


When adding a question, you will be asked for a "Question Code", the "Question", "Help" and a "(Question Types|question type)". All new questions are assigned to the Group you were viewing when you clicked "Add Question", however you can change the group the question belongs too at a later point.

=Field descriptions= 
*'''Question code:''' Your ID, or number or code for the question. This field is only for quick identification for a question in export or for evaluation. Try to be consistent with your coding in this field. Planning makes your evaluation a lot easier at a later time. This field is normally not displayed to people taking the survey.


<div class="simplebox">Note: The question Code should be unique, and must start with a letter, and only contain letters and numbers. If you ever tried to export your data to SPSS or R, you discovered that the qcode becomes the value label, so you have to make code unique. For the time-being, LimeSurvey will support legacy code values, but the [[Show Logic File|Show Logic File]] button will color-code such questions so that you know you should change their names.</div>
*'''Question:''' This is the actual question being asked. There is no real limit to the length of the question here, however if you want to explain the question, leave that for the "Help" field. HTML-code can be used, e.g., for including images:<br /><nowiki><img src="http://www.yourdomain.com/yourpics/pic.jpg"></nowiki>
*'''Help:''' This is an optional field. It is useful if a question needs some explanation, or you want to explain how it should be answered. When you put text in this field, a "Question Mark" icon appears on the survey entry screens with the help text right beside.
*'''Question type:''' This determines the type of response the survey allows. View the [[Question types]] section for a description of the various options available.
*'''Validation:''' This feature is available on all free text type or numeric questions. You can use standard [[Using regular expressions|Regular Expressions]] in this field to validate the responses to the question, and if the responses don't validate against this expression, the user will be prompted to try again before they can progress.


*'''Other?:''' Depending upon your chosen 'question type' this option may appear. It allows you to specify that an "other" option be presented in some of the list question types.
*'''Mandatory?:''' For all question types this setting allows you to require users to answer the question, before they can move on to the next question. For ranking question this means all items have to be ranked.


*'''Relevance''': This is the Boolean equation that specifies the conditions for this question. If it evaluates to true, the question is show; otherwise it is hidden and since it is irrelevant, data for that question is NULLed in the database. Details about how to use Relevance can be found on the [[Expression Manager|Expression Manager]] pages.


*'''Show advanced question settings:''' The advanced question settings are different for each question type. Please consult the documentation for your particular [[Question types|question type]]

=Importing a question= 


At the bottom of the New Question Form you will find a file selection box to import a question file. Here you can import any question file (*.lsq or *.csv (old format)) you previously exported - for example this is useful if you want to reuse a question from another survey.


<div class="simplebox">Important: If you import a question there will always be a new question created. The original question will not be overwritten. If you want to copy a question inside the same survey it is easier to select the existing question and than use the "Copy current question" button.</div>

=Information from tokens table= 


You can insert information/text from the tokens table into your question so that it can show context related information. For LimeSurvey to do this, the survey needs to be set as NOT Anonymous (ie: tracked), and it needs to have a tokens table.<br /><br />The fields available for this are:<br />


{|
|{TOKEN:FIRSTNAME}||inserts the value from the "firstname" field in the tokens table
|-
|{TOKEN:LASTNAME}||inserts the value from the "lastname" field in the tokens table
|-
|{TOKEN:EMAIL}||inserts the value from the "email" field in the tokens table
|-
|{TOKEN:ATTRIBUTE_1}||inserts the value from the "attribute_1" field in the tokens table
|-
|{TOKEN:ATTRIBUTE_2}||inserts the value from the "attribute_2" field in the tokens table
|}


To use this functionality you must type the field text into your question exactly as listed above.
Example:


Hello {TOKEN:FIRSTNAME}. We sent an email to you using this address {TOKEN:EMAIL}. Is this correct?


Another example with more customisation, but using JavaScript (please see [[Optional settings |Optional settings]] on how to allow JavaScript when setting up questions and why it's not always a good idea. To use JavaScript you will need to deactivate the XSS filter in the [[Global settings]]):


<syntaxhighlight lang="php" enclose="div">Hello {TOKEN:FIRSTNAME}. We sent an email to you using this address {TOKEN:EMAIL}. Is this correct?
What do you as a {TOKEN:ATTRIBUTE_1} think about your
<script type="text/javascript" language="Javascript">;
var job='{TOKEN:ATTRIBUTE_1}';
if (job=='worker') {
document.write ('bosses')
} else {
document.write('workers')
}
</script>
?
</syntaxhighlight>


<div class="simplebox">Starting in Version 1.92, you can use [[Expression Manager|Expression Manager]] to do such tailoring without needing JavaScript. The equivalent in Version 1.92 is the following:</div>


<syntaxhighlight lang="php" enclose="div">What do you as a {TOKEN:ATTRIBUTE_1} think about your {if(TOKEN:ATTRIBUTE_1=='worker','bosses','workers')}?</syntaxhighlight>

=Information from previous answers= 


There is currently also the capacity to insert the answer of previous questions into the text of an answer with the following provisos:
* The question must have been answered in a previously displayed '''page''' in the survey - answers to questions on the current page are not available
* You refer to the exact Survey ID, Group ID and Question ID for the question to which the answer was made - in the form: {INSERTANS:SIDXGIDXQID} - ie {INSERTANS:1X2X3}. Read more under [[SGQA identifier]] to find out how to create this code.


<div class="simplebox">Note: Starting in Version 1.92, the above limitations no longer exist:
*You can refer to answers on the same page, and even dynamically update tailored messages as responses change on the page.
*You can use qcode naming instead of {INSERTANS:SGQA} - for more details, see the [[Expression Manager|Expression Manager]] documentation</div>


A wizard has been integrated in the Wysiwyg HTML editor (FCKeditor), so that you can easilly insert previous answers SGQA codes: this plugin is called the LimeReplacementFields. In order to use this feature, in the FCKeditor, click on the "lime between brackets" icon, and select a question from the select box. Only answers from previous pages are displayed.


<div class="simplebox">LimeReplacementFields notice: when you want to delete a reference to a {SGQA} tag, please select all chars from the openning bracket to the closing bracket and press delete: DO NOT erase it char by char with the Delete or Backspace key otherwise the field will appear again.</div>

=Styling Questions= 


It is possible to generally edit the question layout/design by using CSS using [[The template editor|the template editor]].

</translate>