Check-in [1f1af1e51b]
Not logged in

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:Documentation for chagnes dealing with attributes.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1:1f1af1e51b0d14a32b8465ffa2ef2e784ecde937
User & Date: gerald 2013-04-10 02:34:13
Context
2013-04-10 02:38
Added details for special namespace attributes. check-in: f77791f44f user: gerald tags: trunk
2013-04-10 02:34
Documentation for chagnes dealing with attributes. check-in: 1f1af1e51b user: gerald tags: trunk
2013-04-10 02:14
Corrections toXML -> Dictionary conversion for new changes. check-in: 0b5d3f4ece user: gerald tags: trunk
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to docs/Calling_a_Web_Service.html.

333
334
335
336
337
338
339
340
341

342
343
344
345
346
347
348
349
350
351
352
353
354
<li>contentType -- default is "text/xml;charset=utf-8"</li>
<li>location -- The URL of the service, derived from the WSDL.</li>
<li>skipHeaderLevel -- boolean indicating the first level of the XML in a request header <i><b>shall be</b></i> skipped.  Derived from options.  Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
<li>skipLevelOnReply -- boolean indicating the first level of the XML in a reply <i><b>may be</b></i> skipped.  Derived from options.  Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
<li>skipLevelWhenActionPresent -- boolean indicating if the first level of the XML is to be skipped.  Derived from options.  Default is 0 (do not skip).</li>
<li>suppressTargetNS -- boolean indicating if target namespace is not to be added to XML.  Derived from options.  Default is 0 (do not suppress). </li>
<li>targetNamespace -- the target namespace of the service, derived from the WSDL.</li>
<li>parseInAttr - parse attributes on inbound tags</li>
<li>genOutAttr - generate attributes on outbound tags</li>

<li>useTypeNs - use type's namespace prefix as prefix of elements</li>
<li>nsOnChangeOnly - only put namespace prefix when namespaces change</li>
<li>suppressNS - do not put a particular namespace prefix</li>
</ul>
     <i>value</i>         - Optional, the new value.
</pre>
<p><b>Returns&nbsp;:</b> </p><pre>     The value of the item.
<p><b>Side-Effects&nbsp;: None</b> </p>
<p><b>Exception Conditions&nbsp;&nbsp;: None</b> </p>
<p><b>Pre-requisite Conditions&nbsp;: Service must have been defined.</b> </p></pre><p></p>
</div>
</BODY>
</HTML>







|
|
>













333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
<li>contentType -- default is "text/xml;charset=utf-8"</li>
<li>location -- The URL of the service, derived from the WSDL.</li>
<li>skipHeaderLevel -- boolean indicating the first level of the XML in a request header <i><b>shall be</b></i> skipped.  Derived from options.  Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
<li>skipLevelOnReply -- boolean indicating the first level of the XML in a reply <i><b>may be</b></i> skipped.  Derived from options.  Default is 0 (do not skip). <i>(Introduced in 2.2.8)</i></li>
<li>skipLevelWhenActionPresent -- boolean indicating if the first level of the XML is to be skipped.  Derived from options.  Default is 0 (do not skip).</li>
<li>suppressTargetNS -- boolean indicating if target namespace is not to be added to XML.  Derived from options.  Default is 0 (do not suppress). </li>
<li>targetNamespace -- the target namespace of the service, derived from the WSDL.</li>
<li>parseInAttr - parse attributes on inbound tags, see <A HREF="Using_Options.html#parseInAttr">here</A> for details</li>
<li>genOutAttr - generate attributes on outbound tags, see <A HREF="Using_Options.html#genOutAttr">here</A> for details</li>
<li>valueAttrCompatiblityMode - If this and genOutAttr/parseInAttr are set, then values are specified in the dictionary as {}.  Otherwise if genOutAttr/parseInAttr is set this is not set, then the values are specified in the dictionary as ::value.</li>
<li>useTypeNs - use type's namespace prefix as prefix of elements</li>
<li>nsOnChangeOnly - only put namespace prefix when namespaces change</li>
<li>suppressNS - do not put a particular namespace prefix</li>
</ul>
     <i>value</i>         - Optional, the new value.
</pre>
<p><b>Returns&nbsp;:</b> </p><pre>     The value of the item.
<p><b>Side-Effects&nbsp;: None</b> </p>
<p><b>Exception Conditions&nbsp;&nbsp;: None</b> </p>
<p><b>Pre-requisite Conditions&nbsp;: Service must have been defined.</b> </p></pre><p></p>
</div>
</BODY>
</HTML>

Changes to docs/Using_Options.html.

101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
...
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
...
149
150
151
152
153
154
155












156

157
158
159
160
161
162
163

<A name=parseInAttr></A>
<H2>parseInAttr - parse attributes on inbound tags </H2>
<P>
    The <I>parseInAttr</I> option, if set to a "true" value,
    will convert all attributes of inbound field tags to dictionary entries for that tag.
    The key will be the attribute name and the value will be the value of the attribute.
    The value of the tag will have an key of the null string (i.e. <B>{}</B>).
</P>
<P>
    The default value, "0", is for this option to be turned off.
</P>
<HR>

 <p><a name="useTypeNs"></a>
................................................................................
</p>
<hr>

<p><a name="suppressNS"></a>
</p><h2>suppressNS - do not put a given namespace prefix. </h2>
<p>
    The <i>suppressNS</i> option, if set, will cause the given namespace
 to never be used as a prefix (i.e. tags that would normally have had 
the given prefix will not have any prefix).
</p>
<p>
    The default value, "{}", is for this option to be turned off.
</p>
<hr>

................................................................................
<A name=genOutAttr></A>
<H2>genOutAttr - generate attributes on outbound tags </H2>
<P>
    The <I>genOutAttr</I> option, if set to a "true" value,
    will convert all dictionary keys of the entry for a given field tag to attribute value pairs
    of the tag in the outbound XML.
    The key will be the attribute name and the value will be the value of the attribute.












    The value of the tag will have a key of the null string (i.e. <B>{}</B>).

</P>
<P>
    The default value, "0", is for this option to be turned off.
</P>
<HR>

<p><a name="includeDirectory"></a>







|







 







|







 







>
>
>
>
>
>
>
>
>
>
>
>
|
>







101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
...
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
...
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

<A name=parseInAttr></A>
<H2>parseInAttr - parse attributes on inbound tags </H2>
<P>
    The <I>parseInAttr</I> option, if set to a "true" value,
    will convert all attributes of inbound field tags to dictionary entries for that tag.
    The key will be the attribute name and the value will be the value of the attribute.
    The value of the tag will have a key determined by the <a href="#valueAttrCompatiblityMode"><I>valueAttrCompatiblityMode</I></a>.
</P>
<P>
    The default value, "0", is for this option to be turned off.
</P>
<HR>

 <p><a name="useTypeNs"></a>
................................................................................
</p>
<hr>

<p><a name="suppressNS"></a>
</p><h2>suppressNS - do not put a given namespace prefix. </h2>
<p>
    The <i>suppressNS</i> option, if set, will cause the given namespace
 to never be used as a prefix (i.e. tags that would normally have had
the given prefix will not have any prefix).
</p>
<p>
    The default value, "{}", is for this option to be turned off.
</p>
<hr>

................................................................................
<A name=genOutAttr></A>
<H2>genOutAttr - generate attributes on outbound tags </H2>
<P>
    The <I>genOutAttr</I> option, if set to a "true" value,
    will convert all dictionary keys of the entry for a given field tag to attribute value pairs
    of the tag in the outbound XML.
    The key will be the attribute name and the value will be the value of the attribute.
    The value of the tag will have a key determined by the <a href="#valueAttrCompatiblityMode"><I>valueAttrCompatiblityMode</I></a>.
</P>
<P>
    The default value, "0", is for this option to be turned off.
</P>
<HR>

<A name=valueAttrCompatiblityMode></A>
<H2>valueAttrCompatiblityMode - specify dictionary key for value when attributes are in use</H2>
<P>
    This option is only meaningful when the
    <i>parseInAttr</i> or <I>genOutAttr</I> option is set to a "true" value.
    When set to a "true" value, the value of the tag will have a key of the null string (i.e. <B>{}</B>).
    When set to a "false" value, the value of the tag will have a key of <B>::value</B>.
</P>
<P>
    The default value, "0", is for this option to be turned off.
</P>
<HR>

<p><a name="includeDirectory"></a>