Serial (XmlDoc/XmlNode function) - Revision history

JAL: xpath arg

2015-02-18T17:58:45Z

xpath arg

← Older revision		Revision as of 17:58, 18 February 2015
Line 8:		Line 8:
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>A string variable for the string serialization of the subtree, encoded either in UTF-8 or, if the <var>EBCDIC</var> option (see below) is used, in EBCDIC.</td></tr>		<td>A string variable for the string serialization of the subtree, encoded either in UTF-8 or, if the <var>EBCDIC</var> option (see below) is used, in EBCDIC.</td></tr>

	<tr><th>nr</th>		<tr><th>nr</th>
	<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>		<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>

	<tr><th>xpath</th>		<tr><th>xpath</th>
	<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|Xpath expression]] that results in a nodelist, the head of which is the top of the subtree to serialize. This is an optional argument; its default is a period (<tt>.</tt>), that is, the node referenced by the method object(<var class="term">nr</var>).		<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|Xpath expression]] that results in a nodelist, the head of which is the top of the subtree to serialize. Any other nodes in the nodelist are ignored.
	<p>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>		<p>
			This is an optional argument; its default is a period (<tt>.</tt>), that is, the node referenced by the method object(<var class="term">nr</var>). </p>
			<p>
			Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>

	<tr><th><div id="options"></div>options</th>		<tr><th><div id="options"></div>options</th>
	<td>A blank delimited string that can contain one or more of the following options (but no repeats). <p class="note">'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options~~\|"XmlDoc API serialization options"~~]]. </p>		<td>A blank delimited string that can contain one or more of the following options (but no repeats).
			<p class="note">'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options]]. </p>
	<ul>		<ul>
	<li><b>CharacterEncodeAll</b><br>		<li><b>CharacterEncodeAll</b><br>

JAL: /* See also */

2014-03-13T20:41:16Z

JAL: /* Syntax terms */

2014-03-09T18:00:43Z

Syntax terms

← Older revision		Revision as of 18:00, 9 March 2014
Line 10:		Line 10:
	<tr><th>nr</th>		<tr><th>nr</th>
	<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>		<td>An <var>XmlDoc</var> or <var>XmlNode</var>, used as the context node for the <var class="term">xpath</var> expression. If an <var>XmlDoc</var>, the <var>Root</var> node is the context node.</td></tr>

	<tr><th>xpath</th>		<tr><th>xpath</th>
	<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|Xpath expression]] that results in a nodelist, the head of which is the top of the subtree to serialize. This is an optional argument; its default is a period (<tt>.</tt>), that is, the node referenced by the method object(<var class="term">nr</var>).		<td>A <var>Unicode</var> string that is an [[XPath#XPath_syntax\|Xpath expression]] that results in a nodelist, the head of which is the top of the subtree to serialize. This is an optional argument; its default is a period (<tt>.</tt>), that is, the node referenced by the method object(<var class="term">nr</var>).
	<p>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>		<p>Prior to <var class="product">[[Sirius Mods]]</var> Version 7.6, this is an EBCDIC string.</p></td></tr>

	<tr><th><div id="options"></div>options</th>		<tr><th><div id="options"></div>options</th>
	<td>A blank delimited string that can contain one or more of the following options (but no repeats). <br>'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]].		<td>A blank delimited string that can contain one or more of the following options (but no repeats). <p class="note">'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]]. </p>
	<ul>		<ul>
	<li><b>CharacterEncodeAll</b><br>		<li><b>CharacterEncodeAll</b><br>
	If the <var>EBCDIC</var> option is specified, use character encoding in all contexts (that is, not only in <var>Attribute</var> or <var>Element</var> values) to display Unicode characters that do not translate to EBCDIC. This option is available starting with version 8.0 of the <var class="product">Sirius Mods</var>.		If the <var>EBCDIC</var> option is specified, use character encoding in all contexts (that is, not only in <var>Attribute</var> or <var>Element</var> values) to display Unicode characters that do not translate to EBCDIC. This option is available starting with version 8.0 of the <var class="product">Sirius Mods</var>.

	<li><b>EBCDIC</b>		<li><b>EBCDIC</b>
	<br>Produces serialized output in EBCDIC text rather than the default encoding, UTF-8.		<br>Produces serialized output in EBCDIC text rather than the default encoding, UTF-8.

	<li><b>ExclCanonical</b>		<li><b>ExclCanonical</b>
	<br>Produces serialized output in exclusive XML canonical form, as defined in the W3C "Exclusive XML Canonicalization" specification (http://www.w3.org/tr/xml-exc-c14n).		<br>Produces serialized output in exclusive XML canonical form, as defined in the W3C "Exclusive XML Canonicalization" specification (http://www.w3.org/tr/xml-exc-c14n).

	<li><b>Indent <i>n</i></b>		<li><b>Indent <i>n</i></b>
	<br>Inserts space characters and line-ends into the serialized string such that if the string is broken at the line-ends and displayed as a tree, the display of each lower level in the subtree is indented ''n'' spaces from the previous level's starting point. You must also specify <code>CR</code>, <code>LF</code>, or <code>CRLF</code> (see below).		<br>Inserts space characters and line-ends into the serialized string such that if the string is broken at the line-ends and displayed as a tree, the display of each lower level in the subtree is indented ''n'' spaces from the previous level's starting point. You must also specify <code>CR</code>, <code>LF</code>, or <code>CRLF</code> (see below). </li>

	<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), or <b>CRLF</b> (carriage-return followed by a linefeed)		<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), or <b>CRLF</b> (carriage-return followed by a linefeed)
	<br>Inserts one of these line-end characters to provide line breaks in the serialized output.		<br>Inserts one of these line-end characters to provide line breaks in the serialized output. </li>

	<div id="noempty"></div>		<div id="noempty"></div>
	<li><b>NoEmptyElt</b>		<li><b>NoEmptyElt</b>
	<br>~~Deprecated as of <var class="product">Sirius Mods</var> Version 7.0, this~~ option ~~ensures that~~ all empty elements ~~are serialized~~ with a start tag followed by an end tag. The default is to serialize an empty element with an empty element tag (as in <code><middleName/></code>).		<br>This deprecated option serializes all empty elements with a start tag followed by an end tag. The default is to serialize an empty element with an empty element tag (as in <code><middleName/></code>).
			<p>
			<var>NoEmptyElt</var> is deprecated in order to deter users from using it to serialize HTML: The recommended approach for HTML is shown on the <var>[[NoEmptyElement (XmlNode property)#browserExample\|NoEmptyElement]]</var> property page — some tags (<code><div></code>) <b>require</b> separate start and end tags, while other tags (<code><br></code>) <b>do not allow</b> separate start and end tags. </p></li>

	<li><b>OmitNullElement</b>		<li><b>OmitNullElement</b>
	<br>An <var>Element</var> node that has no children and no <var>Attributes</var> will not be serialized, unless it is the top level <var>Element</var> in the subtree being serialized.		<br>An <var>Element</var> node that has no children and no <var>Attributes</var> will not be serialized, unless it is the top level <var>Element</var> in the subtree being serialized. </li>

	<li><b>SortCanonical</b>		<li><b>SortCanonical</b>
	<br>This deprecated option serializes namespace declarations and attributes in sorted order (from lowest to highest with Unicode code ordering). It is superseded by the <var>ExclCanonical</var> option.		<br>This deprecated option serializes namespace declarations and attributes in sorted order (from lowest to highest with Unicode code ordering). It is superseded by the <var>ExclCanonical</var> option. </li>

	<li><b>UTF-8</b>		<li><b>UTF-8</b>
	<br>Produces serialized output in UTF-8. This is the default.		<br>Produces serialized output in UTF-8. This is the default. </li>

	<li><b>WithComments</b>		<li><b>WithComments</b>
	<br>Includes in the serialized output all <var>Comment</var> nodes in the specified subtree.		<br>Includes in the serialized output all <var>Comment</var> nodes in the specified subtree.
	<p>'''Note:''' Specifying <var>WithComments</var> without specifying <var>ExclCanonical</var> has no effect. Specifying <var>ExclCanonical</var> without specifying <var>WithComments</var> suppresses all <var>Comment</var> nodes from the result.</p>		<p class="note">'''Note:''' Specifying <var>WithComments</var> without specifying <var>ExclCanonical</var> has no effect. Specifying <var>ExclCanonical</var> without specifying <var>WithComments</var> suppresses all <var>Comment</var> nodes from the result.</p> </li>

	<li><b>XmlDecl</b>		<li><b>XmlDecl</b>
	<br>Ensures that the serialization will contain the "XML Declaration" (<code><?xml version=...?></code>), if the value of the <var>[[Version (XmlDoc property)\|Version]]</var> property is a non-null string, if the <var>XmlDoc</var> is not empty, and if the top of the subtree being serialized is the <var>Root</var> node.		<br>Ensures that the serialization will contain the "XML Declaration" (<code><?xml version=...?></code>), if the value of the <var>[[Version (XmlDoc property)\|Version]]</var> property is a non-null string, if the <var>XmlDoc</var> is not empty, and if the top of the subtree being serialized is the <var>Root</var> node. </li>
	</ul>		</ul>
	</td></tr>		</td></tr>

	<tr><th><var>AddTrailingDelimiter</var></th>		<tr><th><var>AddTrailingDelimiter</var></th>
	<td>This [[Methods#Named parameters\|name required]] parameter is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value, which determines whether a final line-end character is added to the serialization when one of the <var>Serial</var> method line-end options (<var>LF</var>, <var>CR</var>, or <var>CRLF</var>) is specified.		<td>This [[Methods#Named parameters\|name required]] parameter is a <var>[[Enumerations#Using Boolean enumerations\|Boolean]]</var> value, which determines whether a final line-end character is added to the serialization when one of the <var>Serial</var> method line-end options (<var>LF</var>, <var>CR</var>, or <var>CRLF</var>) is specified.
	<p>The default value of <var>AddTrailingDelimiter</var> is <var>True</var>, so <var>Serial</var> specified with a line-end option adds a trailing line-end by default. If <var>AddTrailingDelimiter</var> is <var>False</var>, no final line-end character is added.</p>		<p>
	<p>Specifying the <var>AddTrailingDelimiter</var> argument without also specifying one of the line-end options has no effect on the resulting serialization.</p>		The default value of <var>AddTrailingDelimiter</var> is <var>True</var>, so <var>Serial</var> specified with a line-end option adds a trailing line-end by default. If <var>AddTrailingDelimiter</var> is <var>False</var>, no final line-end character is added.</p>
	<p><var>AddTrailingDelimiter</var> was introduced as of <var class="product">Sirius Mods</var> Version 7.0. It may be useful if a digital signature must be created which includes line-end characters between XML tags, but the <var>XmlDoc</var> does not contain those line-end <var>Text</var> nodes.</p></td></tr>		<p>
			Specifying the <var>AddTrailingDelimiter</var> argument without also specifying one of the line-end options has no effect on the resulting serialization.</p>
			<p>
			<var>AddTrailingDelimiter</var> was introduced as of <var class="product">Sirius Mods</var> Version 7.0. It may be useful if a digital signature must be created which includes line-end characters between XML tags, but the <var>XmlDoc</var> does not contain those line-end <var>Text</var> nodes.</p></td></tr>
	</table>		</table>

JAL: /* Request-cancellation errors */

2014-03-03T21:05:17Z

Request-cancellation errors

← Older revision		Revision as of 21:05, 3 March 2014
Line 95:		Line 95:

	==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><var class="term">xpath</var> argument is invalid.		<li><var class="term">xpath</var> argument is invalid.

JAL2: /* Examples */

2012-03-20T21:42:51Z

Examples

← Older revision		Revision as of 21:42, 20 March 2012
Line 56:		Line 56:

	==Examples==		==Examples==
	In the following example, the <var>Serial</var> method EBCDIC formatting of a document is shown. A <var>Print</var> statement display of the default UTF-8 formatting of <var>Serial</var> is a string that is not readily decipherable.		<ol>
			<li>In the following example, the <var>Serial</var> method EBCDIC formatting of a document is shown. A <var>Print</var> statement display of the default UTF-8 formatting of <var>Serial</var> is a string that is not readily decipherable.
	<p class="code">begin		<p class="code">begin
	%doc is object xmlDoc		%doc is object xmlDoc
Line 83:		Line 84:
	<nowiki><top><a><b>05</b></a><c><d att="val"/></c></top></nowiki>		<nowiki><top><a><b>05</b></a><c><d att="val"/></c></top></nowiki>
	</p>		</p>
	In the following fragment, the <var>Serial</var> method EBCDIC formatting of a document with untranslatable Unicode is shown.		<li>In the following fragment, the <var>Serial</var> method EBCDIC formatting of a document with untranslatable Unicode is shown.
	<p class="code">%doc2:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('circumference', -		<p class="code">%doc2:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('circumference', -
	'2 * &#x3C0; * r':U)		'2 * &#x3C0; * r':U)
Line 91:		Line 92:
	<p class="output"><circumference>2 * &#x03C0; * r</circumference>		<p class="output"><circumference>2 * &#x03C0; * r</circumference>
	</p>		</p>
			</ol>

	==Request-cancellation errors==		==Request-cancellation errors==

JAL2: /* Syntax terms */

2012-02-22T20:56:15Z

Syntax terms

← Older revision		Revision as of 20:56, 22 February 2012
Line 17:		Line 17:
	<ul>		<ul>
	<li><b>CharacterEncodeAll</b><br>		<li><b>CharacterEncodeAll</b><br>
	If the <~~code~~>EBCDIC</~~code~~> option is specified, use character encoding in all contexts (that is, not only in <var>Attribute</var> or <var>Element</var> values) to display Unicode characters that do not translate to EBCDIC. This option is available starting with version 8.0 of the <var class="product">Sirius Mods</var>.		If the <var>EBCDIC</var> option is specified, use character encoding in all contexts (that is, not only in <var>Attribute</var> or <var>Element</var> values) to display Unicode characters that do not translate to EBCDIC. This option is available starting with version 8.0 of the <var class="product">Sirius Mods</var>.
	<li><b>EBCDIC</b>		<li><b>EBCDIC</b>
	<br>Produces serialized output in EBCDIC text rather than the default encoding, UTF-8.		<br>Produces serialized output in EBCDIC text rather than the default encoding, UTF-8.

Dme: /* Examples */

2012-02-02T19:06:01Z

Examples

← Older revision		Revision as of 19:06, 2 February 2012
Line 82:		Line 82:
	<p class="output">Serial method output follows:		<p class="output">Serial method output follows:
	<nowiki><top><a><b>05</b></a><c><d att="val"/></c></top></nowiki>		<nowiki><top><a><b>05</b></a><c><d att="val"/></c></top></nowiki>
			</p>
			In the following fragment, the <var>Serial</var> method EBCDIC formatting of a document with untranslatable Unicode is shown.
			<p class="code">%doc2:[[AddElement_(XmlDoc/XmlNode_function)\|addElement]]('circumference', -
			'2 * &#x3C0; * r':U)
			print %doc2:serial(, 'ebcdic')
			</p>
			The result follows (the Unicode codepoint for the Greek letter π has the hexadecimal value 03C0):
			<p class="output"><circumference>2 * &#x03C0; * r</circumference>
	</p>		</p>

Dme: /* Syntax terms */

2012-02-02T18:50:38Z

Syntax terms

← Older revision		Revision as of 18:50, 2 February 2012
Line 15:		Line 15:
	<tr><th><div id="options"></div>options</th>		<tr><th><div id="options"></div>options</th>
	<td>A blank delimited string that can contain one or more of the following options (but no repeats). <br>'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]].		<td>A blank delimited string that can contain one or more of the following options (but no repeats). <br>'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]].
	<ul>		<ul>
			<li><b>CharacterEncodeAll</b><br>
			If the <code>EBCDIC</code> option is specified, use character encoding in all contexts (that is, not only in <var>Attribute</var> or <var>Element</var> values) to display Unicode characters that do not translate to EBCDIC. This option is available starting with version 8.0 of the <var class="product">Sirius Mods</var>.
	<li><b>EBCDIC</b>		<li><b>EBCDIC</b>
	<br>Produces serialized output in EBCDIC text rather than the default encoding, UTF-8.		<br>Produces serialized output in EBCDIC text rather than the default encoding, UTF-8.

Dme: /* See also */

2012-02-02T18:47:41Z

Dme: /* Syntax terms */

2012-02-02T18:25:58Z

Syntax terms

← Older revision		Revision as of 18:25, 2 February 2012
Line 31:		Line 31:
	<li><b>SortCanonical</b>		<li><b>SortCanonical</b>
	<br>This deprecated option serializes namespace declarations and attributes in sorted order (from lowest to highest with Unicode code ordering). It is superseded by the <var>ExclCanonical</var> option.		<br>This deprecated option serializes namespace declarations and attributes in sorted order (from lowest to highest with Unicode code ordering). It is superseded by the <var>ExclCanonical</var> option.
			<li><b>UTF-8</b>
			<br>Produces serialized output in UTF-8. This is the default.
	<li><b>WithComments</b>		<li><b>WithComments</b>
	<br>Includes in the serialized output all <var>Comment</var> nodes in the specified subtree.		<br>Includes in the serialized output all <var>Comment</var> nodes in the specified subtree.

← Older revision		Revision as of 20:41, 13 March 2014
Line 123:		Line 123:
	==See also==		==See also==
	<ul>		<ul>
	<li>The subroutine that serializes an <var>XmlDoc</var> and sends it as a Web response is <var>[[WebSend (XmlDoc subroutine)\|WebSend]]</var>.		<li>The subroutine that serializes an <var>XmlDoc</var> and sends it as a Web response is <var>[[WebSend (XmlDoc subroutine)\|WebSend]]</var>. </li>

	<li>Additional serializing methods include:		<li>Additional serializing methods include:
	<ul>		<ul>
Line 129:		Line 130:
	<li><var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var>		<li><var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var>
	<li><var>[[AddXml (HttpRequest subroutine)\|AddXml]]</var> (<var>[[HttpRequest class\|HttpRequest]]</var> class)		<li><var>[[AddXml (HttpRequest subroutine)\|AddXml]]</var> (<var>[[HttpRequest class\|HttpRequest]]</var> class)
	</ul>		</ul> </li>
	<li>See the description of [[XmlDoc_API_serialization_options#EBCDIC_serialization_of_untranslatable_Unicode_characters\|Unicode to EBCDIC conversion]] performed by <var>Serial</var> with the <code>EBCDIC</code> option.
	<li>To deserialize a string, use <var>[[LoadXml (XmlDoc/XmlNode function)\|LoadXml]]</var> or <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>.		<li>See the description of [[XmlDoc_API_serialization_options#EBCDIC_serialization_of_untranslatable_Unicode_characters\|Unicode to EBCDIC conversion]] performed by <var>Serial</var> with the <code>EBCDIC</code> option. </li>
	<li>For more information about using XPath expressions, see [[XPath\|~~"XPath"~~]].
			<li>To deserialize a string, use <var>[[LoadXml (XmlDoc/XmlNode function)\|LoadXml]]</var> or <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>. </li>

			<li>For more information about using XPath expressions, see [[XPath]]. </li>

			<li>For additional discussion about serialization, see [[XmlDoc API#Transport: receiving and sending XML\|Transport: receiving and sending XML]].</li>
	</ul>		</ul>
	{{Template:XmlDoc/XmlNode:Serial footer}}		{{Template:XmlDoc/XmlNode:Serial footer}}

← Older revision		Revision as of 18:47, 2 February 2012
Line 99:		Line 99:
	<li><var>[[AddXml (HttpRequest subroutine)\|AddXml]]</var> (<var>[[HttpRequest class\|HttpRequest]]</var> class)		<li><var>[[AddXml (HttpRequest subroutine)\|AddXml]]</var> (<var>[[HttpRequest class\|HttpRequest]]</var> class)
	</ul>		</ul>
			<li>See the description of [[XmlDoc_API_serialization_options#EBCDIC_serialization_of_untranslatable_Unicode_characters\|Unicode to EBCDIC conversion]] performed by <var>Serial</var> with the <code>EBCDIC</code> option.
	<li>To deserialize a string, use <var>[[LoadXml (XmlDoc/XmlNode function)\|LoadXml]]</var> or <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>.		<li>To deserialize a string, use <var>[[LoadXml (XmlDoc/XmlNode function)\|LoadXml]]</var> or <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>.
	<li>For more information about using XPath expressions, see [[XPath\|"XPath"]].		<li>For more information about using XPath expressions, see [[XPath\|"XPath"]].
	</ul>		</ul>
	{{Template:XmlDoc/XmlNode:Serial footer}}		{{Template:XmlDoc/XmlNode:Serial footer}}