Text and Html statements - Revision history

JAL: /* Body: Html or Text block body */ misc formatting

2016-03-17T20:27:14Z

Body: Html or Text block body: misc formatting

← Older revision		Revision as of 20:27, 17 March 2016
Line 443:		Line 443:
	By default, the line that ends an <var>Html</var> or <var>Text</var> block is <var>End Html</var> for an <var>Html</var> block, or it		By default, the line that ends an <var>Html</var> or <var>Text</var> block is <var>End Html</var> for an <var>Html</var> block, or it
	is <var>End Text</var> for a <var>Text</var> block. You can specify your own end line with the <var>End</var> option,		is <var>End Text</var> for a <var>Text</var> block. You can specify your own end line with the <var>End</var> option,
	as described above in [[#End\|"End"]].		as described above in [[#End\|End]].

	===Printing of expression results===		===Printing of expression results===
Line 456:		Line 456:
	<var>$Ent_Print</var> and <var>Ent_print</var> processing by immediately following the expression start		<var>$Ent_Print</var> and <var>Ent_print</var> processing by immediately following the expression start
	character(s) with one of the following special characters:		character(s) with one of the following special characters:
	<table ~~border~~="1">		<table class="thJustBold">
	<tr><th>&</th><td>Perform character entity substitution regardless of the current <var>$Ent_Print</var>		<tr><th>&</th>
			<td>Perform character entity substitution regardless of the current <var>$Ent_Print</var>
	setting and the <var>Ent_print</var> setting on the <var>Html</var> statement.</td></tr>		setting and the <var>Ent_print</var> setting on the <var>Html</var> statement.</td></tr>

	<tr><th>!</th><td>Do not perform character entity substitution, regardless of the current		<tr><th>!</th>
			<td>Do not perform character entity substitution, regardless of the current
	<var>$Ent_Print</var> setting and the <var>Ent_print</var> setting on the <var>Html</var> statement.</td></tr>		<var>$Ent_Print</var> setting and the <var>Ent_print</var> setting on the <var>Html</var> statement.</td></tr>

Line 466:		Line 468:
	embedding a $function that itself prints output, such as <var>[[$List_Print]]</var> or <var>[[$Web_Sel]]</var>, or a $function that simply sets some environmental parameter (such as <var>[[$Web_Set]]</var> or <var>[[$Resetn]]</var>) whose return value should not be displayed.</td></tr></table>		embedding a $function that itself prints output, such as <var>[[$List_Print]]</var> or <var>[[$Web_Sel]]</var>, or a $function that simply sets some environmental parameter (such as <var>[[$Web_Set]]</var> or <var>[[$Resetn]]</var>) whose return value should not be displayed.</td></tr></table>

	'''Note:''' The asterisk (<b>*</b>) suppresses the printing of the return code but not the		<p class="note">'''Note:''' The asterisk (<tt>*</tt>) suppresses the printing of the return code but not the
	output from a <var>$List_Print</var> or <var>$Web_Sel</var> function.		output from a <var>$List_Print</var> or <var>$Web_Sel</var> function. </p>

	In the following example, character entity substitution is explicitly suppressed for the		In the following example, character entity substitution is explicitly suppressed for the
Line 478:		Line 480:
	<br>And here's some stuff<br>		<br>And here's some stuff<br>
	{*$LIST_PRINT(%LIST)}		{*$LIST_PRINT(%LIST)}
	END HTML		END HTML</nowiki> </p>
	</nowiki> </p>

	<div id="tilde"></div>		<div id="tilde"></div>
Line 501:		Line 502:
	<p class="code">printText {~= 100:nextPrime }		<p class="code">printText {~= 100:nextPrime }
	</p>		</p>
	displays		displays:
	<p class="output">100:nextPrime = 101		<p class="output">100:nextPrime = 101
	</p>		</p>
	If more control of spacing is required, the simple <b>{~}</b> directive should be used, instead.		If more control of spacing is required, the simple <b>{~}</b> directive should be used, instead.

	As mentioned at the end of the [[#To Audit, To Print, To Trace\|"To Audit, To Print, To Trace"]] section above, the <var>PrintText</var> statement is a synonym for the <var>Text Print</var> statement.		As mentioned at the end of the [[#To Audit, To Print, To Trace\|To Audit, To Print, To Trace]] section above, the <var>PrintText</var> statement is a synonym for the <var>Text Print</var> statement.

	==Table usage==		==Table usage==
	While the <var>Html</var>/<var>Text</var> statement can provide a convenient typing shorthand relative to a		While the <var>Html</var>/<var>Text</var> statement can provide a convenient typing shorthand relative to a

JAL: typo

2015-09-21T16:06:42Z

typo

← Older revision		Revision as of 16:06, 21 September 2015
Line 325:		Line 325:

	If the text of the line you		If the text of the line you
	are specifying contains spaces, enclose it in single quotation marks~~, as in:~~		are specifying contains spaces, enclose it in single quotation marks. For example:
	For example:
	<p class="code">text to %list end 'end text block'		<p class="code">text to %list end 'end text block'
	Our		Our
Line 333:		Line 332:
	</p>		</p>

	The default <var class="term">block_end_line</var> value is <code>End Html</code> (for the <var>Html</var> block) or <code>End Text</code> (for the		The default <var class="term">block_end_line</var> value is <code>End Html</code> (for the <var>Html</var> block) or <code>End Text</code> (for the <var>Text</var> block).
	<var>Text</var> block).

	<div id="toOption"></div>		<div id="toOption"></div>

Dme: /* End */

2015-09-20T11:43:16Z

End

← Older revision		Revision as of 11:43, 20 September 2015
Line 317:		Line 317:

	===End===		===End===
	To set your own <var class="term">block_end_line</var>, you can use the <var>End</var> option. If the text of the line you		To set your own <var class="term">block_end_line</var>, you can use the <var>End</var> option. For example:
			<p class="code">text to %list end listEnd
			Four score
			and seven
			listEnd
			</p>

			If the text of the line you
	are specifying contains spaces, enclose it in single quotation marks, as in:		are specifying contains spaces, enclose it in single quotation marks, as in:
	<p class="code">~~End~~ '~~END TEXT BLOCK~~' </p>		For example:
			<p class="code">text to %list end 'end text block'
			Our
			forebears
			end text block
			</p>

	The default <var class="term">block_end_line</var> value is <code>End Html</code> (for the <var>Html</var> block) or <code>End Text</code> (for the		The default <var class="term">block_end_line</var> value is <code>End Html</code> (for the <var>Html</var> block) or <code>End Text</code> (for the
	<var>Text</var> block).		<var>Text</var> block).

	<div id="toOption"></div>		<div id="toOption"></div>

	===To %stringlist, To Audit, To Print, or To Trace===		===To %stringlist, To Audit, To Print, or To Trace===
	The <var>To</var> option lets you direct the contents of the <var>Html</var> or <var>Text</var> block to a <var>Stringlist</var> or to the destinations associated with the <var class="product">User Language</var> statements <var>Audit</var>, <var>Print</var>, or <var>Trace</var>.		The <var>To</var> option lets you direct the contents of the <var>Html</var> or <var>Text</var> block to a <var>Stringlist</var> or to the destinations associated with the <var class="product">User Language</var> statements <var>Audit</var>, <var>Print</var>, or <var>Trace</var>.

JAL: /* To %stringlist [= New] */

2012-12-07T23:24:32Z

To %stringlist [= New]

JAL: /* The Html or Text statement */

2012-12-07T23:23:45Z

The Html or Text statement

← Older revision		Revision as of 23:23, 7 December 2012
Line 4:		Line 4:
	with <var class="product">Janus Web Server</var> (hence the name <code>Html</code>), it is available with many Sirius		with <var class="product">Janus Web Server</var> (hence the name <code>Html</code>), it is available with many Sirius
	products. It is most useful when <var>Print</var> output is captured or directed by some means.		products. It is most useful when <var>Print</var> output is captured or directed by some means.
	It is also quite useful for populating a <var>~~StringList~~</var> with a large amount of mostly constant		It is also quite useful for populating a <var>Stringlist</var> with a large amount of mostly constant
	text. This latter capability is provided by the <var>[[#toOption\|To]]</var> option of the <var>Html</var>/<var>Text</var> statement.		text. This latter capability is provided by the <var>[[#toOption\|To]]</var> option of the <var>Html</var>/<var>Text</var> statement.

JAL at 22:27, 7 December 2012

2012-12-07T22:27:21Z

← Older revision		Revision as of 22:27, 7 December 2012
Line 317:		Line 317:

	===End===		===End===
	To set your own block_end_line, you can use the <var>End</var> option. If the text of the line you		To set your own <var class="term">block_end_line</var>, you can use the <var>End</var> option. If the text of the line you
	are specifying contains spaces, enclose it in single quotation marks, as in:		are specifying contains spaces, enclose it in single quotation marks, as in:
	<p class="code">End 'END TEXT BLOCK' </p>		<p class="code">End 'END TEXT BLOCK' </p>
	The default block_end_line value is <code>End Html</code> (for the <var>Html</var> block) or <code>End Text</code> (for the		The default <var class="term">block_end_line</var> value is <code>End Html</code> (for the <var>Html</var> block) or <code>End Text</code> (for the
	<var>Text</var> block).		<var>Text</var> block).

Line 415:		Line 415:
	<tr><td>Expressions</td>		<tr><td>Expressions</td>
	<td>An expression is begun by a left brace (<b>{</b>) or a user-defined string specified with the <var>Exprs</var> option, and it is ended by a right brace (<b>}</b>) or a user-defined string specified with the <var>Expre</var> option. Text within the expression is evaluated as if it were the right-hand side of a <var class="product">User Language</var> assignment; that value is produced, rather than literal output.</td></tr>		<td>An expression is begun by a left brace (<b>{</b>) or a user-defined string specified with the <var>Exprs</var> option, and it is ended by a right brace (<b>}</b>) or a user-defined string specified with the <var>Expre</var> option. Text within the expression is evaluated as if it were the right-hand side of a <var class="product">User Language</var> assignment; that value is produced, rather than literal output.</td></tr>

	<tr><td nowrap>Dummy strings</td>		<tr><td nowrap>Dummy strings</td>
	<td>Normally, as in other <var class="product">Model 204</var> input, dummy strings are substituted under the control of the <var>SUB</var> parameter. This can be suppressed with the <var>Nodummy</var> option, which may be useful if your block contains strings like "what the heck??!!".</td></tr>		<td>Normally, as in other <var class="product">Model 204</var> input, dummy strings are substituted under the control of the <var>SUB</var> parameter. This can be suppressed with the <var>Nodummy</var> option, which may be useful if your block contains strings like "what the heck??!!".</td></tr>

	<tr><td>Continuation</td>		<tr><td>Continuation</td>
	<td>Continuation allows text from multiple lines to be printed on one line by adding a hyphen (<b>-</b>) to all preceding lines in the block. All spacing and indentation following the hyphen is ignored. This option works inside an expression.</td></tr>		<td>Continuation allows text from multiple lines to be printed on one line by adding a hyphen (<b>-</b>) to all preceding lines in the block. All spacing and indentation following the hyphen is ignored. This option works inside an expression.</td></tr>

	<tr><td>Ellipses</td>		<tr><td>Ellipses</td>
	<td>Ellipses allow text from multiple command lines to be printed on one line by adding three dots (<b>...</b>) to all preceding command lines. Leading spaces will be included. This option will not work inside an expression.</td></tr>		<td>Ellipses allow text from multiple command lines to be printed on one line by adding three dots (<b>...</b>) to all preceding command lines. Leading spaces will be included. This option will not work inside an expression.</td></tr>

	<tr> <td>Indentation</td>		<tr> <td>Indentation</td>
	<td>Except for continuation lines, the output of a line is indented by as many spaces as the input is indented relative to the <var>Html</var> or <var>Text</var> statement that begins the block.</td></tr></table>		<td>Except for continuation lines, the output of a line is indented by as many spaces as the input is indented relative to the <var>Html</var> or <var>Text</var> statement that begins the block.</td></tr></table>
Line 443:		Line 447:
	<tr><th>&</th><td>Perform character entity substitution regardless of the current <var>$Ent_Print</var>		<tr><th>&</th><td>Perform character entity substitution regardless of the current <var>$Ent_Print</var>
	setting and the <var>Ent_print</var> setting on the <var>Html</var> statement.</td></tr>		setting and the <var>Ent_print</var> setting on the <var>Html</var> statement.</td></tr>

	<tr><th>!</th><td>Do not perform character entity substitution, regardless of the current		<tr><th>!</th><td>Do not perform character entity substitution, regardless of the current
	<var>$Ent_Print</var> setting and the <var>Ent_print</var> setting on the <var>Html</var> statement.</td></tr>		<var>$Ent_Print</var> setting and the <var>Ent_print</var> setting on the <var>Html</var> statement.</td></tr>

	<tr><th>*</th><td>Do not print the results of the expression. This can be useful if		<tr><th>*</th><td>Do not print the results of the expression. This can be useful if
	embedding a $function that itself prints output, such as <var>[[$List_Print]]</var> or <var>[[$Web_Sel]]</var>, or a $function that simply sets some environmental parameter (such as <var>[[$Web_Set]]</var> or <var>[[$Resetn]]</var>) whose return value should not be displayed.</td></tr></table>		embedding a $function that itself prints output, such as <var>[[$List_Print]]</var> or <var>[[$Web_Sel]]</var>, or a $function that simply sets some environmental parameter (such as <var>[[$Web_Set]]</var> or <var>[[$Resetn]]</var>) whose return value should not be displayed.</td></tr></table>
Line 454:		Line 460:
	contents of <code>%FONT</code> and explicitly forced for <code>%COMMENT</code>, and the return code from		contents of <code>%FONT</code> and explicitly forced for <code>%COMMENT</code>, and the return code from
	<code>$LIST_PRINT</code> is suppressed:		<code>$LIST_PRINT</code> is suppressed:

	<p class="code"><nowiki>HTML		<p class="code"><nowiki>HTML
	{!%FONT}This is in a fancy font</font>		{!%FONT}This is in a fancy font</font>
Line 462:		Line 469:
	</nowiki> </p>		</nowiki> </p>

	<div id="tilde">		<div id="tilde"></div>
	<div id="tildeDirectives"></div>		<div id="tildeDirectives"></div>
	===The {~} and {~= ...} directives===		===The {~} and {~= ...} directives===

JAL: /* To (%stringlist, Audit, Print, or Trace) */

2012-12-07T22:11:33Z

To (%stringlist, Audit, Print, or Trace)

← Older revision		Revision as of 22:11, 7 December 2012
Line 324:		Line 324:

	<div id="toOption"></div>		<div id="toOption"></div>
	===To (%stringlist, Audit, Print, or Trace)===		===To %stringlist, To Audit, To Print, or To Trace===
	The <var>To</var> option lets you direct the contents of the <var>Html</var> or <var>Text</var> block to a <var>Stringlist</var> or to the destinations associated with the <var class="product">User Language</var> statements <var>Audit</var>, <var>Print</var>, or <var>Trace</var>.		The <var>To</var> option lets you direct the contents of the <var>Html</var> or <var>Text</var> block to a <var>Stringlist</var> or to the destinations associated with the <var class="product">User Language</var> statements <var>Audit</var>, <var>Print</var>, or <var>Trace</var>.

JAL: /* To (for Audit, Print, Trace, or, with [= New], %stringlist) */

2012-12-07T22:08:07Z

To (for Audit, Print, Trace, or, with [= New], %stringlist)

← Older revision		Revision as of 22:08, 7 December 2012
Line 324:		Line 324:

	<div id="toOption"></div>		<div id="toOption"></div>
	===To (~~for~~ Audit, Print, Trace~~, or, with [= New], %stringlist~~)===		===To (%stringlist, Audit, Print, or Trace)===
	The <var>To</var> option lets you direct the contents of the <var>Html</var> or <var>Text</var> block to a <var>Stringlist</var> or to the destinations associated with the <var class="product">User Language</var> statements <var>Audit</var>, <var>Print</var>, or <var>Trace</var>.		The <var>To</var> option lets you direct the contents of the <var>Html</var> or <var>Text</var> block to a <var>Stringlist</var> or to the destinations associated with the <var class="product">User Language</var> statements <var>Audit</var>, <var>Print</var>, or <var>Trace</var>.

	====To %stringlist====		====To %stringlist [= New]====
	The <var>To</var> option, when used to add data to a <var>Stringlist</var>, has an optional <~~var~~>= New</~~var~~> clause following the <var>Stringlist</var>, which first creates a new <var>Stringlist</var> instance. Without <~~var~~>= New</~~var~~>, the data is appended to the <var>Stringlist</var>.		The <var>To</var> option, when used to add data to a <var>Stringlist</var>, has an optional <code>= New</code> clause following the <var>Stringlist</var>, which first creates a new <var>Stringlist</var> instance. Without <code>= New</code>, the data is appended to the <var>Stringlist</var>.

	Here is how <var>Text To</var> populates a <var>StringList</var> with some names:		Here is how <var>Text To</var> populates a <var>StringList</var> with some names:

JAL: /* The Html or Text statement */

2012-12-07T21:49:49Z

The Html or Text statement

← Older revision		Revision as of 21:49, 7 December 2012
Line 36:		Line 36:

	<p class="syntax"><span class="literal">Text</span> <span class="squareb">[</span><span class="term">options</span><span class="squareb">]</span>		<p class="syntax"><span class="literal">Text</span> <span class="squareb">[</span><span class="term">options</span><span class="squareb">]</span>
	<span class="term>">body		<span class="term>body
	block_end_line</span>		block_end_line</span>
	</p>		</p>
Line 108:		Line 108:

	The <var>Html</var> block is also available if the <var class="product">Limited Janus Web Server</var> capability is available.		The <var>Html</var> block is also available if the <var class="product">Limited Janus Web Server</var> capability is available.

	==Options: Html or Text block options==		==Options: Html or Text block options==
	The various options for an <var>Html</var> or <var>Text</var> block are introduced after the <code>Html</code> or <code>Text</code>		The various options for an <var>Html</var> or <var>Text</var> block are introduced after the <code>Html</code> or <code>Text</code>

JALWiccan: 1 revision

2012-11-08T21:52:44Z

1 revision

← Older revision	Revision as of 21:52, 8 November 2012
(No difference)

← Older revision		Revision as of 23:24, 7 December 2012
Line 330:		Line 330:
	The <var>To</var> option, when used to add data to a <var>Stringlist</var>, has an optional <code>= New</code> clause following the <var>Stringlist</var>, which first creates a new <var>Stringlist</var> instance. Without <code>= New</code>, the data is appended to the <var>Stringlist</var>.		The <var>To</var> option, when used to add data to a <var>Stringlist</var>, has an optional <code>= New</code> clause following the <var>Stringlist</var>, which first creates a new <var>Stringlist</var> instance. Without <code>= New</code>, the data is appended to the <var>Stringlist</var>.

	Here is how <var>Text To</var> populates a <var>~~StringList~~</var> with some names:		Here is how <var>Text To</var> populates a <var>Stringlist</var> with some names:
	<p class="code">%jumps is object stringList		<p class="code">%jumps is object stringList
	...		...
Line 351:		Line 351:
	wih <var>$List_Capture</var>:		wih <var>$List_Capture</var>:
	<ul>		<ul>
	<li> <var>$List_Capture</var> or an equivalent is not available for <var>~~StringLists~~</var>.		<li> <var>$List_Capture</var> or an equivalent is not available for <var>Stringlists</var>.
	<li> Because <var>Html To</var> does not go through generic Print processing, it has a somewhat more efficient processing path, that is, it uses less CPU.		<li> Because <var>Html To</var> does not go through generic Print processing, it has a somewhat more efficient processing path, that is, it uses less CPU.
	<li> Because <var>Html To</var> does not go through generic Print processing, the generated quads take somewhat less space.		<li> Because <var>Html To</var> does not go through generic Print processing, the generated quads take somewhat less space.
	<li> An <var>Html To</var> block does not affect the current <var>$List_Capture</var> setting, so it eliminates the need to worry about saving and restoring the <var>$List_Capture</var> setting.		<li> An <var>Html To</var> block does not affect the current <var>$List_Capture</var> setting, so it eliminates the need to worry about saving and restoring the <var>$List_Capture</var> setting.
	<li> A <var>To</var> option on an <var>Html</var> statement is simply less and cleaner code than an <var>Html</var> statement inside a <var>$List_Capture</var> bracket.		<li> A <var>To</var> option on an <var>Html</var> statement is simply less and cleaner code than an <var>Html</var> statement inside a <var>$List_Capture</var> bracket.
	<li> If an expression inside an <var>Html To</var> block invokes a User Language method, and that method does a Print statement, the output of that <var>Print</var> statement does not end up on the <var>~~StringList~~</var> target of the <var>Html</var> statement. Inside a <var>$List_Capture</var> bracket, the output of such a <var>Print</var> statement ends up on the <var>$List_Capture</var>'s target $list.		<li> If an expression inside an <var>Html To</var> block invokes a User Language method, and that method does a Print statement, the output of that <var>Print</var> statement does not end up on the <var>Stringlist</var> target of the <var>Html</var> statement. Inside a <var>$List_Capture</var> bracket, the output of such a <var>Print</var> statement ends up on the <var>$List_Capture</var>'s target $list.
	</ul>		</ul>
	The <var>To</var> option of the <var>Html</var> or <var>Text</var> statement appends to the target <var>Stringlist</var>, so it does not		The <var>To</var> option of the <var>Html</var> or <var>Text</var> statement appends to the target <var>Stringlist</var>, so it does not
	instantiate the <var>~~StringList~~</var> if it is null. In fact, a null <var>~~StringList~~</var> target for an <var>Html To</var> results		instantiate the <var>Stringlist</var> if it is null. In fact, a null <var>Stringlist</var> target for an <var>Html To</var> results
	in a null-pointer request-cancelling error.		in a null-pointer request-cancelling error.