AddComment (XmlDoc/XmlNode function) - Revision history

ELowell: /* Syntax terms */

2015-09-02T21:00:03Z

Syntax terms

← Older revision		Revision as of 21:00, 2 September 2015
Line 7:		Line 7:
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%nod</th>		<tr><th nowrap>%nod</th>
	<td>If specified, an <var>XmlNode</var> that is set to point to the <var>Comment</var> node that is added. </td></tr>		<td>If specified, an <var>XmlNode</var> that is set to point to the <var>Comment</var> node that is added. </td></tr>
	<tr><th>nr</th>		<tr><th>nr</th>

JAL: /* Examples */

2014-03-12T18:43:43Z

Examples

← Older revision		Revision as of 18:43, 12 March 2014
Line 50:		Line 50:
	</p>		</p>

	<li>In the following example under <var class="product">Sirius Mods</var> Version 7.6 or higher, a comment is added which uses a Unicode character, then printed twice. The Print statement succeeds only if its <~~code~~>CharacterEncodeAll</~~code~~> option is specified, because the Unicode character (trademark) does not translate to an EBCDIC character. For such a character in an Element or Attribute value, however, the Print method automatically displays the XML hex representation and does ''not'' require the <var>CharacterEncodeAll</var> option.		<li>In the following example under <var class="product">Sirius Mods</var> Version 7.6 or higher, a comment is added which uses a Unicode character, then printed twice. The Print statement succeeds only if its <var>CharacterEncodeAll</var> option is specified, because the Unicode character (trademark) does not translate to an EBCDIC character. For such a character in an Element or Attribute value, however, the <var>Print</var> method automatically displays the XML hex representation and does ''not'' require the <var>CharacterEncodeAll</var> option.
	<p class="code">begin		<p class="code">begin
	%d object xmlDoc auto new		%d object xmlDoc auto new
Line 65:		Line 65:
	<a/>		<a/>
	CANCELLING REQUEST: MSIR.0750: Class XMLDOC, subroutine PRINT:		CANCELLING REQUEST: MSIR.0750: Class XMLDOC, subroutine PRINT:
	Unicode character without valid translation to EBCDIC in line 9		Unicode character without valid translation to EBCDIC in line 9</nowiki>
	</nowiki>
	</p>		</p>
	<li>
	For additional examples of working with Unicode characters in an <var>XmlDoc</var>, see item [[AddElement_(XmlDoc/XmlNode_function)#Adding_characters_that_are_represented_by_character_references\|"Adding characters that are represented by character references"]]		<li>For additional examples of working with Unicode characters in an <var>XmlDoc</var>, see item [[AddElement_(XmlDoc/XmlNode_function)#Adding_characters_that_are_represented_by_character_references\|Adding characters that are represented by character references]].
	</ol>		</ol>

JAL at 01:59, 1 March 2014

2014-03-01T01:59:36Z

← Older revision		Revision as of 01:59, 1 March 2014
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:AddComment subtitle}}		{{Template:XmlDoc/XmlNode:AddComment subtitle}}
	This <var>[[Notation_conventions_for_methods#Callable_methods\|callable]]</var> function adds a ~~<var>~~Comment~~</var>~~ node as the last child of the <var>Root</var> node or <var>Element</var> node referenced by the method object.		This <var>[[Notation_conventions_for_methods#Callable_methods\|callable]]</var> function adds a [[XmlDoc API#XmlDoc node types\|Comment node]] as the last child of the <var>Root</var> node or <var>Element</var> node referenced by the method object.

	==Syntax==		==Syntax==
	{{Template:XmlDoc/XmlNode:AddComment syntax}}		{{Template:XmlDoc/XmlNode:AddComment syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
Line 72:		Line 73:

	==Request-cancellation errors==		==Request-cancellation errors==
			This list is not exhaustive: it does <i>not</i> include all the errors that are request cancelling.
	<ul>		<ul>
	<li>Object <var class="term">nr</var> is neither the <var>Root</var> nor an <var>Element</var> node.		<li>Object <var class="term">nr</var> is neither the <var>Root</var> nor an <var>Element</var> node.

JAL: /* Examples */

2012-11-06T17:51:02Z

Examples

← Older revision		Revision as of 17:51, 6 November 2012
Line 48:		Line 48:
	<!--this is comment 1-->		<!--this is comment 1-->
	</p>		</p>

	<li>In the following example under <var class="product">Sirius Mods</var> Version 7.6 or higher, a comment is added which uses a Unicode character, then printed twice. The Print statement succeeds only if its <code>CharacterEncodeAll</code> option is specified, because the Unicode character (trademark) does not translate to an EBCDIC character. For such a character in an Element or Attribute value, however, the Print method automatically displays the XML hex representation and does ''not'' require the <var>CharacterEncodeAll</var> option.		<li>In the following example under <var class="product">Sirius Mods</var> Version 7.6 or higher, a comment is added which uses a Unicode character, then printed twice. The Print statement succeeds only if its <code>CharacterEncodeAll</code> option is specified, because the Unicode character (trademark) does not translate to an EBCDIC character. For such a character in an Element or Attribute value, however, the Print method automatically displays the XML hex representation and does ''not'' require the <var>CharacterEncodeAll</var> option.
	<p class="code">begin		<p class="code">begin
	%d object xmlDoc auto new		%d object xmlDoc auto new
	%d:addComment('™':U)		%d:addComment('&#x2122;':U)
	%d:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('a')		%d:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('a')

Line 60:		Line 61:

	The result is:		The result is:
	<p class="output"><nowiki><!--™-->		<p class="output"><nowiki><!--&#x2122;-->
	<a/>		<a/>
	CANCELLING REQUEST: MSIR.0750: Class XMLDOC, subroutine PRINT:		CANCELLING REQUEST: MSIR.0750: Class XMLDOC, subroutine PRINT:

JALWiccan: 1 revision

2012-11-06T17:46:13Z

1 revision

← Older revision	Revision as of 17:46, 6 November 2012
(No difference)

Goff: unquote Sirius Mods

2012-11-06T17:46:03Z

unquote Sirius Mods

← Older revision		Revision as of 17:46, 6 November 2012
Line 51:		Line 51:
	<p class="code">begin		<p class="code">begin
	%d object xmlDoc auto new		%d object xmlDoc auto new
	%d:addComment('&~~amp;amp;amp;~~#x2122;':U)		%d:addComment('™':U)
	%d:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('a')		%d:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('a')

Line 60:		Line 60:

	The result is:		The result is:
	<p class="output"><nowiki><!--&~~amp;amp;amp;~~#x2122;-->		<p class="output"><nowiki><!--™-->
	<a/>		<a/>
	CANCELLING REQUEST: MSIR.0750: Class XMLDOC, subroutine PRINT:		CANCELLING REQUEST: MSIR.0750: Class XMLDOC, subroutine PRINT:

Goff: unquote Sirius Mods

2011-05-28T01:34:13Z

unquote Sirius Mods

← Older revision		Revision as of 01:34, 28 May 2011
Line 18:		Line 18:
	<li>Since the return value of <var>AddComment</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.		<li>Since the return value of <var>AddComment</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.
	<li>Processing of an <var>XmlDoc</var> is likely to be more efficient if you add nodes in document order (that is, top-to-bottom, left-to-right).		<li>Processing of an <var>XmlDoc</var> is likely to be more efficient if you add nodes in document order (that is, top-to-bottom, left-to-right).
	<li>As of <var class="product">[[~~Sirius Mods\|~~Sirius Mods]]</var> Version 7.3, <var class="term">value</var> may not include EBCDIC characters that do not translate to Unicode. As of <var class="product">Sirius Mods</var> Version 7.6, the content of an <var>XmlDoc</var> is maintained in <var>Unicode</var>. For more information about the effects of this Version 7.6 change, see <var>[[XmlNodelist_class#Strings_and_Unicode_with_the_XmlDoc_API\|"Strings and Unicode"]]</var>.		<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.3, <var class="term">value</var> may not include EBCDIC characters that do not translate to Unicode. As of <var class="product">Sirius Mods</var> Version 7.6, the content of an <var>XmlDoc</var> is maintained in <var>Unicode</var>. For more information about the effects of this Version 7.6 change, see <var>[[XmlNodelist_class#Strings_and_Unicode_with_the_XmlDoc_API\|"Strings and Unicode"]]</var>.
	<li>To modify the <var>value</var> stored in an <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.		<li>To modify the <var>value</var> stored in an <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.
	</ul>		</ul>

JAL2 at 15:18, 27 May 2011

2011-05-27T15:18:23Z

← Older revision		Revision as of 15:18, 27 May 2011
Line 1:		Line 1:
	{{Template:XmlDoc/XmlNode:AddComment subtitle}}		{{Template:XmlDoc/XmlNode:AddComment subtitle}}
	This <var>[[Notation_conventions_for_methods#Callable_methods\|~~Callable-function~~]]</var> adds a <var>Comment</var> node as the last child of the <var>Root</var> node or <var>Element</var> node referenced by the method object.		This <var>[[Notation_conventions_for_methods#Callable_methods\|callable]]</var> function adds a <var>Comment</var> node as the last child of the <var>Root</var> node or <var>Element</var> node referenced by the method object.

	==Syntax==		==Syntax==
Line 70:		Line 70:
	</ol>		</ol>

	==Request-~~Cancellation Errors~~==		==Request-cancellation errors==
	<ul>		<ul>
	<li><i>Nr</i> is neither the <var>Root</var> nor an <var>Element</var> node.		<li>Object <var class="term">nr</var> is neither the <var>Root</var> nor an <var>Element</var> node.
	<li>Argument <i>value</i> violates the rules for an XML comment.		<li>Argument <var class="term">value</var> violates the rules for an XML comment.
	</ul>		</ul>

JALWiccan: 1 revision

2011-05-24T21:09:56Z

1 revision

← Older revision	Revision as of 21:09, 24 May 2011
(No difference)

Goff: /* Usage notes */

2011-05-24T21:09:55Z

Usage notes

← Older revision		Revision as of 21:09, 24 May 2011
Line 18:		Line 18:
	<li>Since the return value of <var>AddComment</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.		<li>Since the return value of <var>AddComment</var> is frequently not needed, you may want to [[Notation_conventions_for_methods#Callable_methods\|Call]] it instead of saving its return value.
	<li>Processing of an <var>XmlDoc</var> is likely to be more efficient if you add nodes in document order (that is, top-to-bottom, left-to-right).		<li>Processing of an <var>XmlDoc</var> is likely to be more efficient if you add nodes in document order (that is, top-to-bottom, left-to-right).
	<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3, <var class="term">value</var> may not include EBCDIC characters that do not translate to Unicode. As of <var class="product">"Sirius Mods"</var> Version 7.6, the content of an <var>XmlDoc</var> is maintained in <var>Unicode</var>. For more information about the effects of this Version 7.6 change, see <var>[[XmlNodelist_class#Strings_and_Unicode_with_the_XmlDoc_API\|"Strings and Unicode"]]</var>.		<li>As of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3, <var class="term">value</var> may not include EBCDIC characters that do not translate to Unicode. As of <var class="product">Sirius Mods</var> Version 7.6, the content of an <var>XmlDoc</var> is maintained in <var>Unicode</var>. For more information about the effects of this Version 7.6 change, see <var>[[XmlNodelist_class#Strings_and_Unicode_with_the_XmlDoc_API\|"Strings and Unicode"]]</var>.
	<li>To modify the <var>value</var> stored in an <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.		<li>To modify the <var>value</var> stored in an <var>Comment</var> node, change the <var>[[Value_(XmlDoc/XmlNode_property)\|Value]]</var> property of an <var>XmlNode</var> that points to the <var>Comment</var> node.
	</ul>		</ul>
Line 48:		Line 48:
	<!--this is comment 1-->		<!--this is comment 1-->
	</p>		</p>
	<li>In the following example under <var class="product">"Sirius Mods"</var> Version 7.6 or higher, a comment is added which uses a Unicode character, then printed twice. The Print statement succeeds only if its <code>CharacterEncodeAll</code> option is specified, because the Unicode character (trademark) does not translate to an EBCDIC character. For such a character in an Element or Attribute value, however, the Print method automatically displays the XML hex representation and does ''not'' require the <var>CharacterEncodeAll</var> option.		<li>In the following example under <var class="product">Sirius Mods</var> Version 7.6 or higher, a comment is added which uses a Unicode character, then printed twice. The Print statement succeeds only if its <code>CharacterEncodeAll</code> option is specified, because the Unicode character (trademark) does not translate to an EBCDIC character. For such a character in an Element or Attribute value, however, the Print method automatically displays the XML hex representation and does ''not'' require the <var>CharacterEncodeAll</var> option.
	<p class="code">begin		<p class="code">begin
	%d object xmlDoc auto new		%d object xmlDoc auto new
	%d:addComment('&amp;#x2122;':U)		%d:addComment('&amp;amp;#x2122;':U)
	%d:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('a')		%d:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('a')

Line 60:		Line 60:

	The result is:		The result is:
	<p class="output"><nowiki><!--&amp;#x2122;-->		<p class="output"><nowiki><!--&amp;amp;#x2122;-->
	<a/>		<a/>
	CANCELLING REQUEST: MSIR.0750: Class XMLDOC, subroutine PRINT:		CANCELLING REQUEST: MSIR.0750: Class XMLDOC, subroutine PRINT: