Subversion Repositories wimsdev

Compare Revisions

Ignore whitespace Rev 11209 → Rev 11210

/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/formcheckbox.phtml
1,62 → 1,48
!! +exec+ +html+
$lst_tit formcheckbox$lst_titend
tit:formcheckbox$lst_titend
type:$type_exec
alias:!htmlcheckbox
syntax:formcheckbox `name' from `n1' to `n2' prompt `promptlist'\
$!formcheckbox `name' list `selectlist' prompt `promptlist'
 
<div>$type_exec</div>
mean:Creates a checkbox list menu under a previously defined html form. <br/>\
This command speeds up the creation of checkboxed menus, as well as simplifies\
the source files. In the parameters, `name' defines the name field of the menu, \
and the values of the menu are either integers going from `n1' to `n2' (in the first syntax),\
or items in the list `selectlist'. <br/>\
The optional parameter `promptlist' can be used to generate\
user prompts for each items in the list. If `promptlist' is\
empty or is shorter than `selectlist', the undefined prompts\
will be replaced by the value. If it is longer, the rest will be ignored.\
<br/>\
An `id' is created automatically, except if the variable\
`wims_ref_id' is specified just before. If the variable\
`wims_html_mode' has a value as `div', `li', `td', the different items of\
the html form will be in the corresponding html environmment. If the\
variable `wims_ref_class' is non empty, the class of this html environment is the value \
of this variable. The default of the menu will be the current value of the variable\
`$$name'.
 
<div>$lst_alias htmlcheckbox</div>
 
<div>$(lst_syntax)formcheckbox $emph name$emphend from $emph n1$emphend
to $emph n2$emphend prompt $emph promptlist $emphend
</span>
<br/>or<br/>
<span class="tt">
$!formcheckbox $emph name$emphend list
$emph selectlist$emphend prompt $emph promptlist$emphend
</span>
:sample:<table class="wimstable" summary="list some samples for formcheckbox command">\
<thead>\
<tr>\
<th>Command</th>\
<th>Result</th>\
</tr>\
</thead>\
<tbody>\
<tr>\
<td><code>!formcheckbox varCHK1 from 1 to 3 prompt txt1,txt2,txt3</code></td>\
<td>\
!formcheckbox varCHK1 from 1 to 3 prompt txt1,txt2,txt3\
</td>\
</tr>\
<tr>\
<td><code>!formcheckbox varCHK2 list a,b,c prompt txtA,txtB,txtC</code></td>\
<td>\
!formcheckbox varCHK2 list a,b,c prompt txtA,txtB,txtC\
</td>\
</tr>\
</tbody>\
</table>\
</div>
 
<div>$lst_mean Creates a checkbox list menu under a previously defined html form. <br/>
This command speeds up the creation of checkboxed menus, as well as simplifies
the source files. In the parameters, $emph name$emphend defines the
name field of the menu, and the values of the menu are either integers
going from $emph n1$emphend to $emph n2$emphend (in the first syntax), or
items in the list $emph selectlist$emphend. <br/>
The optional parameter $emph promptlist$emphend can be used to generate
user prompts for each items in the list. If $emph promptlist$emphend is
empty or is shorter than $emph selectlist$emphend, the undefined prompts
will be replaced by the value. If it is longer, the rest will be ignored.
<br/>
An $emph id$emphend is created automatically, except if the variable
$emph wims_ref_id$emphend is specified just before. If the variable
$emph wims_html_mode$emphend has a value as $emph div$emphend,
$emph li$emphend, $emph td$emphend, the different items of
the html form will be in the corresponding html environmment. If the
variable $emph wims_ref_class$emphend is non empty, the class of
this html environment is the value of this variable.
The default of the menu will be the current value of the variable
$emph $$name$emphend.</div>
 
<div>$lst_sample
<table class="wimstable" summary="list some samples for formcheckbox command">
<thead>
<tr>
<th>Command</th>
<th>Result</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>!formcheckbox varCHK1 from 1 to 3 prompt txt1,txt2,txt3</code></td>
<td>
!formcheckbox varCHK1 from 1 to 3 prompt txt1,txt2,txt3
</td>
</tr>
<tr>
<td><code>!formcheckbox varCHK2 list a,b,c prompt txtA,txtB,txtC</code></td>
<td>
!formcheckbox varCHK2 list a,b,c prompt txtA,txtB,txtC
</td>
</tr>
</tbody>
</table>
</div>