Actions

Question type - Text display

From LimeSurvey Manual

Revision as of 22:00, 5 May 2013 by FuzzyBot (talk | contribs) (Importing a new version from external source)

Short description

This question type does not collect input from the user and simply displays text. It can be used to provide further instructions or a design break in the survey.

Please note that the text of this question can take html or javascript code, therefore it can also be used for other purposes.


Core settings

Condition (previously "Relevance equation")

Description

If the result value of the condition is "1" or "true", the question is "relevant" in the survey context, i.e. it is shown to the survey participant. If not, the question is hidden. Any survey question allows you to specify a relevance equation. This function is the successor of conditions and supports much more complex conditional logic.

Syntax Highlighting

Whenever you save the condition, it is evaluated and syntax-highlighted. Any errors will be color coded so that you can quickly detect and fix them.

 Hint: To check if all conditions are used correctly within your survey, read about our show logic file feature.


Valid values

  • Any condition that makes use of the ExpressionScript syntax, without surrounding curly braces.

Examples

Here are good examples of syntax highlighting.


Advanced settings

Randomization group name (random_group)

Description

It places the questions into a specified randomization group, all questions included in the specified group being displayed in a random order to the survey respondents.

You can find a sample survey using randomization group name in ExpressionScript sample survey.

Valid values

Just enter any string you like (for example: 'group1'). All question which have set the same string within the randomization group name box will have their place in the survey randomized (=randomly exchanged among each other).


Preview To preview the questions use the preview survey instead of the preview question group function, as the second has been reported to not show the questions in a randomized order.


Always hide this question (hidden)

Description

If enabled, the question will always be hidden - it will not be displayed to the survey participants. This function can be used in the following scenarios:

  • If you wish to prefill a question with a URL and you want not to have it displayed on the screen. This overrides any conditions used within the survey because the respective question will not even be embedded on the page.
  • If you wish to store or calculate a value on the fly via the ExpressionScript - Presentation.
Note: A common question type that is used with this function is the Equation one.

Available options

  • On
  • Off (default)


Insert page break in printable view (page_break)

Description

This attribute is only active when you actually print a survey from the Printable View. It forces a page break before the question.

Available options

  • On
  • Off (default)


Time limit (time_limit)

Description

Setting the time_limit attribute on a question will cause a countdown timer to begin counting down as soon as that question/page is loaded. At the expiry of the countdown timer the question will either automatically move on to the next page or become read-only.

Valid values

  • Any positive integer number

Example

Set it to 240 to count down from 4 minutes (240 seconds).


<translate>

<onlyinclude>

Time limit action (time_limit_action)

Description


Sets the action performed when a time_limit has expired. By default the action for a time limit is "Warn and move on", which means the system will give a short warning that the time limit has expired before saving the question and effectively automatically clicking "Next >>". The alternative choices are to:

  • "Move on without warning", which automatically clicks the "Next >>" button after the timer is finished but without any warning message.
  • "Disable only", which disables changes in the question so the participant can't change anything, but doesn't automatically click the "Next >>" button.

This setting is only applicable if the general time limit setting is activated.

Available options

  • Warn and move on (default): will warn the participant that the time has expired, and then click the next button
  • Move on without warning: will immediately click the next button after the time limit has expired
  • Disable only: will disable the answer after the time limit has expired but not automatically click next


Additional information


  Attention : If the question is mandatory, or a question in the group is mandatory, a JavaScript loop will be created if the mandatory question(s) is/are not answered. As a result, an error will be displayed on the screen that certain questions have not be filled in, which in turn will trigger the refresh of the page.
Instead of relying on mandatory questions, you may use expressions (read more about question and subquestion validation equations) to make the user not leave empty the answer fields. To see how the validation equations work, check the following example.



In the case in which you want to apply a timer to a question group, activate the group-by-group survey mode, set up a question to use the time limit functionality, and choose the warn and move on (default) option as time limit action. Once the question timer expires, the survey will move to the next page.

</translate>


Time limit disable next (time_limit_disable_next)

Description

It allows disabling the "next" button while a time_limit countdown is occurring. Normally, even if the time limit countdown is active, if the participant wants to click "Next" and move on to the next question or question group, they can simply click on the "Next" button (thus cutting short the time spent on the question or question group). By activating this function, the next button will appear greyed out and will not be available until the countdown timer has finished.

This settings is only applicable if the general time limit setting is activated.

Available options

  • On - The "Next" button will be disabled until the time limit countdown is complete.
  • Off (default)
Note: If your survey uses the group by group format, this function applies to the whole group this question belongs to.



Time limit disable prev (time_limit_disable_prev)

Description

It allows disabling the "previous" button while a time_limit countdown is occurring. Normally, even if a time limit countdown is active, if the participant wants to click on "Previous" and move to the previous question or question group, they can simply click on the "Previous" button (thus cutting short the time spent on the question or question group). By activating this function, the previous button will appear greyed out and will not be available until the countdown timer has finished.

This settings is only applicable if the general time limit setting is activated.

Available options

  • On - the "Previous" button will be disabled until the time limit countdown is complete.
  • Off (default)
Note: If your survey uses the group by group format, this function applies to the whole group this question belongs to.



Time limit countdown message (time_limit_countdown_message)

Description

Write in this field the text message you wish to be displayed in the countdown timer during the countdown. This setting is applicable only if the general time limit setting is activated. If nothing is written, the the field will use the default value: "Time remaining".



Time limit timer CSS style (time_limit_timer_style)

Description

It allows (and overrides the default) css styling used to display the countdown timer. The default style value for this attribute will be used if it does not exist, which is: 'width: 150px; margin-left: auto; margin-right: auto; border: 1px solid #111; text-align: center; background-color: #EEE; margin-bottom: 5px; font-size: 8pt;'.

Any text entered into this attribute will overwrite the entire default css style, so you should ensure that care is taken when entering a value for this attribute. A simple way to hide this is to copy the default style into this attribute and add 'display: none;' to the end.

This settings is only applicable if the general time limit setting is activated.


{INCLUDE(page="Advanced question settings",start="!time_limit_message_delay",stop="---")}{INCLUDE}

{INCLUDE(page="Advanced question settings",start="!time_limit_message",stop="---")}{INCLUDE}

{INCLUDE(page="Advanced question settings",start="!time_limit_message_style",stop="---")}{INCLUDE}

{INCLUDE(page="Advanced question settings",start="!time_limit_warning",stop="---")}{INCLUDE}

{INCLUDE(page="Advanced question settings",start="!time_limit_warning_display_time",stop="---")}{INCLUDE}

{INCLUDE(page="Advanced question settings",start="!time_limit_warning_message",stop="---")}{INCLUDE}

{INCLUDE(page="Advanced question settings",start="!time_limit_warning_style",stop="---")}{INCLUDE}