WebSend (XmlDoc subroutine) - Revision history

JAL: /* See also */

2014-03-18T21:08:37Z

JAL: /* See also */

2014-03-13T20:46:42Z

JAL: /* Syntax terms */

2014-03-09T18:09:44Z

Syntax terms

← Older revision		Revision as of 18:09, 9 March 2014
Line 11:		Line 11:
	<tr><th>doc</th>		<tr><th>doc</th>
	<td>An expression that points to the <var>XmlDoc</var> whose content is to be serialized. </td></tr>		<td>An expression that points to the <var>XmlDoc</var> 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 (but no duplications) of the following options. <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 (but no duplications) of the following options.
			<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 may also specify <var>CR</var>, <var>LF</var>, <var>CRLF</var>, or <var>Newline</var> (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 may also specify <var>CR</var>, <var>LF</var>, <var>CRLF</var>, or <var>Newline</var> (see below).
	If <var>Indent</var> is specified and no line-end options are also specified, <var>Newline</var> is implied.		If <var>Indent</var> is specified and no line-end options are also specified, <var>Newline</var> is implied. </li>

	<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), <b>CRLF</b> (carriage-return followed by a linefeed), or <b>Newline</b> (line-end set for the <var class="product">Janus Web</var> connection)<br>		<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), <b>CRLF</b> (carriage-return followed by a linefeed), or <b>Newline</b> (line-end set for the <var class="product">Janus Web</var> connection)<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.		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>
	</ul>		</ul>
	</td></tr>		</td></tr>

JAL: /* Request-cancellation errors */

2014-03-03T21:18:19Z

Request-cancellation errors

← Older revision		Revision as of 21:18, 3 March 2014
Line 54:		Line 54:

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

JAL2: /* Syntax terms */

2011-06-22T20:18:16Z

Syntax terms

← Older revision		Revision as of 20:18, 22 June 2011
Line 12:		Line 12:
	<td>An expression that points to the <var>XmlDoc</var> whose content is to be serialized. </td></tr>		<td>An expression that points to the <var>XmlDoc</var> 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 (but no duplications) of the following options:		<td>A blank delimited string that can contain one or more (but no duplications) of the following options. <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>
Line 28:		Line 28:
	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.		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>		</ul>
	~~'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]]~~</td></tr>		</td></tr>
	</table>		</table>

JAL2: /* See also */

2011-06-16T23:11:50Z

JAL2: /* Syntax terms */

2011-06-16T21:50:02Z

Syntax terms

← Older revision		Revision as of 21:50, 16 June 2011
Line 28:		Line 28:
	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.		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>		</ul>
	These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]]</td></tr>		'''Note:''' These options are described in greater detail in [[XmlDoc API serialization options\|"XmlDoc API serialization options"]]</td></tr>
	</table>		</table>

JAL2 at 15:20, 7 June 2011

2011-06-07T15:20:23Z

← Older revision		Revision as of 15:20, 7 June 2011
Line 15:		Line 15:
	<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>
	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 may also specify <~~code~~>CR</~~code~~>, <~~code~~>LF</~~code~~>, <~~code~~>CRLF</~~code~~>, or <~~code~~>Newline</~~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 may also specify <var>CR</var>, <var>LF</var>, <var>CRLF</var>, or <var>Newline</var> (see below).
	If <var>Indent</var> is specified and no line-end options are also specified, <var>Newline</var> is implied.		If <var>Indent</var> is specified and no line-end options are also specified, <var>Newline</var> is implied.
	<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), <b>CRLF</b> (carriage-return followed by a linefeed), or <b>Newline</b> (line-end set for the <var class="product">Janus Web</var> connection)<br>		<li><b>CR</b> (carriage-return), <b>LF</b> (linefeed), <b>CRLF</b> (carriage-return followed by a linefeed), or <b>Newline</b> (line-end set for the <var class="product">Janus Web</var> connection)<br>
Line 33:		Line 33:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The method object <var class="term">doc</var> must be [[XML processing in Janus SOAP#Well-formed documents and validation\|well-formed]] (that is, it must contain an <var>Element</var> node).		<li>The method object, <var class="term">doc</var>, must be [[XML processing in Janus SOAP#Well-formed documents and validation\|well-formed]] (that is, it must contain an <var>Element</var> node).
	<li>The output line-breaking <var class="term">options</var> make the serialized stream easier to read, for example, for a browser's "view page source" facility to display XHTML produced with <var class="product">[[Janus SOAP]]</var>.		<li>The output line-breaking <var class="term">options</var> make the serialized stream easier to read, for example, for a browser's "view page source" facility to display XHTML produced with <var class="product">[[Janus SOAP]]</var>.
	<li>As of <var class="product">Sirius Mods</var> Version 7.6, ''Attribute 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 <var class="product">Sirius Mods</var> 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 <var>Attribute</var> value is serialized as <code>&quot;</code>. Prior to <var class="product">Sirius Mods</var> Version 7.6, this convention was not strictly observed.
	</ul>		</ul>

JAL2 at 01:33, 25 May 2011

2011-05-25T01:33:55Z

← Older revision		Revision as of 01:33, 25 May 2011
Line 1:		Line 1:
	{{Template:XmlDoc:WebSend subtitle}}		{{Template:XmlDoc:WebSend subtitle}}
	<var>WebSend</var> converts an <var>XmlDoc</var> to its textually represented XML document to be sent in a response on a <var class="product">[[Janus Web Server\|"Janus Web Server"]]</var> thread. (The process of converting to a text string is called '''serialization''', because the text representation of a document is called the '''serial'''		<var>WebSend</var> converts an <var>XmlDoc</var> to its textually represented XML document to be sent in a response on a <var class="product">[[Janus Web Server\|Janus Web Server]]</var> thread. The process of converting to a text string is called '''serialization''', because the text representation of a document is called the '''serial'''
	form).		form.

	The serialized output of <var>WebSend</var> is a UTF-8 text string. This output is added to the output buffer that is sent by a subsequent invocation of <var>[[$Web_Done]]</var> or <var>[[$Web_Form_Done]]</var>.		The serialized output of <var>WebSend</var> is a UTF-8 text string. This output is added to the output buffer that is sent by a subsequent invocation of <var>[[$Web_Done]]</var> or <var>[[$Web_Form_Done]]</var>.

	==Syntax==		==Syntax==
Line 33:		Line 33:
	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The method object <var class="term">~~Doc~~</var> must be well-formed (that is, it must contain an <var>Element</var> node)~~. For more information, see [[XML processing in Janus SOAP#Well-formed documents and validation\|"Well-formed documents and validation"]]~~.		<li>The method object <var class="term">doc</var> must be [[XML processing in Janus SOAP#Well-formed documents and validation\|well-formed]] (that is, it must contain an <var>Element</var> node).
	<li>The output line-breaking <var class="term">options</var> make the serialized stream easier to read, for example, for a browser's "view page source" facility to display XHTML produced with <var class="product">[[Janus SOAP~~\|"Janus Soap"~~]]</var>.		<li>The output line-breaking <var class="term">options</var> make the serialized stream easier to read, for example, for a browser's "view page source" facility to display XHTML produced with <var class="product">[[Janus SOAP]]</var>.
	<li>As of <var class="product">[[Sirius Mods]]</var> Version 7.6, ''Attribute 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;~~amp;quot;</code>. Prior to <var class="product">Sirius Mods</var> Version 7.6, this convention was not strictly observed.		<li>As of <var class="product">Sirius Mods</var> Version 7.6, ''Attribute 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 <var class="product">Sirius Mods</var> Version 7.6, this convention was not strictly observed.
	</ul>		</ul>

	==Examples==		==Examples==
	~~<ol><li>~~The following <var class="product">[[Janus Web Server~~\|"Janus Web Server"]]~~</var> program uses <var>[[WebReceive_(XmlDoc_function)\|WebReceive]]</var> to obtain the XML document from the HTTP request, then uses <var>WebSend</var> to buffer some of the received data:		The following <var class="product">Janus Web Server</var> program uses <var>[[WebReceive_(XmlDoc_function)\|WebReceive]]</var> to obtain the XML document from the HTTP request, then uses <var>WebSend</var> to buffer some of the received data:
	<p class="code">begin		<p class="code">begin
	%d object xmlDoc		%d object xmlDoc
	%d = new		%d = new
	%d:~~[[WebReceive_(XmlDoc_function)\|~~webReceive]]		%d:webReceive
	%d2 object xmlDoc		%d2 object xmlDoc
	%d2 = new		%d2 = new
Line 51:		Line 51:
	%d2:webSend		%d2:webSend
	end		end
	</p~~></ol~~>		</p>

	==Request-cancellation errors==		==Request-cancellation errors==
	<ul>		<ul>
	<li><var class="term">~~Doc~~</var> does not contain an <var>Element</var>.		<li>Method object <var class="term">doc</var> 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-24T21:09:54Z

1 revision

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

← Older revision		Revision as of 21:08, 18 March 2014
Line 76:		Line 76:
	<li>Additional serializing methods include:		<li>Additional serializing methods include:
	<ul>		<ul>
	<li><var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var>		<li><var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var> </li>
	<li><var>[[AddXml (HttpRequest subroutine)\|AddXml]]</var> (<var>[[HttpRequest class\|HttpRequest]]</var> class)
			<li><var>[[Audit (XmlDoc/XmlNode subroutine)\|Audit]]</var>, <var>[[Trace (XmlDoc/XmlNode subroutine)\|Trace]]</var> </li>

			<li><var>[[AddXml (HttpRequest subroutine)\|AddXml]]</var> (<var>[[HttpRequest class\|HttpRequest]]</var> class) </li>
	</ul> </li>		</ul> </li>

← Older revision		Revision as of 20:46, 13 March 2014
Line 72:		Line 72:
	==See also==		==See also==
	<ul>		<ul>
	<li>Use the <var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> function to serialize an <var>XmlDoc</var> for sending in some other fashion than as a Web response.		<li>Use the <var>[[Serial (XmlDoc/XmlNode function)\|Serial]]</var> function to serialize an <var>XmlDoc</var> for sending in some other fashion than as a Web response. </li>

	<li>Additional serializing methods include:		<li>Additional serializing methods include:
	<ul>		<ul>
	<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>The function that receives and deserializes a Web XML request is <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>.
			<li>For additional discussion about serialization, see [[XmlDoc API#Transport: receiving and sending XML\|Transport: receiving and sending XML]].</li>

			<li>The function that receives and deserializes a Web XML request is <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>. </li>
	</ul>		</ul>
	{{Template:XmlDoc:WebSend footer}}		{{Template:XmlDoc:WebSend footer}}

← Older revision		Revision as of 23:11, 16 June 2011
Line 66:		Line 66:
	<ul>		<ul>
	<li><var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var>		<li><var>[[Print (XmlDoc/XmlNode subroutine)\|Print]]</var>
	<li><var>[[AddXml]]</var> (<var>[[HttpRequest]]</var> class)		<li><var>[[AddXml (HttpRequest subroutine)\|AddXml]]</var> (<var>[[HttpRequest class\|HttpRequest]]</var> class)
	</ul>		</ul>
	<li>The function that receives and deserializes a Web XML request is <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>.		<li>The function that receives and deserializes a Web XML request is <var>[[WebReceive (XmlDoc function)\|WebReceive]]</var>.
	</ul>		</ul>
	{{Template:XmlDoc:WebSend footer}}		{{Template:XmlDoc:WebSend footer}}