Tab Separated Value survey structure/en - Revision history

FuzzyBot: Updating to match new version of source page

2021-03-09T10:25:39Z

Updating to match new version of source page

← Older revision		Revision as of 12:25, 9 March 2021
Line 11:		Line 11:


	{{Note\|Check out the following [https://~~www~~.limesurvey.org/about-limesurvey/surveyhelp/2125-creating-limesurvey-questionnaires-in-excel example] to get a better understanding of this functionality.}}		{{Note\|Check out the following [https://account.limesurvey.org/about-limesurvey/surveyhelp/2125-creating-limesurvey-questionnaires-in-excel example] to get a better understanding of this functionality.}}

C schmitz: Text replacement - "Check the following" to "Check out the following"

2020-10-18T17:12:10Z

Text replacement - "Check the following" to "Check out the following"

← Older revision		Revision as of 19:12, 18 October 2020
Line 11:		Line 11:


	{{Note\|Check the following [https://www.limesurvey.org/about-limesurvey/surveyhelp/2125-creating-limesurvey-questionnaires-in-excel example] to get a better understanding of this functionality.}}		{{Note\|Check out the following [https://www.limesurvey.org/about-limesurvey/surveyhelp/2125-creating-limesurvey-questionnaires-in-excel example] to get a better understanding of this functionality.}}

FuzzyBot: Updating to match new version of source page

2020-05-19T14:30:17Z

Updating to match new version of source page

← Older revision		Revision as of 16:30, 19 May 2020
Line 40:		Line 40:
	#'''Testing survey modules'''. For long surveys, you may want to break up the testing into modules. Simply create new spreadsheet files for each module, deleting any rows that you don't need. This avoids the need to enter lots of data to test later sections of the survey.		#'''Testing survey modules'''. For long surveys, you may want to break up the testing into modules. Simply create new spreadsheet files for each module, deleting any rows that you don't need. This avoids the need to enter lots of data to test later sections of the survey.
	#'''Testing mandatory questions'''. A common complaint is not the need to make many questions mandatory, but the need to turn off the mandatory feature for testing. Simply create the master spreadsheet with mandatory set to the final desired values. Then, to test it, just delete the "mandatory" column and save the test version of the spreadsheet. When you import that version, none of the questions will be mandatory. After you have finished your testing, import the master copy.		#'''Testing mandatory questions'''. A common complaint is not the need to make many questions mandatory, but the need to turn off the mandatory feature for testing. Simply create the master spreadsheet with mandatory set to the final desired values. Then, to test it, just delete the "mandatory" column and save the test version of the spreadsheet. When you import that version, none of the questions will be mandatory. After you have finished your testing, import the master copy.
	#'''Setting defaults'''. Rather than using the GUI, you can enter any desired defaults in the default column. This is especially helpful for cases where the GUI does not let you enter the desired value, like [[expressions]] to set the default for list items (like populating a list from a [[Survey participants\|survey participant]] attribute).		#'''Setting defaults'''. Rather than using the GUI, you can enter any desired defaults in the default column. This is especially helpful for cases where the GUI does not let you enter the desired value, like [[ExpressionScript - Presentation\|expressions]] to set the default for list items (like populating a list from a [[Survey participants\|survey participant]] attribute).
	#'''Translation'''. You can create copies of your spreadsheet - one per language. Include all the rows for the primary language, then copy and paste them below, and use drag to change the language field to the target language. These can be distributed to your translators, and re-integrated into a single spreadsheet file when they are done.		#'''Translation'''. You can create copies of your spreadsheet - one per language. Include all the rows for the primary language, then copy and paste them below, and use drag to change the language field to the target language. These can be distributed to your translators, and re-integrated into a single spreadsheet file when they are done.
	#'''Bulk setting of advanced question attributes'''. You may want all of your equations to start visible (so you can see their values as you collect data), but then hide them all before going to production. Simply filter the spreadsheet on class = 'Q' and question type = '*' (equation), and set always_hide to 1 for each of those questions. Similarly, say after you create the survey, you decide which questions should appear in public statistics. Rather than edit each question through the GUI, filter on class = 'Q', and set public_statistics = 1 for all of the questions that should be visible in statistics.		#'''Bulk setting of advanced question attributes'''. You may want all of your equations to start visible (so you can see their values as you collect data), but then hide them all before going to production. Simply filter the spreadsheet on class = 'Q' and question type = '*' (equation), and set always_hide to 1 for each of those questions. Similarly, say after you create the survey, you decide which questions should appear in public statistics. Rather than edit each question through the GUI, filter on class = 'Q', and set public_statistics = 1 for all of the questions that should be visible in statistics.
Line 118:		Line 118:
	#type/scale => type -- the (usually one letter) [[Question types\|question type]] (e.g., 'M' is Multiple Choice)		#type/scale => type -- the (usually one letter) [[Question types\|question type]] (e.g., 'M' is Multiple Choice)
	#name => title -- the unique question name (the root of the qcode naming system)		#name => title -- the unique question name (the root of the qcode naming system)
	#relevance => relevance -- the [[ExpressionScript#Access_to_Variables\|relevance equation]] for the question		#relevance => relevance -- the [[ExpressionScript - Presentation#Access_to_Variables\|relevance equation]] for the question
	#text => question -- the language-specific text of the question		#text => question -- the language-specific text of the question
	#help => help -- the language-specific help text		#help => help -- the language-specific help text

C schmitz: Text replacement - "Expression Manager" to "ExpressionScript"

2020-02-11T13:50:10Z

Text replacement - "Expression Manager" to "ExpressionScript"

← Older revision		Revision as of 15:50, 11 February 2020
Line 118:		Line 118:
	#type/scale => type -- the (usually one letter) [[Question types\|question type]] (e.g., 'M' is Multiple Choice)		#type/scale => type -- the (usually one letter) [[Question types\|question type]] (e.g., 'M' is Multiple Choice)
	#name => title -- the unique question name (the root of the qcode naming system)		#name => title -- the unique question name (the root of the qcode naming system)
	#relevance => relevance -- the [[~~Expression Manager~~#Access_to_Variables\|relevance equation]] for the question		#relevance => relevance -- the [[ExpressionScript#Access_to_Variables\|relevance equation]] for the question
	#text => question -- the language-specific text of the question		#text => question -- the language-specific text of the question
	#help => help -- the language-specific help text		#help => help -- the language-specific help text

FuzzyBot: Updating to match new version of source page

2019-08-07T19:25:02Z

Updating to match new version of source page

← Older revision		Revision as of 21:25, 7 August 2019
Line 62:		Line 62:

	The first 14 columns are:		The first 14 columns are:
	#id		#id {{NewIn\|3.14.0}}
	#related_id		#related_id {{NewIn\|3.14.0}}
	#class		#class
	#type/scale		#type/scale
Line 77:		Line 77:
	#same_default		#same_default

			{{Hint\|Text=Columns id and related_id are used only for quota and are optional. If you don't have quota, you can directly remove this 2 columns.}}

	==Survey Global Parameters==		==Survey Global Parameters==

FuzzyBot: Updating to match new version of source page

2018-12-21T13:40:03Z

Updating to match new version of source page

Show changes

C schmitz: Text replacement - "sub-question" to "subquestion"

2018-09-28T10:40:02Z

Text replacement - "sub-question" to "subquestion"

FuzzyBot: Updating to match new version of source page

2018-08-03T15:55:04Z

Updating to match new version of source page

Show changes

FuzzyBot: FuzzyBot moved page Tab Separated Value Survey Structure/en to Tab Separated Value survey structure/en without leaving a redirect: Part of translatable page "Tab Separated Value Survey Structure".

2017-08-02T13:00:01Z

FuzzyBot moved page Tab Separated Value Survey Structure/en to Tab Separated Value survey structure/en without leaving a redirect: Part of translatable page "Tab Separated Value Survey Structure".

← Older revision		Revision as of 15:00, 2 August 2017
(No difference)

FuzzyBot: Updating to match new version of source page

2017-02-28T15:00:03Z

Updating to match new version of source page

← Older revision		Revision as of 17:00, 28 February 2017
Line 4:		Line 4:
	<div class="simplebox">This feature is available starting in version 2.0</div>		<div class="simplebox">This feature is available starting in version 2.0</div>

	=~~Excel (~~Tab Separated Value) Import and Export of Survey Structure=		=Tab Separated Value Import and Export of Survey Structure=

	This feature is designed to make it easy to use a spreadsheet software like Excel, LibreOffice or Google Docs to author and edit surveys. It completely eliminates the dependence upon SGQA codes.		This feature is designed to make it easy to use a spreadsheet software like Excel, LibreOffice or Google Docs to author and edit surveys. It completely eliminates the dependence upon SGQA codes.

← Older revision		Revision as of 12:40, 28 September 2018
Line 22:		Line 22:
	<div class="simplebox">Note that the exported file is in UTF-8 format with the Byte Order Mark (BOM) as the first three (hidden) characters. If you double click on the .txt and try to open it directly with Excel, it will not open properly because Excel does not realize that it is UTF-8 formatted. To open these files with Excel, first open Excel, then select File::Open, select the .txt file, and tell Excel that it is using UTF-8 encoding.</div>		<div class="simplebox">Note that the exported file is in UTF-8 format with the Byte Order Mark (BOM) as the first three (hidden) characters. If you double click on the .txt and try to open it directly with Excel, it will not open properly because Excel does not realize that it is UTF-8 formatted. To open these files with Excel, first open Excel, then select File::Open, select the .txt file, and tell Excel that it is using UTF-8 encoding.</div>

	There will be one row for each group, question, ~~sub-question~~, and answer. There are also rows for global survey variables, and for language-specific survey variables. The primary language will be listed first, followed by any secondary languages. So, if there are multiple languages, the entire contents of the base language will appear first (e.g. all groups, questions, ~~sub-questions~~, and answers). This will be followed by a translated copy for each secondary language (with exactly the same number and order or rows for the translated set).		There will be one row for each group, question, subquestion, and answer. There are also rows for global survey variables, and for language-specific survey variables. The primary language will be listed first, followed by any secondary languages. So, if there are multiple languages, the entire contents of the base language will appear first (e.g. all groups, questions, subquestions, and answers). This will be followed by a translated copy for each secondary language (with exactly the same number and order or rows for the translated set).

	Relationships are inferred by proximity. So, questions following a group are part of that group; ~~sub-questions~~ following a question are part of that question, and answers following a question are part of that question. Thus, you don't need to know the IDs (gid, qid, sqid) for any questions. Those will be computed automatically upon import. In fact, this format does not use gid, qid, or sqid (or SGQA codes) at all.		Relationships are inferred by proximity. So, questions following a group are part of that group; subquestions following a question are part of that question, and answers following a question are part of that question. Thus, you don't need to know the IDs (gid, qid, sqid) for any questions. Those will be computed automatically upon import. In fact, this format does not use gid, qid, or sqid (or SGQA codes) at all.

	=Tips=		=Tips=
Line 32:		Line 32:
	Here are some convenient things you can do with this approach to authoring instruments:		Here are some convenient things you can do with this approach to authoring instruments:
	#'''Use same Answers for many questions'''. Just copy the 'A' rows and paste after each question that should have the same set.		#'''Use same Answers for many questions'''. Just copy the 'A' rows and paste after each question that should have the same set.
	#'''Use same ~~sub-questions~~ for many questions'''. Just copy the 'SQ' rows and paste them after each question that needs it.		#'''Use same subquestions for many questions'''. Just copy the 'SQ' rows and paste them after each question that needs it.
	#'''"Looping" - use same group many times'''. After the group is the way you want it, copy it as many times as needed. Use Excel filtering to view just the 'G' rows (for groups), and use the Excel column drag feature to update the relevance equations for each group (e.g. for a census, the first relevance might be "numPeople > 1", the next should be "numPeople > 2". The drag feature will auto-update the number). Filter by 'Q' rows and ensure that each question has a unique value (e.g. say you name your variables g1_q1, g1_q2, g1_qN, use find/replace to convert g1 to g2 the second group; g3 for the third, etc.).		#'''"Looping" - use same group many times'''. After the group is the way you want it, copy it as many times as needed. Use Excel filtering to view just the 'G' rows (for groups), and use the Excel column drag feature to update the relevance equations for each group (e.g. for a census, the first relevance might be "numPeople > 1", the next should be "numPeople > 2". The drag feature will auto-update the number). Filter by 'Q' rows and ensure that each question has a unique value (e.g. say you name your variables g1_q1, g1_q2, g1_qN, use find/replace to convert g1 to g2 the second group; g3 for the third, etc.).
	#'''Re-ordering questions/groups'''. Simply re-order the rows of the spreadsheet file.		#'''Re-ordering questions/groups'''. Simply re-order the rows of the spreadsheet file.
Line 43:		Line 43:
	#'''Gaining approvals'''. If you are doing research, you may have an Institutional Review board who insists upon seeing the text of the questions. This may be a convenient way to share it. Similarly for discussions with a client.		#'''Gaining approvals'''. If you are doing research, you may have an Institutional Review board who insists upon seeing the text of the questions. This may be a convenient way to share it. Similarly for discussions with a client.
	#'''Team consensus'''. If you are trying to get a group to agree upon the wording or appearance of a question or group, you can rapidly prototype / edit the spreadsheet, import it, and show the team (via question or group preview) exactly what the users will see. That way you can get approval from the team before they leave the room rather than having to document requirements, build them, and get approval at future meetings.		#'''Team consensus'''. If you are trying to get a group to agree upon the wording or appearance of a question or group, you can rapidly prototype / edit the spreadsheet, import it, and show the team (via question or group preview) exactly what the users will see. That way you can get approval from the team before they leave the room rather than having to document requirements, build them, and get approval at future meetings.
	#'''Upgrading from other survey formats'''. If you have existing survey in XML, Word, or other format, you can create a translation process to map them to this format. Although you could also try mapping to the .lss format, the advantage of this format is that it doesn't require you to keep track of foreign key relationships between groups, questions, ~~sub-questions~~, answers, and defaults.		#'''Upgrading from other survey formats'''. If you have existing survey in XML, Word, or other format, you can create a translation process to map them to this format. Although you could also try mapping to the .lss format, the advantage of this format is that it doesn't require you to keep track of foreign key relationships between groups, questions, subquestions, answers, and defaults.

	=Limitations=		=Limitations=
Line 114:		Line 114:
	==Sub-Questions==		==Sub-Questions==

	One ~~sub-question~~ row per survey language. Sub-questions are assumed to belong to the question that precedes them.		One subquestion row per survey language. Sub-questions are assumed to belong to the question that precedes them.
	#id => same unique numeric identifier which is used for the questions. Sub-questions should use next available value, question and ~~sub-question~~ IDs should be different (e.g. use ID 1 for question and IDs 2, 3 and 4 for ~~sub-questions~~ belonging to question 1, next question ID should be 5 and so on). Use the same ~~sub-question~~ ID for additional languages belonging to current ~~sub-questions~~.		#id => same unique numeric identifier which is used for the questions. Sub-questions should use next available value, question and subquestion IDs should be different (e.g. use ID 1 for question and IDs 2, 3 and 4 for subquestions belonging to question 1, next question ID should be 5 and so on). Use the same subquestion ID for additional languages belonging to current subquestions.
	#class => 'SQ'		#class => 'SQ'
	#type/scale => scale_id -- 0 or 1, depending upon question type (e.g. array text will have two scales)		#type/scale => scale_id -- 0 or 1, depending upon question type (e.g. array text will have two scales)
	#name => title -- the "name" of the ~~sub-question~~, e.g. the one used for exclude_all_others		#name => title -- the "name" of the subquestion, e.g. the one used for exclude_all_others
	#relevance => relevance -- (Future) to support ~~sub-question~~-level relevance		#relevance => relevance -- (Future) to support subquestion-level relevance
	#text => question -- the language-specific text of the ~~sub-question~~		#text => question -- the language-specific text of the subquestion
	#help => help -- (Future) to support ~~sub-question~~-level help		#help => help -- (Future) to support subquestion-level help
	#language => language -- the language for the ~~sub-question~~		#language => language -- the language for the subquestion
	#validation => preg -- (Future) to support ~~sub-question~~-level regular expression validation (e.g. for address parts)		#validation => preg -- (Future) to support subquestion-level regular expression validation (e.g. for address parts)
	#mandatory => mandatory -- (Future) to support ~~sub-question~~-level mandatory (e.g. make only a few ~~sub-questions~~ mandatory)		#mandatory => mandatory -- (Future) to support subquestion-level mandatory (e.g. make only a few subquestions mandatory)
	#default => default -- if set, then this is the default value for the ~~sub-question~~ (inserted into defaultvalues table)		#default => default -- if set, then this is the default value for the subquestion (inserted into defaultvalues table)
	#same_default => same_default -- if set, then the default for the primary language is used for all other languages		#same_default => same_default -- if set, then the default for the primary language is used for all other languages