Expression Manager to be updated - Revision history

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

2020-02-11T13:45:01Z

Text replacement - "Expression Manager" to "ExpressionScript"

Han at 18:47, 18 April 2019

2019-04-18T18:47:50Z

← Older revision		Revision as of 20:47, 18 April 2019
Line 674:		Line 674:
	\|[http://www.php.net/manual/en/function.quotemeta.php quotemeta]\|\|Quote meta characters\|\|string quotemeta(string)		\|[http://www.php.net/manual/en/function.quotemeta.php quotemeta]\|\|Quote meta characters\|\|string quotemeta(string)
	\|-		\|-
	\|[http://www.php.net/manual/en/function.rand.php rand]\|\|Generate a random integer, see [[Expression Manager ~~Sample Surveys~~#Randomly Ask One Question Per Group\|this example]]\|\|int rand() OR int rand(min, max)		\|[http://www.php.net/manual/en/function.rand.php rand]\|\|Generate a random integer, see [[Expression Manager sample surveys#Randomly Ask One Question Per Group\|this example]]\|\|int rand() OR int rand(min, max)
	\|-		\|-
	\|regexMatch\|\|compare a string to a [[Using regular expressions\|regular expression]]\|\|bool regexMatch(pattern,input)		\|regexMatch\|\|compare a string to a [[Using regular expressions\|regular expression]]\|\|bool regexMatch(pattern,input)

Han at 18:30, 18 April 2019

2019-04-18T18:30:31Z

← Older revision		Revision as of 20:30, 18 April 2019
Line 84:		Line 84:
	The best way to get started with the EM is to:		The best way to get started with the EM is to:
	*Install the latest stable version from http://www.limesurvey.org/en/download.		*Install the latest stable version from http://www.limesurvey.org/en/download.
	*Import and explore some [[Expression Manager ~~Sample Surveys~~\|sample surveys]].		*Import and explore some [[Expression Manager sample surveys\|sample surveys]].
	*Explore the [[Expression Manager ~~HowTos~~\|use cases and HowTos]], and the [[Expression Manager ~~Examples~~\|step-by-step examples]].		*Explore the [[Expression Manager how-tos\|use cases and HowTos]], and the [[Expression Manager examples\|step-by-step examples]].
	*Explore the EM documentation (this page)		*Explore the EM documentation (this page)
	**Unit Tests of Isolated Expressions (advanced)		**Unit Tests of Isolated Expressions (advanced)
	***shows examples of using all EM functions and operators, and the PHP and JavaScript results;		***shows examples of using all EM functions and operators, and the PHP and JavaScript results;
	***note there are few functions that generate different results in the PHP and JavaScript versions, so this page lets you plan your EM logic accordingly.		***note there are few functions that generate different results in the PHP and JavaScript versions, so this page lets you plan your EM logic accordingly.


	=Terminology= <!--T:90-->		=Terminology= <!--T:90-->

Han at 18:28, 18 April 2019

2019-04-18T18:28:32Z

← Older revision		Revision as of 20:28, 18 April 2019
Line 946:		Line 946:


	==[[Expression Manager ~~Roadmap~~\|RoadMap/Status/ToDo List]]== <!--T:207-->		==[[Expression Manager roadmap\|RoadMap/Status/ToDo List]]== <!--T:207-->


	</translate>		</translate>

Han at 18:27, 18 April 2019

2019-04-18T18:27:54Z

← Older revision		Revision as of 20:27, 18 April 2019
Line 941:		Line 941:
	==[[Expression Manager how-tos\|Use Cases and HowTos]]== <!--T:204-->		==[[Expression Manager how-tos\|Use Cases and HowTos]]== <!--T:204-->

	==[[Expression Manager ~~Examples~~\|Step-by-Step Examples]].== <!--T:205-->		==[[Expression Manager examples\|Step-by-Step Examples]]== <!--T:205-->


	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

Han at 18:27, 18 April 2019

2019-04-18T18:27:34Z

← Older revision		Revision as of 20:27, 18 April 2019
Line 939:		Line 939:
	==[[Expression Manager sample surveys\|Expression Manager sample surveys]]== <!--T:203-->		==[[Expression Manager sample surveys\|Expression Manager sample surveys]]== <!--T:203-->

	==[[Expression Manager ~~HowTos~~\|Use Cases and HowTos]]== <!--T:204-->		==[[Expression Manager how-tos\|Use Cases and HowTos]]== <!--T:204-->


	==[[Expression Manager Examples\|Step-by-Step Examples]].== <!--T:205-->		==[[Expression Manager Examples\|Step-by-Step Examples]].== <!--T:205-->

Han at 18:27, 18 April 2019

2019-04-18T18:27:10Z

← Older revision		Revision as of 20:27, 18 April 2019
Line 937:		Line 937:


	==[[Expression Manager ~~Sample Surveys~~\|Expression Manager ~~Sample Surveys~~]]== <!--T:203-->		==[[Expression Manager sample surveys\|Expression Manager sample surveys]]== <!--T:203-->


	==[[Expression Manager HowTos\|Use Cases and HowTos]]== <!--T:204-->		==[[Expression Manager HowTos\|Use Cases and HowTos]]== <!--T:204-->

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

2018-09-28T10:40:10Z

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

← Older revision		Revision as of 12:40, 28 September 2018
Line 559:		Line 559:
	{{Note\| You should not use these variables if		{{Note\| You should not use these variables if
	*you want to explicitly name each variable used in an equation, or		*you want to explicitly name each variable used in an equation, or
	* use variables that do not have ~~sub-questions~~ (e.g., single response questions). In those cases, prefixing a variable with "that" is overkill, and you run the risk of getting unexpected results.}}		* use variables that do not have subquestions (e.g., single response questions). In those cases, prefixing a variable with "that" is overkill, and you run the risk of getting unexpected results.}}

Cdorin at 10:12, 7 August 2018

2018-08-07T10:12:38Z

Cdorin at 16:38, 6 August 2018

2018-08-06T16:38:49Z

← Older revision		Revision as of 18:38, 6 August 2018
Line 908:		Line 908:
	!Color!!Sample!!Meaning!!Tooltip!!Comments		!Color!!Sample!!Meaning!!Tooltip!!Comments
	\|-		\|-
	\|tan background\|\|style='background-color: #eee8aa'\|Sample\|\|the whole equation\|\|none\|\|Anything within curly braces that is recognized as an equation (e.g. there is no leading or trailing whitepace) will be color-coded with a tan background to help distinguish it from surrounding text		\|tan background\|\|style='background-color: #eee8aa'\|Sample\|\|the whole equation\|\|none\|\|Anything within curly braces that is recognized as an equation (e.g., there is no leading or trailing whitepace) will be color-coded with a tan background to help distinguish it from surrounding text
	\|-		\|-
	\|bold red text\|\|style='color:#ff0000; background-color:#eee8aa'\|'''Sample'''\|\|An error\|\|Some explanation on error\|\|Can be an unknow variable or an error in function~~, ...~~. Survey ~~can be totally~~ broken, this ~~don't show~~ to public user.		\|bold red text\|\|style='color:#ff0000; background-color:#eee8aa'\|'''Sample'''\|\|An error\|\|Some explanation on error\|\|Can be an unknow variable or an error in function. Survey is broken and the questions that rely on this expression will not be shown to the public user.
	\|-		\|-
	\|blue text\|\|style='color:#0000ff; background-color:#eee8aa'\|Sample\|\|function name\|\|meaning and allowable syntax\|\|function names, or things that should be functions since they are followed by an opening parenthesis, are presented in bold blue text. Tooltips show the meaning and allowable syntax for the function.		\|blue text\|\|style='color:#0000ff; background-color:#eee8aa'\|Sample\|\|function name\|\|meaning and allowable syntax\|\|function names, or things that should be functions since they are followed by an opening parenthesis, are presented in bold blue text. Tooltips show the meaning and allowable syntax for the function.
	\|-		\|-
	\|grey text\|\|style='color:#808080; background-color:#eee8aa'\|Sample\|\|string\|\|none\|\|single and double-quoted strings are shown in grey text		\|grey text\|\|style='color:#808080; background-color:#eee8aa'\|Sample\|\|string\|\|none\|\|single and double-quoted strings are shown in grey text.
	\|-		\|-
	\|cyan text\|\|style='color:#4169e1; background-color:#eee8aa'\|Sample\|\|variable set on the same page,\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on the same page to the current question is shown in cyan text, showning it can be updated in javascript. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is show.		\|cyan text\|\|style='color:#4169e1; background-color:#eee8aa'\|Sample\|\|variable set on the same page,\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on the same page to the current question is shown in cyan text, showning it can be updated in javascript. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is show.
Line 928:		Line 928:
	\|normal black text\|\|style='color:black; background-color:#eee8aa'\|Sample\|\|punctuation\|\|none\|\|All other punctuation within the expression is shown as normal black text.		\|normal black text\|\|style='color:black; background-color:#eee8aa'\|Sample\|\|punctuation\|\|none\|\|All other punctuation within the expression is shown as normal black text.
	\|-		\|-
	\|red-boxed text\|\|a bold red line surrounds the error\|\|syntax error\|\|description of the error\|\|Any detected syntax errors are shown ~~by surrounding the error with a~~ red ~~box~~. The tooltip shows the error. Examples include unmatched parentheses, use of undefined functions, passing the wrong number of arguments to functions, poorly structured expressions (e.g. missing operators between variables), trying to assign a new value to a read-only variable, trying to assign values to non-variables, or using unsupported syntax. Note that the syntax error dectection system may only report one error in an expression even if there are multiple errors; however, if any errors are detected, at least one error will be shown.		\|red-boxed text\|\|a bold red line surrounds the error\|\|syntax error\|\|description of the error\|\|Any detected syntax errors are shown within red boxes. The tooltip shows the error. Examples include unmatched parentheses, use of undefined functions, passing the wrong number of arguments to functions, poorly structured expressions (e.g., missing operators between variables), trying to assign a new value to a read-only variable, trying to assign values to non-variables, or using unsupported syntax. Note that the syntax error dectection system may only report one error in an expression even if there are multiple errors; however, if any errors are detected, at least one error will be shown.
	\|}		\|}


	=Additional Reading= <!--T:202-->		=Additional Reading= <!--T:202-->

← Older revision		Revision as of 20:27, 18 April 2019
Line 941:		Line 941:
	==[[Expression Manager how-tos\|Use Cases and HowTos]]== <!--T:204-->		==[[Expression Manager how-tos\|Use Cases and HowTos]]== <!--T:204-->

	==[[Expression Manager ~~Examples~~\|Step-by-Step Examples]].== <!--T:205-->		==[[Expression Manager examples\|Step-by-Step Examples]]== <!--T:205-->


	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

← Older revision		Revision as of 20:27, 18 April 2019
Line 939:		Line 939:
	==[[Expression Manager sample surveys\|Expression Manager sample surveys]]== <!--T:203-->		==[[Expression Manager sample surveys\|Expression Manager sample surveys]]== <!--T:203-->

	==[[Expression Manager ~~HowTos~~\|Use Cases and HowTos]]== <!--T:204-->		==[[Expression Manager how-tos\|Use Cases and HowTos]]== <!--T:204-->


	==[[Expression Manager Examples\|Step-by-Step Examples]].== <!--T:205-->		==[[Expression Manager Examples\|Step-by-Step Examples]].== <!--T:205-->

← Older revision		Revision as of 12:12, 7 August 2018
Line 899:		Line 899:

	<!--T:197-->		<!--T:197-->
	To help with entering and validating expressions, EM provides syntax highlighting with the following features:		To help with entering and validating expressions, the EM provides syntax highlighting with the following features:

	==Types and Meanings of Syntax Highlighting== <!--T:198-->		==Types and Meanings of Syntax Highlighting== <!--T:198-->
Line 910:		Line 910:
	\|tan background\|\|style='background-color: #eee8aa'\|Sample\|\|the whole equation\|\|none\|\|Anything within curly braces that is recognized as an equation (e.g., there is no leading or trailing whitepace) will be color-coded with a tan background to help distinguish it from surrounding text		\|tan background\|\|style='background-color: #eee8aa'\|Sample\|\|the whole equation\|\|none\|\|Anything within curly braces that is recognized as an equation (e.g., there is no leading or trailing whitepace) will be color-coded with a tan background to help distinguish it from surrounding text
	\|-		\|-
	\|bold red text\|\|style='color:#ff0000; background-color:#eee8aa'\|'''Sample'''\|\|An error\|\|Some explanation on error\|\|Can be an unknow variable or an error in function. Survey is broken and the questions that rely on ~~this~~ expression will not be shown to the ~~public user~~.		\|bold red text\|\|style='color:#ff0000; background-color:#eee8aa'\|'''Sample'''\|\|An error\|\|Some explanation on error\|\|Can be an unknow variable or an error in function. Survey is broken and the questions that rely on the respective expression will not be shown to the respondents.
	\|-		\|-
	\|blue text\|\|style='color:#0000ff; background-color:#eee8aa'\|Sample\|\|function name\|\|meaning and allowable syntax\|\|function names, or things that should be functions since they are followed by an ~~opening~~ parenthesis, are ~~presented~~ in bold blue text. Tooltips show the meaning and allowable syntax for the function.		\|blue text\|\|style='color:#0000ff; background-color:#eee8aa'\|Sample\|\|function name\|\|meaning and allowable syntax\|\|It refers to function names or things that should be functions since they are followed by an open parenthesis. They are displayed in bold blue text. Tooltips show the meaning and allowable syntax for the function.
	\|-		\|-
	\|grey text\|\|style='color:#808080; background-color:#eee8aa'\|Sample\|\|string\|\|none\|\|~~single~~ and double-quoted strings are shown in grey text.		\|grey text\|\|style='color:#808080; background-color:#eee8aa'\|Sample\|\|string\|\|none\|\|Single and double-quoted strings are shown in grey text.
	\|-		\|-
	\|cyan text\|\|style='color:#4169e1; background-color:#eee8aa'\|Sample\|\|variable set on the same page,\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on the same page to the ~~current~~ question is shown in cyan text~~, showning~~ it can be updated in javascript. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is ~~show~~.		\|cyan text\|\|style='color:#4169e1; background-color:#eee8aa'\|Sample\|\|variable set on the same page,\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on the same page as the question you are currently editing is shown in cyan text (it can be updated in javascript). The tooltip shows its name (if you used INSERTANS:xxx) or its SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is shown.
	\|-		\|-
	\|green text\|\|style='color:#008000; background-color:#eee8aa'\|Sample\|\|variable set on a prior page\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on a prior page is shown in bold green text. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is ~~show~~.		\|green text\|\|style='color:#008000; background-color:#eee8aa'\|Sample\|\|variable set on a prior page\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on a prior page is shown in bold green text. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is shown.
	\|-		\|-
	\|bold pink text\|\|style='color:#9370db; background-color:#eee8aa'\|Sample\|\|variable set on a later page <sup>in general : empty at survey start, but can be filled with index or move previous</sup>\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on a prior page is shown in bold pink text. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is show.		\|bold pink text\|\|style='color:#9370db; background-color:#eee8aa'\|Sample\|\|variable set on a later page <sup>in general : empty at survey start, but can be filled with index or move previous</sup>\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on a prior page is shown in bold pink text. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is show.
	\|-		\|-
	\|bold tan text\|\|style='color:#a0522d; background-color:#eee8aa'\|Sample\|\|a lime replacement value\|\|the value\|\|Lime Replacement Strings (like {TOKEN:xxx}, {PRIVACY_MESSAGE}) are shown in bold tan text.		\|bold tan text\|\|style='color:#a0522d; background-color:#eee8aa'\|Sample\|\|a lime replacement value\|\|the value\|\|Lime Replacement Strings (like {TOKEN:xxx}, {PRIVACY_MESSAGE}) are shown in bold tan text.
	\|-		\|-
	\|red text\|\|style='color:#ff4500; background-color:#eee8aa'\|Sample\|\|assignment operator (=) \|\|warning message\|\|If you use one of the assignment operator (=) that operator will be displayed in red text. This is meant to help prevent accidental re-assignment of values when you really meant to check whether a == b instead of setting the value of a = b.		\|red text\|\|style='color:#ff4500; background-color:#eee8aa'\|Sample\|\|assignment operator (=) \|\|warning message\|\|If you use one of the assignment operator (=), that operator will be displayed in red text. This is meant to help prevent accidental re-assignment of values when you really meant to check whether a == b instead of setting the value of a = b.
	\|-		\|-
	\|normal black text\|\|style='color:black; background-color:#eee8aa'\|Sample\|\|punctuation\|\|none\|\|All other punctuation within the expression is shown as normal black text.		\|normal black text\|\|style='color:black; background-color:#eee8aa'\|Sample\|\|punctuation\|\|none\|\|All other punctuation signs within the expression are shown as normal black text.
	\|-		\|-
	\|red-boxed text\|\|a bold red line surrounds the error\|\|syntax error\|\|description of the error\|\|Any detected syntax errors are shown within red boxes. The tooltip shows the error. Examples include unmatched parentheses, use of undefined functions, passing the wrong number of arguments to functions, poorly structured expressions (e.g., missing operators between variables), trying to assign a new value to a read-only variable, trying to assign values to non-variables, or using unsupported syntax. Note that the syntax error dectection system may only report one error in an expression even if there are multiple errors; however, if any errors are detected, at least one error will be shown.		\|red-boxed text\|\|a bold red line surrounds the error\|\|syntax error\|\|description of the error\|\|Any detected syntax errors are shown within red boxes. The tooltip shows the error. Examples include unmatched parentheses, use of undefined functions, passing the wrong number of arguments to functions, poorly structured expressions (e.g., missing operators between variables), trying to assign a new value to a read-only variable, trying to assign values to non-variables, or using unsupported syntax. Note that the syntax error dectection system may only report one error in an expression even if there are multiple errors; however, if any errors are detected, at least one error will be shown.
	\|}		\|}


			{{Note\| By tooltips, we refer to the popup message that is displayed when you hover over certain functions and variables.}}

	=Additional Reading= <!--T:202-->		=Additional Reading= <!--T:202-->