|
|
| (129 intermediate revisions by 19 users not shown) |
| Line 1: |
Line 1: |
| | <languages /> |
| | <translate> |
|
| |
|
| <div style="float:right;"><div class="simplebox">Additional pages:{toc}</div></div> | | <!--T:2--> |
| | __TOC__ |
|
| |
|
| __TOC__
| | =Introduction= <!--T:43--> |
| | |
| | |
| | <!--T:44--> |
| | The survey settings menu allows users to edit different survey-related settings. The following survey settings are available by default: |
| | |
| | |
| | <!--T:45--> |
| | <center>[[File:Settings Menu screen.png]]</center> |
| | |
| | |
| | <!--T:46--> |
| | *[[Survey settings#Overview|Overview]] |
| | *[[Survey settings#General settings|General settings]] |
| | *[[Survey settings#Survey texts|Text elements]] |
| | *[[Survey settings#Data policy settings|Data policy settings]] |
| | *[[Survey settings#Theme options|Theme options]] |
| | *[[Survey settings#Presentation|Presentation]] |
| | *[[Survey settings#Participant settings|Participant settings]] |
| | *[[Survey settings#Notifications & data|Notifications & data]] |
| | *[[Survey settings#Publication & access|Publication & access]] |
| | |
| | |
| | <!--T:47--> |
| | In the screenshot above, two buttons are emphasized. They can be used by users to rearrange the survey settings menu dimensions. If you wish to rearrange the main survey settings menu, drag the right side of the menu to the left or to the right by clicking the '''three-dots'''. If you click the '''left arrowhead''', the menu collapses and is minimized until the only a side menu with icons is left. To go back to the default view of the survey settings menu, click the '''right arrowhead''' located above the survey settings menu. Hover the mouse over each option to see what each icon does. |
| | |
| | <!--T:49--> |
| | <div class="simplebox">[[File:help.png]] '''Note''': The menu can be changed/edited from the [[Menu configuration]] and [[Menu entries configuration]] pages. They can be accessed from the LimeSurvey configuration dialog. '''We recommend that only advanced users edit menus.'''</div> |
| | |
| | |
| | <!--T:101--> |
| | {{Note|The survey menu (located below the survey settings) is described [[Survey menu|here]].}} |
| | |
| | =Overview= <!--T:50--> |
| | |
| | |
| | <!--T:51--> |
| | The overview page offers an overview of your survey. It is divided in two parts: |
| | *'''Overview toolbar:''' The functions from the toolbar allow you to start/stop the survey, check its logic, save & export it, add survey participants, and manually introduce survey participants' data (in the case in which you conduct an offline survey); |
| | |
| | <!--T:53--> |
| | *'''Survey summary:''' A short summary of your survey. |
| | |
| | |
| | <!--T:54--> |
| | For a complete description, check the [[Overview|Overview panel]] wiki page. |
| | |
| | =General settings= <!--T:55--> |
| | |
| | |
| | <!--T:56--> |
| | The general settings of a survey allow the user to edit basic survey information, such as the survey owner, administrator's email, and the template used in the survey. |
| | |
| | <!--T:57--> |
| | For further details, please continue reading [[General settings|the following wiki]] page. |
| | |
| | =Text elements= <!--T:58--> |
| | |
| | |
| | <!--T:59--> |
| | From the '''Survey text elements''' panel, you can edit the title of the survey and its description, welcome and end messages, end URL, and the format of the decimal mark and date. |
| | |
| | <!--T:60--> |
| | For more details, access the [[Text elements|Survey text elements]] section. |
| | |
| | |
| | =Data policy settings= <!--T:102--> |
| | |
| | |
| | <!--T:103--> |
| | The set of options displayed under this option are related to the security text/policy settings. These are the settings that survey participants need to be aware of before completing the survey. |
| | |
| | <!--T:104--> |
| | For more details, access our wiki section on [[Data policy settings|data policy settings]]. |
| | |
| | =Theme options= <!--T:61--> |
|
| |
|
| =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:edit.png]] in the survey toolbar.
| | <!--T:62--> |
| | This panel is for users who would like to enhance their templates by using the inheritance function and the bootswatch themes. |
|
| |
|
| =1st Step - Creation=
| | <!--T:63--> |
| | For more details, access our wiki section on [[Theme options|theme options]]. |
|
| |
|
| All survey settings are organized in tabs. The following is a description of each tab and field.
| |
|
| |
|
| ==General== | | =Presentation= <!--T:67--> |
| #'''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. When you create a survey, you cannot add additional languages. You could only do that if you edit the survey properties again.
| |
| #'''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.
| |
| #'''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 ivitation email.
| |
| #'''Welcome''': 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.
| |
| #'''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.
| |
| #'''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> | | <!--T:68--> |
| | In this panel you can edit presentation- and navigation-related settings. These changes impact how the survey is presented to survey participants. You can choose to show the number of the questions at the beginning of the survey, a progress bar or the current statistics of the survey once it is completed, and so on. |
|
| |
|
| ==Presentation & navigation==
| | <!--T:69--> |
| #'''Format''': Choose from "One at a time", "Group at a time" or "All in one".
| | For a complete description, access the following [[Presentation|link]]. |
| **'''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 "One at a time" 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 in the LimeSurvey [[Templates / The Template Editor]] Guide.
| |
| #'''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.
| |
| #'''Keyboard-less operation''':
| |
| #'''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''': (''since 1.80'') 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'').
| |
| #'''List survey publicly''': Yes/No. Default No. When it is set to yes, your survey will be listed in the 'available surveys' portal
| |
| #'''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. Which is defined in the Text Elements Section.
| |
| #'''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''':
| |
|
| |
|
| ==Publication & access control== | | =Participant settings= <!--T:76--> |
| #'''Only users with tokens may enter the survey''': This is pretty self-explaining. If you activate this then tokens (to access the survey) are enforced. (''Note: ''This setting was removed in version 1.87. If you create a [http://docs.limesurvey.org/tiki-index.php?page=Tokens&structure;=English+Instructions+for+LimeSurvey#How_to_activate_tokens_ token table] access to the survey will automatically be limited to users with a valid token.)
| |
| #'''Set token length to''': (''since 1.87'') 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.
| |
| #'''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.
| |
| # '''Start date''': 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''': 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.
| |
| #'''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.
| |
|
| |
|
| ==Notification & data management==
| |
| #'''Admin Notification''': Options to allow the administrator to be emailed when each individual survey response is saved. You can choose from:
| |
| ##No email notification - Self-explanatory.
| |
| ##Basic email notification - An email is sent informing the administrator that a survey response has been saved.
| |
| ##Send email notification with response codes - Sends the full answers to the survey after saving.
| |
| #'''Email Responses To:''' (''since 1.87+'') This allows you to send the survey responses to additional email addresses once the survey is submitted. Multiple entries or different methods can be used by seperating the entries with a semicolon (;) - eg "yourname@test.com; myname@test.com;hisname@test.com" OR when using multiple methods: "yourname@test.com;{INSERTANS:82733X12X73};{TOKEN:EMAIL}". There are three different methods 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 [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#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 [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#Information_from_tokens_table Re-use Information from the Tokens Table]
| |
|
| |
|
| +It should be noted that entering an email address here will override the "Basic email notification" setting so the recipient(s) listed here and the survey admin will receive full answers.
| | <!--T:77--> |
| #'''Anonymous answers?''': 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 yes. If you choose "No" for anonymous, you must also have a tokens table for your survey when you activate it. '''''Attention:''''' If your survey is set to ''anonymous'' there is really no way to connect answers and participants. Even the admin can't link answers' data and users' data. However you will always be able to specifically view all answers entered by a certain anonymous individual participant in the survey. Thus individual, but anonymous, statistics is still possible to do.
| | From this menu you can edit different survey participants table settings. For example, you can choose to anonymize all the responses you get from a survey or allow public survey registration. |
| #'''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 referring 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 token-based response persistence''': If your survey uses tokens and is not anonymous, then you may want to enable this feature. If you turn this on, then an auto-save is performed each time a participant answers a question, meaning that even if he hasn't submitted the survey and his browser crashes, he will find his survey answers still in place when returns to the survey. This can be used for designing pre-filled surveys as well (see data entry and importVV facility when not finalizing answers).
| |
| #'''Enable assessment mode?''': With this setting you can enable/disable [[Assessments|assessments]] for this survey.
| |
|
| |
|
| ==Import survey==
| | <!--T:78--> |
| | For a complete description of the options, access our wiki section on [[Participant settings|survey participants handling]]. |
|
| |
|
| Alternatively you can [[Importing a survey structure|import a survey structure]] from this tab. You have the option to let LimeSurvey automatically convert relative URLs to local images/media files and INSERTANS tags (recommended).
| | =Notifications & data= <!--T:85--> |
|
| |
|
| ==Uploaded resources management==
| |
|
| |
|
| This tab let you manage files (pictures, media files) that were uploaded in the HTML Editor.
| | <!--T:86--> |
| | If you would like to save response-related details into the responses tables, access this panel. You can save the referrer URL, IP address, timings, etc. that can help you produce more in-depth analyses. Moreover, LimeSurvey allows you to use the tracking ID from Google Analytics. |
|
| |
|
| You can:
| | <!--T:87--> |
| * Browse available files
| | For more explanations, read about [[Notifications & data|notifications and data management settings]]. |
| * 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.
| |
|
| |
|
| =2nd Step - Additional languages= | | =Publication & access= <!--T:70--> |
|
| |
|
| 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.
| | <!--T:71--> |
| | This setting allows the survey administrator to choose the way in which the survey can be accessed by the survey participants (e.g., CAPTCHA codes can be used to increase the security of your survey). Moreover, you can also set up from here a start/expiry date/time. |
|
| |
|
| Previous [[Creating surveys - Introduction]]
| | <!--T:72--> |
| | For more details on each option, read from our manual about [[Publication & access|Publication & access]]. |
|
| |
|
| Next [[Importing a survey structure]]
| | </translate> |
Introduction
The survey settings menu allows users to edit different survey-related settings. The following survey settings are available by default:
In the screenshot above, two buttons are emphasized. They can be used by users to rearrange the survey settings menu dimensions. If you wish to rearrange the main survey settings menu, drag the right side of the menu to the left or to the right by clicking the three-dots. If you click the left arrowhead, the menu collapses and is minimized until the only a side menu with icons is left. To go back to the default view of the survey settings menu, click the right arrowhead located above the survey settings menu. Hover the mouse over each option to see what each icon does.
The survey menu (located below the survey settings) is described
here.
Overview
The overview page offers an overview of your survey. It is divided in two parts:
- Overview toolbar: The functions from the toolbar allow you to start/stop the survey, check its logic, save & export it, add survey participants, and manually introduce survey participants' data (in the case in which you conduct an offline survey);
- Survey summary: A short summary of your survey.
For a complete description, check the Overview panel wiki page.
General settings
The general settings of a survey allow the user to edit basic survey information, such as the survey owner, administrator's email, and the template used in the survey.
For further details, please continue reading the following wiki page.
Text elements
From the Survey text elements panel, you can edit the title of the survey and its description, welcome and end messages, end URL, and the format of the decimal mark and date.
For more details, access the Survey text elements section.
Data policy settings
The set of options displayed under this option are related to the security text/policy settings. These are the settings that survey participants need to be aware of before completing the survey.
For more details, access our wiki section on data policy settings.
Theme options
This panel is for users who would like to enhance their templates by using the inheritance function and the bootswatch themes.
For more details, access our wiki section on theme options.
Presentation
In this panel you can edit presentation- and navigation-related settings. These changes impact how the survey is presented to survey participants. You can choose to show the number of the questions at the beginning of the survey, a progress bar or the current statistics of the survey once it is completed, and so on.
For a complete description, access the following link.
Participant settings
From this menu you can edit different survey participants table settings. For example, you can choose to anonymize all the responses you get from a survey or allow public survey registration.
For a complete description of the options, access our wiki section on survey participants handling.
Notifications & data
If you would like to save response-related details into the responses tables, access this panel. You can save the referrer URL, IP address, timings, etc. that can help you produce more in-depth analyses. Moreover, LimeSurvey allows you to use the tracking ID from Google Analytics.
For more explanations, read about notifications and data management settings.
Publication & access
This setting allows the survey administrator to choose the way in which the survey can be accessed by the survey participants (e.g., CAPTCHA codes can be used to increase the security of your survey). Moreover, you can also set up from here a start/expiry date/time.
For more details on each option, read from our manual about Publication & access.
Note: The menu can be changed/edited from the Menu configuration and Menu entries configuration pages. They can be accessed from the LimeSurvey configuration dialog. We recommend that only advanced users edit menus.