$Web Sels: Difference between revisions

Latest revision as of 21:50, 5 June 2013

Build select options from delimited list of strings, selected is string

$Web_Sels inserts into the Web output stream the options list of an HTML <select> element. The options list is taken from two arguments which are delimited lists of strings, and the selected option (that is, the one that is highlighted on the HTML page) is specified by a character string. An overview of the $Web_Sel* functions is provided in $Web_Selp.

$Web_Sels takes four arguments and always returns null, unless an error occurs, in which case the current User Language request is cancelled. It is a callable $function.

Syntax

%rc = $Web_Sels(delimited_vals, [delimited_descrs], [selected_value], [option_keywords])

Syntax terms

delimited_vals A string containing a delimited list of strings which are the values for the options list. The first character of this argument is the delimiter that separates the values. The string should not contain a trailing delimiter unless you want the null string as the final value, which is unlikely. This is a required argument.

delimited_descrs

A string containing a delimited list of strings which are the descriptions for the options list. The first character of this argument is the delimiter that separates the descriptions. The string should not contain a trailing delimiter unless you want the null string as the final description, which is unlikely.

This is an optional argument; if omitted, the description of each generated option is identical to its value.

selected_value

A string which, if equal to one of the values in the options list, specifies the item which is selected in the displayed options list; this does not allow multiple item selection in a <select multiple> element.

This an optional argument. If this argument is omitted, or if the string is not equal to the value of any of the options in the global select element, then none of the <option> elements in the list contain the selected attribute.

As explained in $Web_Selp, the default selected option depends on the type of <select> element: <select multiple> has no default; for non-multiple, the first item in the options list is the default selected element.

option_keywords

This optional argument is a string of blank-separated keywords specifying special processing for this $function; it can contain any of the following:

NOENDSEL	Don't end list of options with `</select>`
NOENDS	Synonym for NOENDSEL
ENDOPT	End each option with `</option>`

Return codes

Code	Meaning
null	The operation completed successfully.
	Any error results in cancellation of the `User Language` request.

Examples

The following statement places a <select> element into the web response output, containing the Italian days of the week; the middle day of the week is selected:
%RC = $Web_Sels('/Domenica/Lunedi/Martedi' WITH - '/Mercoledi/Giovedi/Venerdi/Sabato', - '/DN0/DN1/DN2/DN3/DN4/DN5/DN6', 'DN3')
See $Web_Selp for an extended example using other $Web_Sel* functions.

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:$Web_Sels}}
-<span class="pageSubtitle"><section begin="desc" />Build select options from delimited list of strings, selected is string<section end="desc" /></span>
+<span class="pageSubtitle">Build select options from delimited list of strings, selected is string</span>
+<var>$Web_Sels</var> inserts into the Web output stream the options list of an HTML <code><select></code> element. The options list is taken from two arguments which are delimited lists of strings, and the selected option (that is, the one that is highlighted on the HTML page) is specified by a character string. An overview of the $Web_Sel* functions is provided in <var>[[$Web_Selp]]</var>.
-$Web_Sels inserts into the Web output stream the options list of an HTML<select> element. The options list is taken from two arguments which are delimited lists of strings, and the selected option (that is, the one that is highlighted on the HTML page) is specified by a character string. An overview of the $WEB_SEL_x functions is provided in [[$Web_Selp]].
+<var>$Web_Sels</var> takes four arguments and always returns null, unless an error occurs, in which case the current <var class="product">User Language</var> request is cancelled. It is a [[Calling_Sirius_Mods_$functions|callable]] $function.
-$Web_Sels takes four arguments and always returns null, unless an error occurs, in which case the current <var class="product">User Language</var> request is cancelled. It is a callable $function (see [[Calling_Sirius_Mods_$functions|Calling Sirius Mods $functions]]).
 ==Syntax==
-<p class="syntax"><section begin="syntax" /> %RC = $Web_Sels(delimited_vals, delimited_descrs, -
+<p class="syntax"><span class="term">%rc</span> = <span class="literal">$Web_Sels</span>(<span class="term">delimited_vals</span>, [<span class="term">delimited_descrs</span>], [<span class="term">selected_value</span>], [<span class="term">option_keywords</span>])
- selected_value, option_keywords)
+</p>
-<section end="syntax" /></p>
+===Syntax terms===
 <table class="syntaxTable">
 <tr><th>delimited_vals</th>
+<td>A string containing a delimited list of strings which are the values for the options list. The first character of this argument is the delimiter that separates the values. The string should not contain a trailing delimiter unless you want the null string as the final value, which is unlikely. This is a required argument.</td></tr>
-<td>A string containing a delimited list of strings which are the values for the options list. The first character of this argument is the delimiter that separates the values. The string should not contain a trailing delimiter unless you want the null string as the final value, which is unlikely. This is a required argument.</td></tr>
 <tr><th>delimited_descrs</th>
+<td>A string containing a delimited list of strings which are the descriptions for the options list. The first character of this argument is the delimiter that separates the descriptions. The string should not contain a trailing delimiter unless you want the null string as the final description, which is unlikely.
+<p>
+This is an optional argument; if omitted, the description of each generated option is identical to its value.</p></td></tr>
-<td>A string containing a delimited list of strings which are the descriptions for the options list. The first character of this argument is the delimiter that separates the descriptions. The string should not contain a trailing delimiter unless you want the null string as the final description, which is unlikely. This is an optional argument; if omitted, the description of each generated option is identical to its value.</td></tr>
 <tr><th>selected_value</th>
+<td>A string which, if equal to one of the values in the options list, specifies the item which is selected in the displayed options list; this does not allow multiple item selection in a <code><select multiple></code> element.
+<p>
+This an optional argument. If this argument is omitted, or if the string is not equal to the value of any of the options in the global select element, then none of the <code><option></code> elements in the list contain the '''selected''' attribute.</p>
+<p>As explained in <var>[[$Web_Selp]]</var>, the default selected option depends on the type of <code><select></code> element: <code><select multiple></code> has no default; for non-multiple, the first item in the options list is the default selected element.</p></td></tr>
-<td>A string which, if equal to one of the values in the options list, specifies the item which is selected in the displayed options list; this does not allow multiple item selection in a <select&thinsp.multiple> element. This an optional argument. If this argument is omitted, or if the string is not equal to the value of any of the options in the global select element, then none of the <option> elements in the list contain the '''selected''' attribute. As explained in [[$Web_Selp]], the default selected option depends on the type of <select> element: <select&thinsp.multiple> has no default; for non-multiple, the first item in the options list is the default selected element.</td></tr>
 <tr><th>option_keywords</th>
+<td>This optional argument is a string of blank-separated keywords specifying special processing for this $function; it can contain any of the following:
 <table class="syntaxTable">
-<td>A string of blank-separated keywords specifying special processing for this $function; it can contain any of the following:</td></tr>
 <tr><th>NOENDSEL</th>
-<td>Don't end list of options with </select></td></tr>
+<td>Don't end list of options with <code></select></code></td></tr>
 <tr><th>NOENDS</th>
 <td>Synonym for NOENDSEL</td></tr>
 <tr><th>ENDOPT</th>
-<td>End each option with </option>
+<td>End each option with <code></option></code>
 </td></tr></table>
-This an optional argument.
 </td></tr></table>
+===Return codes===
 <table class="syntaxTable">
 <tr><th>Code</th>
-<td>Meaning</td></tr>
+<th>Meaning</th></tr>
 <tr><th>null</th>
 <td>The operation completed successfully.</td></tr>
 <tr><th></th>
 <td>Any error results in cancellation of the <var class="product">User Language</var> request.</td></tr>
 </table>
-<p class="caption">$WEB_SELS return values</p>
-For example, the following statement places a <select> element into the web response output, containing the Italian days of the week; the middle day of the week is selected:
+==Examples==
+<ol>
+<li>The following statement places a <code><select></code> element into the web response output, containing the Italian days of the week; the middle day of the week is selected:
 <p class="code"> %RC = $Web_Sels('/Domenica/Lunedi/Martedi' WITH -
   '/Mercoledi/Giovedi/Venerdi/Sabato', -
   '/DN0/DN1/DN2/DN3/DN4/DN5/DN6', 'DN3')
 </p>
+<li>See [[$Web_Selp]] for an extended example using other $Web_Sel* functions.
+</ol>
-See [[$Web_Selp]] for an extended example using other $WEB_SELx functions.
 [[Category:Janus Web Server $functions|$Web_Sels]]