$Web Selps: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
mNo edit summary
Line 2: Line 2:
<span class="pageSubtitle"><section begin="desc" />Build select options from delimited list of strings, selected from parameters<section end="desc" /></span>
<span class="pageSubtitle"><section begin="desc" />Build select options from delimited list of strings, selected from parameters<section end="desc" /></span>


$Web_Selps 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 options (that is, the ones that are highlighted on the HTML page) are identified by values of a form and/or isindex parameter in the current web request. An overview of the $WEB_SEL_x functions is provided in [[$Web_Selp]].  
<var>$Web_Selps</var> 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 options (that is, the ones that are highlighted on the HTML page) are identified by values of a form and/or isindex parameter in the current web request. An overview of the $Web_Sel_xxx functions is provided in <var>[[$Web_Selp]]</var>.  


$Web_Selps 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]]).
<var>$Web_Selps</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.


==Syntax==
==Syntax==
<p class="syntax"><section begin="syntax" /> %RC = $Web_Selps(delimited_vals, delimited_descrs, -
<p class="syntax"><section begin="syntax" />%rc = $Web_Selps(delimited_vals, delimited_descrs, param_name, [option_keywords])
param_name, option_keywords)
<section end="syntax" /></p>
<section end="syntax" /></p>


Line 19: Line 18:
<td>The name of a form and/or an index parameter in the current web request. For each occurrence of this parameter, if it has a value which is equal to the value of an item in the options list, that option element is selected in the displayed options list; this allows multiple items to be selected, which is useful for <select&thinsp.multiple> elements. This an optional argument. If this argument is omitted, or if no occurrences of the parameter are equal to any of the values, 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>
<td>The name of a form and/or an index parameter in the current web request. For each occurrence of this parameter, if it has a value which is equal to the value of an item in the options list, that option element is selected in the displayed options list; this allows multiple items to be selected, which is useful for <select&thinsp.multiple> elements. This an optional argument. If this argument is omitted, or if no occurrences of the parameter are equal to any of the values, 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>
<tr><th>option_keywords</th>
<td>A string of blank-separated keywords specifying special processing for this $function; it can contain any of the following:
<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">
<table class="syntaxTable">
<tr><th>NOFORM</th>
<tr><th>NOFORM</th>
Line 34: Line 33:
<td>End each option with </option>
<td>End each option with </option>
</td></tr></table>
</td></tr></table>
This an optional argument.
</td></tr></table>
</td></tr></table>


===Return codes===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>Code</th>
<tr><th>Code</th>
<td>Meaning</td></tr>
<th>Meaning</th></tr>
<tr><th>null</th>
<tr><th>null</th>
<td>The operation completed successfully.</td></tr>
<td>The operation completed successfully.</td></tr>
Line 45: Line 44:
<td>Any error results in cancellation of the <var class="product">User Language</var> request.</td></tr>
<td>Any error results in cancellation of the <var class="product">User Language</var> request.</td></tr>
</table>
</table>
<p class="caption">$WEB_SELPS return values</p>


For example, the following statement places a <select> element, which contains the Italian days of the week, into the web response output. The current value of the DN form parameter determines which of these days is selected:
==Examples==
The following statement places a <select> element, which contains the Italian days of the week, into the web response output. The current value of the DN form parameter determines which of these days is selected:


<p class="code"> %RC = $Web_Selps('/Domenica/Lunedi/Martedi' WITH -
<p class="code">%rc = $Web_Selps('/Domenica/Lunedi/Martedi' WITH -
      '/Mercoledi/Giovedi/Venerdi/Sabato', -
    '/Mercoledi/Giovedi/Venerdi/Sabato', -
      '/DN0/DN1/DN2/DN3/DN4/DN5/DN6', 'DN')
    '/DN0/DN1/DN2/DN3/DN4/DN5/DN6', 'DN')
</p>
</p>


See [[$Web_Selp]] for an extended example using other $WEB_SELx functions.  
==Usage notes==
 
<ul>
$Web_Selps and $Web_Selsp are synonyms.
<li>See [[$Web_Selp]] for an extended example using other $Web_Sel_xxx functions.  
<li><var>$Web_Selps</var> and <var>$Web_Selsp</var> are synonyms.
</ul>


[[Category:Janus Web Server $functions|$Web_Selps]]
[[Category:Janus Web Server $functions|$Web_Selps]]

Revision as of 16:24, 15 June 2012

<section begin="desc" />Build select options from delimited list of strings, selected from parameters<section end="desc" />

$Web_Selps 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 options (that is, the ones that are highlighted on the HTML page) are identified by values of a form and/or isindex parameter in the current web request. An overview of the $Web_Sel_xxx functions is provided in $Web_Selp.

$Web_Selps 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

<section begin="syntax" />%rc = $Web_Selps(delimited_vals, delimited_descrs, param_name, [option_keywords]) <section end="syntax" />

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.
param_name The name of a form and/or an index parameter in the current web request. For each occurrence of this parameter, if it has a value which is equal to the value of an item in the options list, that option element is selected in the displayed options list; this allows multiple items to be selected, which is useful for <select&thinsp.multiple> elements. This an optional argument. If this argument is omitted, or if no occurrences of the parameter are equal to any of the values, 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.
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:
NOFORM Don't look in form parameters
NOISINDEX Don't look in isindex parameters
NOISI Synonym for NOISINDEX
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, which contains the Italian days of the week, into the web response output. The current value of the DN form parameter determines which of these days is selected:

%rc = $Web_Selps('/Domenica/Lunedi/Martedi' WITH - '/Mercoledi/Giovedi/Venerdi/Sabato', - '/DN0/DN1/DN2/DN3/DN4/DN5/DN6', 'DN')

Usage notes

  • See $Web_Selp for an extended example using other $Web_Sel_xxx functions.
  • $Web_Selps and $Web_Selsp are synonyms.