Xml (XmlDoc function) - Revision history

JAL: /* See also */

2014-03-09T18:06:13Z

JAL: /* Syntax terms */

2014-03-09T18:04:47Z

Syntax terms

← Older revision		Revision as of 18:04, 9 March 2014
Line 8:		Line 8:
	<tr><th>%string</th>		<tr><th>%string</th>
	<td>The string serialization of the <var>XmlDoc</var>, encoded in UTF-8.</td></tr>		<td>The string serialization of the <var>XmlDoc</var>, encoded in UTF-8.</td></tr>

	<tr><th>doc</th>		<tr><th>doc</th>
	<td><var>XmlDoc</var> expression, whose content is to be serialized.</td></tr>		<td><var>XmlDoc</var> expression, whose content is to be serialized.</td></tr>

	<tr><th>options</th>		<tr><th>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>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>		<li><b>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>
	Whether or not 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, and if the <var>XmlDoc</var> is not empty. <var>AllowXmlDecl</var> is the default.		Whether or not 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, and if the <var>XmlDoc</var> is not empty. <var>AllowXmlDecl</var> is the default. </li>

	<li><b>Indent <i>n</i></b><br>		<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).		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)<br>		<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 options to provide line breaks in the serialized output.		Inserts one of these line-end options to provide line breaks in the serialized output. </li>

	<li><b>NoEmptyElt</b><br>		<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>).		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><br>		<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.		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><br>		<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>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> method <var>ExclCanonical</var> option. </li>
	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>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> method <var>ExclCanonical</var> option.
	</ul></td></tr>		</ul></td></tr>
	</table>		</table>

JAL: /* Request-cancellation errors */

2014-03-03T21:19:44Z

Request-cancellation errors

← Older revision		Revision as of 21:19, 3 March 2014
Line 67:		Line 67:

	==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">doc</var> object does not contain an <var>Element</var>.		<li><var class="term">doc</var> object does not contain an <var>Element</var>.

JAL2: /* Syntax terms */

2011-06-22T20:19:59Z

Syntax terms

← Older revision		Revision as of 20:19, 22 June 2011
Line 11:		Line 11:
	<td><var>XmlDoc</var> expression, whose content is to be serialized.</td></tr>		<td><var>XmlDoc</var> expression, whose content is to be serialized.</td></tr>
	<tr><th>options</th>		<tr><th>options</th>
	<td>A blank delimited string that can contain one or more of the following options (but no repeats)~~, which~~ are ~~identified below and~~ 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>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>		<li><b>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>

Dme at 22:22, 21 June 2011

2011-06-21T22:22:58Z

← Older revision		Revision as of 22:22, 21 June 2011
Line 46:		Line 46:
	==Examples==		==Examples==
	<ol>		<ol>
	<li>The <var>[[AddXml]]</var> method of the <var>[[HttpRequest]]</var> class has nearly the same options as the <var>Xml</var> function. The following fragment serializes an <var>XmlDoc</var> and sends it as a request to a web server.		<li>The <var>[[AddXml (HttpRequest subroutine)\|AddXml]]</var> method of the <var>[[HttpRequest class\|HTtpRequest]]</var> class has nearly the same options as the <var>Xml</var> function. The following fragment serializes an <var>XmlDoc</var> and sends it as a request to a web server.
	<p>Note that if you use the <var>Xml</var> function and <var>[[$Sock_Send]]</var> directly, instead of using an <var>[[HTTP Helper]]</var> object, always use the <var>BINARY</var> option of <var>$Sock_Send</var>, because the result of the <var>Xml</var> function is UTF-8, rather than EBCDIC.</p>		<p>Note that if you use the <var>Xml</var> function and <var>[[$Sock_Send]]</var> directly, instead of using an <var>[[HTTP Helper]]</var> object, always use the <var>BINARY</var> option of <var>$Sock_Send</var>, because the result of the <var>Xml</var> function is UTF-8, rather than EBCDIC.</p>
	<p class="code"> %httpreq object httpRequest		<p class="code"> %httpreq object httpRequest
Line 56:		Line 56:
	<dateRange/></inquire>', 'NoEmptyElt')		<dateRange/></inquire>', 'NoEmptyElt')

	%httpreq:[[URL]] = 'foo.com/bar'		%httpreq:[[URL (HttpRequest property)\|URL]] = 'foo.com/bar'
	%httpreq:[[addXml]](%doc)		%httpreq:[[AddXml (HttpRequest subroutine)\|addXml]](%doc)
	%httpresp = %httpreq:[[post]]('HTTP_CLIENT')		%httpresp = %httpreq:[[Post (HttpRequest function)\|post]]('HTTP_CLIENT')
	</p>		</p>
	<li>The following fragment is a simple example for serializing an <var>XmlDoc</var>, which could then, for example, be sent on a transport such as MQ:		<li>The following fragment is a simple example for serializing an <var>XmlDoc</var>, which could then, for example, be sent on a transport such as MQ:

JAL2 at 16:03, 7 June 2011

2011-06-07T16:03:43Z

← Older revision		Revision as of 16:03, 7 June 2011
Line 14:		Line 14:
	<ul>		<ul>
	<li><b>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>		<li><b>AllowXmlDecl</b> or <b>NoXmlDecl</b><br>
	Whether or not 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 node selected by <var class="term">xpath</var> is the <var>Root</var> node~~. <var>AllowXmlDecl</var> is the default.		Whether or not 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, and if the <var>XmlDoc</var> is not empty. <var>AllowXmlDecl</var> is the default.

	<li><b>Indent <i>n</i></b><br>		<li><b>Indent <i>n</i></b><br>
Line 30:		Line 30:
	<li><b>SortCanonical</b><br>		<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>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> method <var ~~class="term"~~>ExclCanonical</var> option.		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>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> method <var>ExclCanonical</var> option.
	</ul></td></tr>		</ul></td></tr>
	</table>		</table>
Line 41:		Line 41:
	<li>You can use the <var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var> method to display a document on the terminal, or to ''capture'' a displayable version of a document, but <var>Print</var> is		<li>You can use the <var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var> method to display a document on the terminal, or to ''capture'' a displayable version of a document, but <var>Print</var> is
	used to insert line breaks and optional indentation, which may not be an accurate serialization of an <var>XmlDoc</var>.		used to insert line breaks and optional indentation, which may not be an accurate serialization of an <var>XmlDoc</var>.
	<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.6, <var>Attribute</var> values are always serialized within double-quotation-mark (<~~code~~>"</~~code~~>) delimiters, and a double-quotation mark character in an attribute value is serialized as <code>&~~amp;amp;~~amp;quot;</code>. Prior to Version 7.6, this convention was not strictly observed.		<li>As of <var class="product">Sirius Mods</var> Version 7.6, <var>Attribute</var> values are always serialized within double-quotation-mark (<tt>"</tt>) delimiters, and a double-quotation mark character in an attribute value is serialized as <code>&quot;</code>. Prior to Version 7.6, this convention was not strictly observed.
	</ul>		</ul>

Line 68:		Line 68:
	==Request-cancellation errors==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">~~XmlDoc~~</var> does not contain an <var>Element</var>.		<li><var class="term">doc</var> object does not contain an <var>Element</var>.
	<li>An <var class="term">options</var> setting is invalid.		<li>An <var class="term">options</var> setting is invalid.
	<li>Insufficient free space exists in CCATEMP.		<li>Insufficient free space exists in CCATEMP.

JALWiccan: 1 revision

2011-05-24T17:27:03Z

1 revision

← Older revision	Revision as of 17:27, 24 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-24T17:27:01Z

1 revision

← Older revision		Revision as of 17:27, 24 May 2011
Line 41:		Line 41:
	<li>You can use the <var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var> method to display a document on the terminal, or to ''capture'' a displayable version of a document, but <var>Print</var> is		<li>You can use the <var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var> method to display a document on the terminal, or to ''capture'' a displayable version of a document, but <var>Print</var> is
	used to insert line breaks and optional indentation, which may not be an accurate serialization of an <var>XmlDoc</var>.		used to insert line breaks and optional indentation, which may not be an accurate serialization of an <var>XmlDoc</var>.
	<li>As of <var class="product">[[Sirius Mods~~\|"Sirius Mods"~~]]</var> Version 7.6, <var>Attribute</var> values are always serialized within double-quotation-mark (<code>"</code>) delimiters, and a double-quotation mark character in an attribute value is serialized as <code>&amp;quot;</code>. Prior to Version 7.6, this convention was not strictly observed.		<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.6, <var>Attribute</var> values are always serialized within double-quotation-mark (<code>"</code>) delimiters, and a double-quotation mark character in an attribute value is serialized as <code>&amp;amp;quot;</code>. Prior to Version 7.6, this convention was not strictly observed.
	</ul>		</ul>

JALWiccan: 1 revision

2011-05-24T17:26:02Z

1 revision

← Older revision	Revision as of 17:26, 24 May 2011
(No difference)

Goff: move footer template to actual end; edits, tags and links

2011-05-24T17:26:00Z

move footer template to actual end; edits, tags and links

← Older revision		Revision as of 17:26, 24 May 2011
Line 23:		Line 23:

	<li><b>NoEmptyElt</b><br>		<li><b>NoEmptyElt</b><br>
	Deprecated as of <var class="product">[[Sirius Mods~~\|"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>).		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>).

	<li><b>OmitNullElement</b><br>		<li><b>OmitNullElement</b><br>
Line 41:		Line 41:
	<li>You can use the <var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var> method to display a document on the terminal, or to ''capture'' a displayable version of a document, but <var>Print</var> is		<li>You can use the <var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var> method to display a document on the terminal, or to ''capture'' a displayable version of a document, but <var>Print</var> is
	used to insert line breaks and optional indentation, which may not be an accurate serialization of an <var>XmlDoc</var>.		used to insert line breaks and optional indentation, which may not be an accurate serialization of an <var>XmlDoc</var>.
	<li>As of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6, <var>Attribute</var> values are always serialized within double-quotation-mark (<code>"</code>) delimiters, and a double-quotation mark character in an attribute value is serialized as <code>&quot;</code>. Prior to Version 7.6, this convention was not strictly observed.		<li>As of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.6, <var>Attribute</var> values are always serialized within double-quotation-mark (<code>"</code>) delimiters, and a double-quotation mark character in an attribute value is serialized as <code>&amp;quot;</code>. Prior to Version 7.6, this convention was not strictly observed.
	</ul>		</ul>

← Older revision		Revision as of 18:06, 9 March 2014
Line 80:		Line 80:
	==See also==		==See also==
	<ul>		<ul>
	<li>Use <var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var> to display an XML document for debugging.		<li>Use <var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var> to display an XML document for debugging. </li>
	<li>Use <var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> with the EBCDIC option to obtain an EBCDIC serialization of an XML document.
	<li>Use <var>[[WebSend (XmlDoc subroutine)\|WebSend]]</var> to serialize an <var>XmlDoc</var> and send it as an HTTP response using <var class="product">[[Janus Web Server~~\|"Janus Web Server"~~]]</var>.		<li>Use <var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> with the EBCDIC option to obtain an EBCDIC serialization of an XML document. </li>
	<li>The string deserialization functions are <var>[[LoadXml (XmlDoc/XmlNode function)\|LoadXml]]</var> and <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>.
			<li>Use <var>[[WebSend (XmlDoc subroutine)\|WebSend]]</var> to serialize an <var>XmlDoc</var> and send it as an HTTP response using <var class="product">[[Janus Web Server]]</var>. </li>

			<li>The string deserialization functions are <var>[[LoadXml (XmlDoc/XmlNode function)\|LoadXml]]</var> and <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>. </li>
	</ul>		</ul>

	{{Template:XmlDoc:Xml footer}}		{{Template:XmlDoc:Xml footer}}