Targeted Text statements - Revision history

Dme: /* SetText statement */

2015-11-07T15:27:44Z

SetText statement

← Older revision		Revision as of 15:27, 7 November 2015
Line 126:		Line 126:

	The syntax of the <var>SetText</var> statement is:		The syntax of the <var>SetText</var> statement is:
	~~<p class="~~syntax~~"><span class="literal">SetText</span><span class="term"> %variable</span> <span class="literal"></span><span class="term">string</span> </p>~~		{{Template:SetText statement syntax}}
	Where:		Where:
	<table class="syntaxTable">		<table class="syntaxTable">
Line 162:		Line 162:
	You can also use the <var>~noCont</var> directive to indicate that a trailing hyphen is not to be treated as a continuation character:		You can also use the <var>~noCont</var> directive to indicate that a trailing hyphen is not to be treated as a continuation character:
	<p class="code">setText %str = {~nocont}------------ </p>		<p class="code">setText %str = {~nocont}------------ </p>

	==ReturnText statement==		==ReturnText statement==
	The <var>ReturnText</var> statement works much the same as <var>AuditText</var>, <var>PrintText</var>, and <var>TraceText</var>, but instead of outputting a string it is used to return a string value in a <var class="product">User Language</var> function or property <var>Get</var> method. The syntax of the <var>ReturnText</var> statement is:		The <var>ReturnText</var> statement works much the same as <var>AuditText</var>, <var>PrintText</var>, and <var>TraceText</var>, but instead of outputting a string it is used to return a string value in a <var class="product">User Language</var> function or property <var>Get</var> method. The syntax of the <var>ReturnText</var> statement is:

Dme: /* ~ and ~= directives */

2012-10-16T20:50:14Z

~ and ~= directives

← Older revision		Revision as of 20:50, 16 October 2012
Line 38:		Line 38:

	For example, the following sequence:		For example, the following sequence:
	~~<p class="code">%i = 22, %j = 33, (%i + %j):toPower(3) = 166375</p>~~
	~~Displays:~~
	<p class="code">%i = 22		<p class="code">%i = 22
	%j = 33		%j = 33
	printText {~} = {%i}, {~} = {%j}, {~} = {(%i + %j):toPower(3)} </p>		printText {~} = {%i}, {~} = {%j}, {~} = {(%i + %j):toPower(3)} </p>

			Displays:
			<p class="code">%i = 22, %j = 33, (%i + %j):toPower(3) = 166375</p>

	<div id="tildeEqual"></div>		<div id="tildeEqual"></div>

JAL2: /* ~ and ~= directives */

2012-06-26T19:37:48Z

~ and ~= directives

← Older revision		Revision as of 19:37, 26 June 2012
Line 44:		Line 44:
	printText {~} = {%i}, {~} = {%j}, {~} = {(%i + %j):toPower(3)} </p>		printText {~} = {%i}, {~} = {%j}, {~} = {(%i + %j):toPower(3)} </p>

			<div id="tildeEqual"></div>
	As of <var class="product">Sirius Mods</var> version 7.8, you can also use '''a ~= directive''' as a shorthand for <code>{~}={<i>expression</i>}</code>.		As of <var class="product">Sirius Mods</var> version 7.8, you can also use '''a ~= directive''' as a shorthand for <code>{~}={<i>expression</i>}</code>.
	For example, <br><code>printtext {~=%i}, {~=%j}, {~=(%i+%j):toPower(3)}</code> would display <code>%i=22, %j=33, (%i + %j):toPower(3)=166375</code>.		For example, <br><code>printtext {~=%i}, {~=%j}, {~=(%i+%j):toPower(3)}</code> would display <code>%i=22, %j=33, (%i + %j):toPower(3)=166375</code>.
Line 89:		Line 90:
	%i = 2, %al(%i) = 17		%i = 2, %al(%i) = 17
	%i = 3, %al(%i) = 30 </p>		%i = 3, %al(%i) = 30 </p>

	===Tilde statement directives===		===Tilde statement directives===
	As of <var class="product">Sirius Mods</var> 7.8, certain <var>Text</var> statement directives can be placed after a tilde character (<b>~</b>) inside curly braces (<b>{ }</b>) in any of the targeted text statements. For example, this statement sets <code>%ls</code> to the current time, embedded in hyphens:		As of <var class="product">Sirius Mods</var> 7.8, certain <var>Text</var> statement directives can be placed after a tilde character (<b>~</b>) inside curly braces (<b>{ }</b>) in any of the targeted text statements. For example, this statement sets <code>%ls</code> to the current time, embedded in hyphens:

JAL2 at 19:28, 26 June 2012

2012-06-26T19:28:07Z

Show changes

JAL2 at 23:01, 2 May 2012

2012-05-02T23:01:35Z

Show changes

Dme at 18:59, 17 February 2011

2011-02-17T18:59:18Z

← Older revision		Revision as of 18:59, 17 February 2011
Line 169:		Line 169:
	You can also use the ~noCont directive to indicate that a trailing hyphen is not to be treated as a continuation character:		You can also use the ~noCont directive to indicate that a trailing hyphen is not to be treated as a continuation character:
	returnText {~nocont}------------		returnText {~nocont}------------
			[[Category:User Language statements]]

JAL at 21:48, 20 December 2010

2010-12-20T21:48:00Z

← Older revision		Revision as of 21:48, 20 December 2010
Line 47:		Line 47:
	%j = 33		%j = 33
	printText %i = {%i}, %j = {%j}, (%i + %j):toPower(3) = {(%i + %j):toPower(3)}		printText %i = {%i}, %j = {%j}, (%i + %j):toPower(3) = {(%i + %j):toPower(3)}
	A single tilde character inside curly braces {~} must be followed (possibly with some intervening text) by an expression inside curly braces. The {~} would then be replaced with the literal contents of the following curly braces.		'''A single tilde character inside curly braces {~}''' must be followed (possibly with some intervening text) by an expression inside curly braces. The {~} would then be replaced with the literal contents of the following curly braces.
	For example, the following sequence would display <tt>%i = 22, %j = 33, (%i + %j):toPower(3) = 166375</tt>:		For example, the following sequence would display <tt>%i = 22, %j = 33, (%i + %j):toPower(3) = 166375</tt>:
	%i = 22		%i = 22
	%j = 33		%j = 33
	printText {~} = {%i}, {~} = {%j}, {~} = {(%i + %j):toPower(3)}		printText {~} = {%i}, {~} = {%j}, {~} = {(%i + %j):toPower(3)}
	As of ''Sirius Mods'' version 7.8, you can also use a <tt>~=</tt> directive as a shorthand for <tt>{~}={''expression''}</tt>. For example, <br><tt>printtext {~=%i}, {~=%j}, {~=(%i+%j):toPower(3)}</tt> would display <tt>%i=22, %j=33, (%i + %j):toPower(3)=166375</tt>. <br>Note that in the directive, spaces are optional after the equal sign, and the output produces no spaces before or after the equal sign. If more control of spacing is required, use the {~} directive.		As of ''Sirius Mods'' version 7.8, you can also use '''a <tt>~=</tt> directive''' as a shorthand for <tt>{~}={''expression''}</tt>. For example, <br><tt>printtext {~=%i}, {~=%j}, {~=(%i+%j):toPower(3)}</tt> would display <tt>%i=22, %j=33, (%i + %j):toPower(3)=166375</tt>. <br>Note that in the directive, spaces are optional after the equal sign, and the output produces no spaces before or after the equal sign. If more control of spacing is required, use the {~} directive.

	One common issue with the {~} syntax is that it does not replace with its value a variable used as a subscript (perhaps for an ArrayList). For example, if you have:		One common issue with the {~} syntax is that it does not replace with its value a variable used as a subscript (perhaps for an ArrayList). For example, if you have:

JAL at 17:52, 20 December 2010

2010-12-20T17:52:10Z

← Older revision		Revision as of 17:52, 20 December 2010
Line 14:		Line 14:
	<dl>		<dl>
	<dt>~exprE		<dt>~exprE
	<dd>Sets the expression end characters. This directive must be followed by a space and then the expression start characters. For example, <tt>{~expre >}</tt> sets the expression end characters to a single greater-than sign (>). ~exprE can also be written as <tt>~exprEnd</tt>. Note ~~that the~~ ~exprE directive must be ended by the expression end characters ~~in effect before~~ the ~expre directive is ~~processed~~.		<dd>Sets the expression end characters. This directive must be followed by a space and then the expression start characters. For example, <tt>{~expre >}</tt> sets the expression end characters to a single greater-than sign (>). ~exprE can also be written as <tt>~exprEnd</tt>.

			'''Note:''' The ~exprE directive must be ended by the current expression end characters, that is, by the end characters that the ~expre directive is replacing.
	<dt>~exprS		<dt>~exprS
	<dd>Sets the expression start characters. This directive must be followed by a space and then the expression start characters. For example, <tt>{~exprs <}</tt> sets the expression start characters to a single less-than sign (<). ~exprS can also be written as <tt>~exprStart</tt>.		<dd>Sets the expression start characters. This directive must be followed by a space and then the expression start characters. For example, <tt>{~exprs <}</tt> sets the expression start characters to a single less-than sign (<). ~exprS can also be written as <tt>~exprStart</tt>.
Line 24:		Line 26:
	<dd>Indicates that no expressions are to be processed after the directive, and that everything after the ~noExpr directive is treated as literal text. No further tilde directives will be processed after a ~noExpr. ~noExpr can also be written as <tt>~noExpressions</tt>.		<dd>Indicates that no expressions are to be processed after the directive, and that everything after the ~noExpr directive is treated as literal text. No further tilde directives will be processed after a ~noExpr. ~noExpr can also be written as <tt>~noExpressions</tt>.
	<dt>~raw		<dt>~raw
	<dd>Acts as if ~noCont, ~noEll, and ~noExpr are specified simultaneously. Note ~~that this~~ is slightly different from the <tt>Raw</tt> directive on the Text/Html statement, which also implies NoDum/NoDummy. Because dummy string substitution applies to lines before they are parsed, dummy string substitution would already have happened in any single-line Text statement before the ~raw directive was processed.		<dd>Acts as if ~noCont, ~noEll, and ~noExpr are specified simultaneously.

			'''Note:''' This is slightly different from the <tt>Raw</tt> directive on the Text/Html statement, which also implies NoDum/NoDummy. Because dummy string substitution applies to lines before they are parsed, dummy string substitution would already have happened in any single-line Text statement before the ~raw directive was processed.
	</dl>		</dl>

JAL at 23:53, 17 December 2010

2010-12-17T23:53:53Z

← Older revision		Revision as of 23:53, 17 December 2010
Line 1:		Line 1:
	The AuditText, PrintText, and TraceText statements are abbreviated forms of the [[Text and Html statements]].		The AuditText, PrintText, and TraceText statements are abbreviated forms of the [[Text and Html statements]].
	They have the same effect as the Text Audit, Text Print, Text Trace~~, Text Return, and Text Set~~ statements respectively.		They have the same effect as the Text Audit, Text Print, and Text Trace statements respectively.

	The AuditText, PrintText, and TraceText statements are available in Sirius Mods 7.2 and later.		The AuditText, PrintText, and TraceText statements are available in Sirius Mods 7.2 and later.

	~~In addition, the~~ [[#SetText statement\|SetText statement]], which is available in Sirius Mods 7.8 and later, uses the same syntax as AuditText, PrintText, and TraceText to set a target variable.		The [[#SetText statement\|SetText statement]], which is available in Sirius Mods 7.8 and later, uses the same syntax as AuditText, PrintText, and TraceText to set a target variable. And the [[#ReturnText statement\|ReturnText statement]], which is available in Sirius Mods 7.8 and later, uses the same syntax as AuditText, PrintText, and TraceText to return a string value from a User Language function or property Get method.

	~~The~~ [[#ReturnText statement\|ReturnText statement]], which is available in Sirius Mods 7.8 and later, uses the same syntax as AuditText, PrintText, and TraceText to return a string value from a User Language function or property Get method.

	The AuditText, PrintText, and TraceText keywords are simply a merging and reordering of Text Audit, Text Print, and Text Trace to emphasize the principle action. The lone difference between the former and latter forms is that the former cannot be used if you want to include other Html/Text options, as in:		The AuditText, PrintText, and TraceText keywords are simply a merging and reordering of Text Audit, Text Print, and Text Trace to emphasize the principle action. The lone difference between the former and latter forms is that the former cannot be used if you want to include other Html/Text options, as in:
	text noexpr print The set is {2, 3, 5, 8, 13, ...}		text noexpr print The set is {2, 3, 5, 8, 13, ...}
	However, as of Sirius Mods 7.8, certain Text statement directives can be placed after a tilde character (~) inside curly braces in any of the targeted text statements. For example		However, as of Sirius Mods 7.8, certain Text statement directives can be placed after a tilde character (~) inside curly braces ({ }) in any of the targeted text statements. For example, this statement sets <tt>%ls</tt> to the current time, embedded in hyphens.
	setText %ls = {~nocont}---{$time}---		setText %ls = {~nocont}---{$time}---
	~~sets %ls to the current time embedded in hyphens.~~ Because the <tt>~nocont</tt> directive was specified, the terminating hyphen is not treated as a continuation character.		Because the <tt>~nocont</tt> directive was specified, the terminating hyphen is not treated as a continuation character.

	The '''tilde directives''' that are allowed in targeted text statements are:		The '''tilde directives''' that are allowed in targeted text statements are:

JAL: /* SetText statement */

2010-12-17T22:43:14Z

SetText statement

← Older revision		Revision as of 22:43, 17 December 2010
Line 84:		Line 84:
	%i = 3, %al(%i) = 30		%i = 3, %al(%i) = 30
	==SetText statement==		==SetText statement==
	The SetText statement works much the same as AuditText, PrintText, and TraceText, but it is used to set a variable instead of outputting a string. The syntax of the SetText statement is:		The SetText statement works much the same as AuditText, PrintText, and TraceText, but it is used to set a variable instead of outputting a string. That is, its primary intent is to use the text it sets in the current program.

			The syntax of the SetText statement is:
	setText %variable = string		setText %variable = string
	Where:		Where: