Actions

Label sets/en: Difference between revisions

From LimeSurvey Manual

(从外部源导入一个新的版本)
m (Text replacement - " enclose="div"" to "")
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<languages />  
<languages />  
__TOC__
__TOC__


=General=
=General=  


<div class="simplebox">The function and usage of label sets have change radically with version 1.90. This page refers to v 1.90 or newer versions.</div>
Label sets are list templates where each list has a set of codes with labels and can be used in most question types either as answers or as subquestions. Please bear in mind that LimeSurvey's label sets are merely copied to the particular question as subquestions or answers. Therefore, if you change a label set after you have 'used' it in a questionnaire, the changes will not propagate to the questions from the questionnaire where the respective label set is utilized.
   
This new usage of label sets gives much more flexibility for future development and makes the structure of a question more logical.


Label sets are basically list templates where each list has a set of codes with labels and can be used in most question types either as answers or as subquestions. Contrary to earlier versions of LimeSurvey label sets are merely copied to the particular question as subquestion or answers. So if you change a label set after you 'used' it the changes are not propagated to the questions where a label set has been used as a template.
{{Alert|title=Attention|text=A label set must contain the same base language as the survey, or you will not be able to use it for any question of your survey.}}


This new usage of label sets gives much more flexibility for future development and makes the structure of a question more logical.
Below is a label set example to help you better grasp the concept. [[Label sets#Label sets - how to...|Click here]] if you want to go straight to the label set management functions of LimeSurvey.  


<div class="simplebox">'''Hint:''' A label set must be at least contain the same base language as the survey, else you will not be able to use it for any question of your survey.</div>
If you want to define a custom 7-point scale, a label set provides this function. In the example below, a very simple custom label set with the code/label pairs ('''the label is what appears in the actual questions''').


An example of label set is as follows. If one wants to define a custom 7-point scale, a label set provides this function. In this example, a very simple custom label set with the code/label pairs is shown. Note that the label is what appears in the actual questions.
{|class=wikitable
 
{|
|'''Code'''||'''Label'''
|'''Code'''||'''Label'''
|-
|-
Line 32: Line 33:
|}
|}


Another graphical example:
Below is a graphical example where three different smileys are used instead of label text:
 
 
<center>[[File:3xSmiley-Question.gif]]</center>


Graphic (3 different smileys) instead of label text:
=Label sets - how to...=


[[File:3xSmiley-Question.gif]]
Click ''''Manage label sets''' in the '''Configuration''' menu to edit, create, delete, import, and/or export label sets.


=How to...=


Click on the [[File:labels.png]] "Edit/Add Label Sets"-Icon in the Administration-Menu to edit, create, delete, import or export label sets used in the 'flexible' labels questions.
<center>[[File:labels.png]]</center>


==...add a new label set==
*'''Set Name:''' Each new label set has to be given a name.
*'''Languages:''' Every label set must be specified for the language it's used for. You can choose as many languages from the menu as you want.


==...import a label set==
==...create or import new label set(s)==
*Create a new label set. In the screen where you can enter the label set details you will find a tab to import an existing label set. Choose a previous exported label set (either a .csv (outdated format) or .lsl file) and click on the "Import label set"-button to import. Alternative: Import a whole survey - in this case the label sets are imported with the questions. Duplicate label sets are ignored.
 
Click the '''Create or import new label set(s)''' button located in the upper-left corner of the page. You can either create a new label set or import it from [https://www.limesurvey.org/index.php/downloads/category/19-templates another source]:
 
*'''New label set:''' Label sets must be manually created.
**'''Set Name:''' Each new label set has to be given a name.
**'''Languages:''' Every label set must be specified for the language it's used for. You can choose as many languages from the menu as you want.
 
*'''Import label set(s):''' In order to import a label set, click browse and add the '''.lsl''' label set file. If you have previously created a label set, then LimeSurvey will not allow you import a similar external label set unless you turn off the ''Don't import if label set already exists'' option. '''Some useful label sets are available on the [https://www.limesurvey.org/index.php/downloads/category/19-templates LimeSurvey website]'''.
 
Once the label has been imported or created, click the Save button located in the right-upper part of the screen.
 
 
<center>[[File:Save_Close.jpg]]</center>
 
 
{{Note|If you import a whole survey, the label sets are imported too (with the questions). Duplicated label sets are ignored.}}


==...edit, delete, or export a label set==
==...edit, delete, or export a label set==


Choose an already existing label Set in the drop-down-Box in the label set administration bar to edit, delete or export a label set.
Each label set located in the '''Label sets''' list has a corresponding menu that contains the following four options:
*'''Edit label set:''' Here it&acute;s possible to rename the Label Set and add/remove languages for this Label Set.
*'''Delete label set:''' After a pop-up, you can delete the selected Label Set.
*'''Export label set:''' Export current Label Set to a .csv-File.
*'''Labels bar:'''


+To add a new label you have to fill in a label code, assessment value and label-text and press on the "Add new label"-Button. After this the label should be listed above. It's possible to use a graphic instead of or additionally to a label text. Just use HTML-code to include the graphic you want, e.g.:


<syntaxhighlight lang="html4strict" enclose="div">
<center>[[File:Edit menu labels.png|150px]]</center>
 
 
*'''View labels:''' Allows the user to view the existing labels located in the respective label set.
*'''Edit label set:''' The user can rename the label set and/or add/remove languages.
*'''Export label set:''' Export label set to a .lsl file.
*'''Delete label set:''' A window will pop up in order to confirm whether you want to delete the respective label set or not.
 
=Labels - how to...=
 
==...add a label==
 
You must fill in a label code, an assessment value, and a label description.
 
 
<center>[[File:Labels table.png]]</center>
 
 
Then, click the plus sign [[File:Add label.png]] to add the new label. It's possible to use a graphic instead of (or in addition to) a label text. To do that, you must use HTML-code to include the graphic you want, e.g.:
 
<syntaxhighlight lang="html4strict">
<img border="0" src="http://www.yourdomain.at/pics/pic.gif">
<img border="0" src="http://www.yourdomain.at/pics/pic.gif">
</syntaxhighlight>
</syntaxhighlight>


If your label set has more than one language, you can choose which language you want to edit. Every label needs a code, an assessment value and a title. The code can only be changed in the base language of the label set. The assessment value can be ignored (set it to 0) if you do not use [[Assessments|assessments]]. The title is the text, which is displayed in the question.
{{Note|Read also our wiki on [[Assessments|assessments]]. The column is ignored if you set all the values to 0.}}
*'''Del-button''': You can delete labels with the "Del"-button.
 
*'''Up/down-buttons''': It's possible to change the row of labels by the "Up" and "Dn"-buttons.
To help with the editing process of the HTML-code, use the embedded HTML editor of LimeSurvey, which is located at the end of the label-text box (click on the green pen button ->[[File: HTML editor.png|0.85px]]).
*'''Fix sort''': You can check the consistency and do a sort of the labels by pressing the "Fix Sort"-Button.
 
 
<center>[[File:Labels HTML editor.png]]</center>
 
 
{{Note|For a short introduction on the HTML editor utilized by LimeSurvey, check [[First_login_-_your_user_preferences#Your_account_preferences#Your_personal_settings#HTML_editor_mode|the following page]].}}
 
===Quick add===
 
Another way to add labels is to use the '''Quick add...''' button. When you click it, a window be displayed. It works under the following form: '''Code ; Title'''.
 
 
<center>[[File:QuickAddCodeLabel.png|0.8px]]</center>
 
 
You can either replace or add labels. If you click '''Replace''', all the preexisting labels will be deleted and replaced by the ones entered by you. If you click '''Add''', the new labels will be added into the label set (the preexisting ones not being affected).
 
 
<center>[[File:QuickAddResultsCodeandTitle.png|0.8px]]</center>
 
 
The '''Code''' is automatically added if new entrances are created. Therefore, you can type in only the title of the labels which will automatically be assigned a code:
 
 
<center>[[File:QuickAddLabel.png|0.8px]]</center>
 
 
<center>[[File:QuickAddLabelResults.png|0.8px]]</center>
 
 
The ''assessment values'' cannot be edited/entered via this option - it has to be changed manually from the list of labels.
 
{{Alert|title=Attention|text=If you wish to translate labels by using the '''Quick add...''' function, you need to add the translation on the same line(s) and be separated by a semicolon.}}
 
==...delete a label==
 
To delete a label, click the red trash button ([[File:Delete label.png|0.85px]]) located under the 'Action' column.
 
==...rearrange a label==
 
To rearrange the order of the labels, click the green sign ([[File:Reorder labels.png|0.85px]]) located under the column called 'Position' and re-position the label.
 
==...add a new language==
 
To add a new language: '''Create or import new label set(s)''' -> '''Languages''' -> select the languages you wish to add.  
 
To start translating the labels into another language, select the language in which you would like to translate the labels to from the upper part of the matrix.
 
 
[[File:Labels switch language.png]]
 
 
[[File:Labels 4lang ro.png]]
 
 
Every label needs a code, an assessment value, and a description (as mentioned above). While the label description can be edited for all language options, label codes and assessment values can be edited only from the first language option that is located on the languages toolbar of the matrix. The order of the languages is alphabetical and cannot be changed.
 
In our case, the language from where the label codes and assessment values can be changed is English. Only the label description can be edited when the Romanian tab is selected  - which represents the corresponding Romanian label translation of the English label.
 
Once you are done with the changes, do not forget to click on the 'Save changes' button located in the upper-right part of the screen.
 
[[File:Save_changes_close.png]]
 
=Examples=
 
{{Box|''Before reading further, take a look at our [[Surveys - introduction|wiki on how to create surveys]] since it is already assumed in the examples from below that you have already created your survey.''}}
 
For a better understanding of the label sets option, let's take a look at the following examples:
*[[Label_sets#I_want_to_use_a_label_set_as_an_answer_list_for_one_question| I want to use a label set as an answer list for one question]];
*[[Label sets#I want to use labels in another language as answers|I want to use labels in another language as answers]];
*[[Label sets#I want to use emoticons instead of label text|I want to use emoticons instead of label text]];
*[[Label sets#I want to import a label set and use it as a subquestion list|I want to import a label set and use it as a subquestion list]].
 
{{Box|The screenshots used below are from LimeSurvey 3.0, the interface being slightly different from the last LimeSurvey 2.xx release.}}
 
==I want to use a label set as an answer list for one question==
 
<div class='simplebox'>[[File:help.png]] All the label sets that are displayed under '''Configuration''' -> '''Label sets''' are called ''predefined label sets''. They can be used either as subquestions or as answers.</div>
 
'''Assuming that the [[Label sets#General|label set]] and [[Surveys - introduction|survey]] are created:'''
*Go to the structure of the survey and create a [[Creating a question group|question group]] - ''About LimeSurvey''.
 
 
<center>[[File:CreateQuestionGroup.png]]</center>
 
 
*Click the Structure tab and then on the newly created question group (''About LimeSurvey'' in our case). Look for group quick actions and choose '''Add new question to group''':
 
 
<center>[[File:AddNewQuestiontoGroup.png]]</center>
 
 
*Type in the code and text of the question.
*To use a label set as a set of answers, pick the right type of question that can make use of label sets. The ''array'' question type is selected in our example:
 
 
<center>[[File:ArrayQuestionTypeLabelSets.png]]</center>
 
 
*Save the question to add it into your question group.
*Once created, you will have to add subquestions and answers:
 
 
<center>[[File:EditSubquestionsandAnswerOptions.png]]</center>
 
 
<div class='simplebox'>[[File:help.png]] Please note that not all question types ask for subquestions and/or answers!</div>
 
*Add at least one subquestion:
 
 
<center>[[File:ArraySubquestions.png]]</center>
 
 
*Add answer options. '''Predefined label sets...''' option will be used:
 
 
<center>[[File:EditAnswerOptions.png]]</center>
 
 
*Select the label set you want to use:
 
 
<center>[[File:AvailableLabelSetsEnglish.png|0.7px]]</center>
 
 
The result should look like this:
 
 
<center>[[File:EditAnswerOptionsResults.png]]</center>
 
 
*Save & preview the question:
 
 
<center>[[File:LabelSetsFinal.png]]</center>
 
==I want to use labels in another language as answers==
 
{{Box|Before reading this example:
#Create a label set and select the other languages you would like to use in your survey. For further details, read our wiki on [[Label sets#...add a new language|how to translate a label set in other languages.]]
#Edit your survey ('''Settings''' -> '''General Settings''') by adding the additional languages you want to translate to. For more details on how to create a survey, read [[Surveys - introduction|the following wiki]].}}
'''Assuming that the [[Label sets#General|label set]] and [[Surveys - introduction|survey]] are created:'''
*Create a question that can make use of label sets (e.g. ''array'' question type):
{{Alert|title=Attention|text=Do not forget to select the language you want to translate to from the languages toolbar!}}
*Because the ''array'' question type is selected, both the subquestions and answers need to be translated.
 
 
<center>[[File:EditSubquestionsandAnswerOptions.png]]</center>
 
 
*Translate the subquestions. Do not forget to select the right language tab for translation:
 
 
<center>[[File:ExampleAddLanguageSubquestions.png]]</center>
 
 
*Translate the answers. However, because we use predefined label sets, select the right language tab to add the translated label set as answer options:
 
 
<center>[[File:AvailableLabelSetsRomanian.png]]</center>
 
 
<center>[[File:ExampleEditAnswerOptionsRomanian.png]]</center>
 
 
*Save & Preview the survey:
 
 
<center>[[File:PreviewAddRomanianLabels.png]]</center>
 
==I want to use emoticons instead of label text==
 
{{Box|To use emoticons (or any other graphics) , you have to use the embedded HTML editor when creating labels.}}
'''Assuming that the [[Surveys - introduction|survey]] is created:'''
*[[Label sets#...add a label|Create a label set and access it]]. Instead of writing in the ''Title'' column, open the HTML editor by clicking on the green pen and add graphics instead of text:
 
 
<center>[[File:GreenPenButtonHTMLLabels.png]]</center>
 
 
<center>[[File:InlineMode1.PNG]]</center>
 
 
The HTML editor offers you a more comprehensive view on how different options can be used to enhance your survey. It is not necessary to have HTML knowledge because the toolbar is self-explaining (for further details you can either hover the mouse over the options or click on that option for more details). By using such an editor, you can also add (for example) smileys, images and/or videos that are either hosted online or on your server.
In this example. three smileys have been added:
 
 
<center>[[File:SmileysLabelsExample.png]]</center>
 
 
*Create a question that can make use of label sets as predefined answers (e.g. ''array'' question type):
 
 
<center>[[File:New Question Label Sets Emoticons.png]]</center>
 
 
*Edit the subquestions and the answer options
 
 
<center>[[File:EditSubquestionsandAnswerOptions.png]]</center>
 
 
*Set predefined labels as answer options.
 
 
<center>[[File:SmileysLabelsExample.png|SmileysLabelsExample.png]]</center>
 


<div class="simplebox">(:idea:) '''Hint:''' Some useful label sets are available on the [http://www.limesurvey.org/en/add-ons/viewcategory/8-label-set-templates LimeSurvey site]</div>
*Save and preview the question:


=Uploaded resources management=


This tab lets you manage files (pictures, media files) that were uploaded in the HTML Editor.
<center>[[File:Preview Label Set Emoticons.png]]</center>


You can:
==I want to import a label set and use it as a subquestion list==
* Browse available files
* Export files as a ZIP archive
* Import a ZIP archive of files


Caution:
'''Assuming that the [[Surveys - introduction|survey]] is created:'''
* Authorized file extensions are defined in config-defaults.php by your system administrator.
{{Box|''Optional'': Access [https://www.limesurvey.org/index.php/downloads/category/19-templates '''LimeSurvey templates database'''] and download the one you wish to use - .lsl file format (''Australian states'' in our example).}}
* Files for the survey are in the upload/labels/<lid> sub directory.
*Go to '''Configuration''' and click '''Manage label sets''' button.
** Uploaded files will only be seen while browsing resources on this survey objects (labels) not in other labels or objects (groups, questions, answers).
*Click '''Create or import new label set(s)''' (in the upper-left side of the screen) -> '''Import label set(s)'''. '''Browse''' your computer and select the .lsl file (the label set format).
** However do not expect this limited visibility to ensure confidentiality of the resources as they are reachable with a simple browser to anyone who knows the URL to the file.
<center>[[File:ImportaNewLabel.png]]</center>
* Creation of sub directories of the ZIP archive won't work.
* Now that the label set was uploaded, create a question that requires the usage of subquestions (''array'' question types).
* You can't import a ZIP file containing sub directories.
* Edit subquestions.
<center>[[File:EditSubquestionsandAnswerOptions.png]]</center>
* Load the imported label set:
<center>[[File:Australia Code Label.png]]</center>
<center>[[File:Australia Label Set.png]]</center>
* Save and preview.
<center>[[File:Australia Save and Preview.png]]</center>

Revision as of 15:02, 16 February 2022

General

Label sets are list templates where each list has a set of codes with labels and can be used in most question types either as answers or as subquestions. Please bear in mind that LimeSurvey's label sets are merely copied to the particular question as subquestions or answers. Therefore, if you change a label set after you have 'used' it in a questionnaire, the changes will not propagate to the questions from the questionnaire where the respective label set is utilized.

This new usage of label sets gives much more flexibility for future development and makes the structure of a question more logical.

  Attention : A label set must contain the same base language as the survey, or you will not be able to use it for any question of your survey.


Below is a label set example to help you better grasp the concept. Click here if you want to go straight to the label set management functions of LimeSurvey.

If you want to define a custom 7-point scale, a label set provides this function. In the example below, a very simple custom label set with the code/label pairs (the label is what appears in the actual questions).

Code Label
1 Not useful at all
2 2
3 3
4 Somewhat useful
5 5
6 6
7 Very useful

Below is a graphical example where three different smileys are used instead of label text:


Label sets - how to...

Click 'Manage label sets in the Configuration menu to edit, create, delete, import, and/or export label sets.



...create or import new label set(s)

Click the Create or import new label set(s) button located in the upper-left corner of the page. You can either create a new label set or import it from another source:

  • New label set: Label sets must be manually created.
    • Set Name: Each new label set has to be given a name.
    • Languages: Every label set must be specified for the language it's used for. You can choose as many languages from the menu as you want.
  • Import label set(s): In order to import a label set, click browse and add the .lsl label set file. If you have previously created a label set, then LimeSurvey will not allow you import a similar external label set unless you turn off the Don't import if label set already exists option. Some useful label sets are available on the LimeSurvey website.

Once the label has been imported or created, click the Save button located in the right-upper part of the screen.



If you import a whole survey, the label sets are imported too (with the questions). Duplicated label sets are ignored.

...edit, delete, or export a label set

Each label set located in the Label sets list has a corresponding menu that contains the following four options:



  • View labels: Allows the user to view the existing labels located in the respective label set.
  • Edit label set: The user can rename the label set and/or add/remove languages.
  • Export label set: Export label set to a .lsl file.
  • Delete label set: A window will pop up in order to confirm whether you want to delete the respective label set or not.

Labels - how to...

...add a label

You must fill in a label code, an assessment value, and a label description.



Then, click the plus sign to add the new label. It's possible to use a graphic instead of (or in addition to) a label text. To do that, you must use HTML-code to include the graphic you want, e.g.:

<img border="0" src="http://www.yourdomain.at/pics/pic.gif">
Read also our wiki on assessments. The column is ignored if you set all the values to 0.

To help with the editing process of the HTML-code, use the embedded HTML editor of LimeSurvey, which is located at the end of the label-text box (click on the green pen button ->0.85px).



For a short introduction on the HTML editor utilized by LimeSurvey, check the following page.

Quick add

Another way to add labels is to use the Quick add... button. When you click it, a window be displayed. It works under the following form: Code ; Title.


0.8px


You can either replace or add labels. If you click Replace, all the preexisting labels will be deleted and replaced by the ones entered by you. If you click Add, the new labels will be added into the label set (the preexisting ones not being affected).


0.8px


The Code is automatically added if new entrances are created. Therefore, you can type in only the title of the labels which will automatically be assigned a code:


0.8px


0.8px


The assessment values cannot be edited/entered via this option - it has to be changed manually from the list of labels.

  Attention : If you wish to translate labels by using the Quick add... function, you need to add the translation on the same line(s) and be separated by a semicolon.


...delete a label

To delete a label, click the red trash button (0.85px) located under the 'Action' column.

...rearrange a label

To rearrange the order of the labels, click the green sign (0.85px) located under the column called 'Position' and re-position the label.

...add a new language

To add a new language: Create or import new label set(s) -> Languages -> select the languages you wish to add.

To start translating the labels into another language, select the language in which you would like to translate the labels to from the upper part of the matrix.




Every label needs a code, an assessment value, and a description (as mentioned above). While the label description can be edited for all language options, label codes and assessment values can be edited only from the first language option that is located on the languages toolbar of the matrix. The order of the languages is alphabetical and cannot be changed.

In our case, the language from where the label codes and assessment values can be changed is English. Only the label description can be edited when the Romanian tab is selected - which represents the corresponding Romanian label translation of the English label.

Once you are done with the changes, do not forget to click on the 'Save changes' button located in the upper-right part of the screen.

Examples

Before reading further, take a look at our wiki on how to create surveys since it is already assumed in the examples from below that you have already created your survey.


For a better understanding of the label sets option, let's take a look at the following examples:

The screenshots used below are from LimeSurvey 3.0, the interface being slightly different from the last LimeSurvey 2.xx release.


I want to use a label set as an answer list for one question

All the label sets that are displayed under Configuration -> Label sets are called predefined label sets. They can be used either as subquestions or as answers.

Assuming that the label set and survey are created:

  • Go to the structure of the survey and create a question group - About LimeSurvey.



  • Click the Structure tab and then on the newly created question group (About LimeSurvey in our case). Look for group quick actions and choose Add new question to group:



  • Type in the code and text of the question.
  • To use a label set as a set of answers, pick the right type of question that can make use of label sets. The array question type is selected in our example:



  • Save the question to add it into your question group.
  • Once created, you will have to add subquestions and answers:



Please note that not all question types ask for subquestions and/or answers!
  • Add at least one subquestion:



  • Add answer options. Predefined label sets... option will be used:



  • Select the label set you want to use:


0.7px


The result should look like this:



  • Save & preview the question:


I want to use labels in another language as answers

Before reading this example:
  1. Create a label set and select the other languages you would like to use in your survey. For further details, read our wiki on how to translate a label set in other languages.
  2. Edit your survey (Settings -> General Settings) by adding the additional languages you want to translate to. For more details on how to create a survey, read the following wiki.

Assuming that the label set and survey are created:

  • Create a question that can make use of label sets (e.g. array question type):
  Attention : Do not forget to select the language you want to translate to from the languages toolbar!


  • Because the array question type is selected, both the subquestions and answers need to be translated.



  • Translate the subquestions. Do not forget to select the right language tab for translation:



  • Translate the answers. However, because we use predefined label sets, select the right language tab to add the translated label set as answer options:




  • Save & Preview the survey:


I want to use emoticons instead of label text

To use emoticons (or any other graphics) , you have to use the embedded HTML editor when creating labels.

Assuming that the survey is created:




The HTML editor offers you a more comprehensive view on how different options can be used to enhance your survey. It is not necessary to have HTML knowledge because the toolbar is self-explaining (for further details you can either hover the mouse over the options or click on that option for more details). By using such an editor, you can also add (for example) smileys, images and/or videos that are either hosted online or on your server. In this example. three smileys have been added:



  • Create a question that can make use of label sets as predefined answers (e.g. array question type):



  • Edit the subquestions and the answer options



  • Set predefined labels as answer options.


SmileysLabelsExample.png


  • Save and preview the question:


I want to import a label set and use it as a subquestion list

Assuming that the survey is created:

Optional: Access LimeSurvey templates database and download the one you wish to use - .lsl file format (Australian states in our example).
  • Go to Configuration and click Manage label sets button.
  • Click Create or import new label set(s) (in the upper-left side of the screen) -> Import label set(s). Browse your computer and select the .lsl file (the label set format).
  • Now that the label set was uploaded, create a question that requires the usage of subquestions (array question types).
  • Edit subquestions.
  • Load the imported label set:
  • Save and preview.