$Ent - Revision history

JALWiccan: Automatically generated page update

2018-09-20T22:51:24Z

Automatically generated page update

← Older revision		Revision as of 22:51, 20 September 2018
Line 2:		Line 2:
	<span class="pageSubtitle">Do character entity substitution</span>		<span class="pageSubtitle">Do character entity substitution</span>

	<p class="warn"><b>Note: </b>~~Most Sirius~~ $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Ent function.</p>		<p class="warn"><b>Note: </b>Many $functions have been deprecated in favor of Object Oriented methods. There is no OO equivalent for the $Ent function.</p>

	This function performs character entity substitution on an input string using the default character entity substitution table or one set by the most recent <var>[[$Ent_Tab]]</var> call.		This function performs character entity substitution on an input string using the default character entity substitution table or one set by the most recent <var>[[$Ent_Tab]]</var> call.

JAL: misc cleanup

2015-09-23T16:28:46Z

misc cleanup

← Older revision		Revision as of 16:28, 23 September 2015
Line 9:		Line 9:

	The first argument is the string on which character entity translation is to be performed. This is an optional argument though the use of <var>$Ent</var> without this argument is somewhat silly as it simply returns a null.		The first argument is the string on which character entity translation is to be performed. This is an optional argument though the use of <var>$Ent</var> without this argument is somewhat silly as it simply returns a null.

	==Syntax==		==Syntax==
	<p class="syntax"><span class="term">%result</span> = <span class="literal">$Ent</span>(<span class="term">string</span>)		<p class="syntax"><span class="term">%result</span> = <span class="literal">$Ent</span>(<span class="term">string</span>)
	</p>		</p>

	<p><var class="term">%result</var> is set to the value of ~~'''~~string~~'''~~ with character entity substitution performed.</p>		<p>
	Character entity substitution replaces characters that have special meaning to an HTML or XML processor with their character entity representation. For example, the "<" is represented as the "&lt;" character entity. A default character entity substitution table is provided that does the basic required character entity mappings for HTML and XML of "&" to "&", "<" to "&lt;" and the double quote character to "&quot;". The active character entity substitution table can be modified with <var>[[$Ent_Tab]]</var>.		<var class="term">%result</var> is set to the value of <var class="term">string</var> with character entity substitution performed.</p>
			Character entity substitution replaces characters that have special meaning to an HTML or XML processor with their character entity representation. For example, the <code><</code> is represented as the <code>&lt;</code> character entity. A default character entity substitution table is provided that does the basic required character entity mappings for HTML and XML of <code>&</code> to <code>&</code>, <code><</code> to <code>&lt;</code> and the double quote character <code>"</code> to <code>&quot;</code>. The active character entity substitution table can be modified with <var>[[$Ent_Tab]]</var>.

	The following code		The following code prints <code>This is &lt; &quot;fun&quot;</code> if the default character entity substitution tables are in effect:
	<p class="code">PRINT $Ent('This is < "fun"')		<p class="code">PRINT $Ent('This is < "fun"')
	</p>		</p>
	~~would print <code>This is &lt; &quot;fun&quot;</code> if the default character entity substitution tables are in effect.~~
			Since character entity substitution always produces a string greater than or equal to the length of the input string, it is quite possible that a <var>$Ent</var> call will produce a string that is truncated at 255 bytes. If this is a concern, and the <var>$Ent</var> call is in a <var>Print</var> statement or is assigned to a variable that is ultimately printed, it is almost certainly better to have the character entity substitution occur at either of the following places, because in these cases the result of the character entity translation is not truncated at 255 bytes:
	Since character entity substitution always produces a string greater than or equal to the length of the input string, it is quite possible that a <var>$Ent</var> call will produce a string that is truncated at 255 bytes. If this is a concern, and the <var>$Ent</var> call is in a ~~PRINT~~ statement or is assigned to a variable that is ultimately ~~PRINT'ed~~, it is almost certainly better to have the character entity substitution occur at either of the following places, because in these cases the result of the character entity translation is not truncated at 255 bytes:
	<ul>		<ul>
			<li>The <var>Print</var> statement, as a result of the <var>[[$Ent_Print]]</var> setting

	<li>The ~~PRINT~~ statement, as a result of ~~the~~ <var>~~[[$~~Ent_Print]]</var> ~~setting~~		<li>The <var>Html/Text</var> statement, as a result of <var>Ent_Print</var>, <var>Ent_Print</var>, or the <code>&</code> special character after an expression start string
	<li>~~The HTML~~/~~TEXT statement, as a result of $Ent_Print, ENT_PRINT~~, or the <code>&</code> special character after an expression start string
	</ul>		</ul>
	If this is not possible and truncation is a concern, another option is to break the string undergoing character entity substitution into pieces that are small enough that the resultant string cannot possibly be longer than 255 bytes. For the default substitution table, this would mean pieces no larger than 255/6 or 42 bytes, since the longest substitution string is "&quot;" which is 6 bytes long.		If this is not possible and truncation is a concern, another option is to break the string undergoing character entity substitution into pieces that are small enough that the resultant string cannot possibly be longer than 255 bytes. For the default substitution table, this would mean pieces no larger than 255/6 or 42 bytes, since the longest substitution string is <code>&quot;</code> which is 6 bytes long.

	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==

JALWiccan: Automatically generated page update

2015-02-19T23:09:01Z

Automatically generated page update

← Older revision		Revision as of 23:09, 19 February 2015
Line 38:		Line 38:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]]</li>

	</ul>		</ul>

JALWiccan: Automatically generated page update

2015-02-19T22:57:54Z

Automatically generated page update

← Older revision		Revision as of 22:57, 19 February 2015
Line 38:		Line 38:
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>Japanese functions</li>		<li>Japanese functions</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/4/4b/~~SirfieldNew.pdf Sir2000 Field Migration Facility]</li>		<li>[[Media:SirfieldNew.pdf\|Sir2000 Field Migration Facility]</li>

	</ul>		</ul>

JALWiccan: Automatically generated page update

2015-02-19T22:37:58Z

Automatically generated page update

← Older revision		Revision as of 22:37, 19 February 2015
Line 34:		Line 34:
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[[Media:JosrvrNew.pdf\|Janus Open Server]</li>		<li>[[Media:JosrvrNew.pdf\|Janus Open Server]]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>

JALWiccan: Automatically generated page update

2015-02-19T22:34:32Z

Automatically generated page update

← Older revision		Revision as of 22:34, 19 February 2015
Line 34:		Line 34:
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/1/17/~~JosrvrNew.pdf Janus Open Server]</li>		<li>[[Media:JosrvrNew.pdf\|Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>

JALWiccan: Automatically generated page update

2015-02-19T21:20:54Z

Automatically generated page update

← Older revision		Revision as of 21:20, 19 February 2015
Line 33:		Line 33:
	<li>[[List of $functions\|Sirius functions]]</li>		<li>[[List of $functions\|Sirius functions]]</li>
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[[Media:JoclrNew.pdf\|Janus Open Client]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>		<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>

JALWiccan: Automatically generated page update

2015-02-19T21:17:17Z

Automatically generated page update

← Older revision		Revision as of 21:17, 19 February 2015
Line 33:		Line 33:
	<li>[[List of $functions\|Sirius functions]]</li>		<li>[[List of $functions\|Sirius functions]]</li>
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[~~http~~:~~//m204wiki.rocketsoftware.com/images/4/4a/~~JoclrNew.pdf Janus Open Client]</li>		<li>[[Media:JoclrNew.pdf\|Janus Open Client]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>		<li>[http://m204wiki.rocketsoftware.com/images/1/17/JosrvrNew.pdf Janus Open Server]</li>
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>

JALWiccan: Automatically generated page update

2014-08-01T22:07:38Z

Automatically generated page update

← Older revision		Revision as of 22:07, 1 August 2014
Line 31:		Line 31:
	==Products authorizing {{PAGENAMEE}}==		==Products authorizing {{PAGENAMEE}}==
	<ul class="smallAndTightList">		<ul class="smallAndTightList">
	<li>[[Sirius functions]]</li>		<li>[[List of $functions\|Sirius functions]]</li>
	<li>[[Fast/Unload User Language Interface]]</li>		<li>[[Fast/Unload User Language Interface]]</li>
	<li>[http://m204wiki.rocketsoftware.com/images/4/4a/JoclrNew.pdf Janus Open Client]</li>		<li>[http://m204wiki.rocketsoftware.com/images/4/4a/JoclrNew.pdf Janus Open Client]</li>

JALWiccan: Automatically generated page update

2014-07-08T16:02:36Z

Automatically generated page update

← Older revision		Revision as of 16:02, 8 July 2014
Line 37:		Line 37:
	<li>[[Janus Sockets]]</li>		<li>[[Janus Sockets]]</li>
	<li>[[Janus Web Server]]</li>		<li>[[Janus Web Server]]</li>
	<li>[[Japanese functions]]</li>		<li>Japanese functions</li>
	<li>[http://m204wiki.rocketsoftware.com/images/4/4b/SirfieldNew.pdf Sir2000 Field Migration Facility]</li>		<li>[http://m204wiki.rocketsoftware.com/images/4/4b/SirfieldNew.pdf Sir2000 Field Migration Facility]</li>