Subversion Repositories wimsdev

Compare Revisions

Ignore whitespace Rev 11291 → Rev 11292

/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/append.phtml
1,6 → 1,6
!! +var+ +exec+ +string+
tit:append
type:$type_both
syntax:!append `object s1' to `str'
mean:String manipulation: append object `s1' to the string `str'; `object' may be `item', `word',\
`line', `colon' or `semicolon'. The object `s1' should not be empty before evaluation.
syntax:!append ``object s1'' to ``str''
mean:String manipulation: append object ``s1'' to the string ``str''; ``object'' may be ``item'', ``word'',\
``line'', ``colon'' or ``semicolon''. The object ``s1'' should not be empty before evaluation.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/bound.phtml
1,14 → 1,14
!! +exec+ +vardef+
tit:bound
type:$type_exec
syntax:!bound `vname' between [integer] `v1' and `v2' [default `defaultvalue']\
!bound `vname' within `list' [default `defaultvalue']
mean:bound the range of the variable `vname'. Usually this is used on user-submitted variables.\
syntax:!bound ``vname'' between [integer] ``v1'' and ``v2'' [default ``defaultvalue'']\
!bound ``vname'' within ``list'' [default ``defaultvalue'']
mean:bound the range of the variable ``vname''. Usually this is used on user-submitted variables.\
<br/>The first syntax is usually for numerical variables (integer or real,\
defaults to real). In this case `v1' and `v2' supplies the lower and \
upper bounds for the value of `vname'. <br/>\
In the second syntax, the value of `vname ' is compared with\
each item of `list'. If no occurrence is found, the value of\
`vname' is replaced either by `defaultvalue' or the first item of `list',\
according to whether `defaultvalue' is defined. <br/>\
In any case, `defaultvalue' is optional.
defaults to real). In this case ``v1'' and ``v2'' supplies the lower and \
upper bounds for the value of ``vname''. <br/>\
In the second syntax, the value of ``vname '' is compared with\
each item of ``list''. If no occurrence is found, the value of\
``vname'' is replaced either by ``defaultvalue'' or the first item of ``list'',\
according to whether ``defaultvalue'' is defined. <br/>\
In any case, ``defaultvalue'' is optional.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/changeto.phtml
1,7 → 1,7
!! +exec+ +jump+
tit:changeto
type:$type_exec
syntax:!changeto `file' [`parm']
mean:Abandon the current file, changing processing to `file'. `file' is as in `read'.\
<br/>The parameter `parm' can be accessed from within\
the new `file' under the variable name `wims_read_parm'.
syntax:!changeto ``file'' [``parm'']
mean:Abandon the current file, changing processing to ``file''. ``file'' is as in ``read''.\
<br/>The parameter ``parm'' can be accessed from within\
the new ``file'' under the variable name ``wims_read_parm''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/char.phtml
2,5 → 2,5
tit:char
type:$type_both
alias:chars
syntax:!char `numlist' of `string'
mean:Outputs selected characters of `string', according to `numlist'.
syntax:!char ``numlist'' of ``string''
mean:Outputs selected characters of ``string'', according to ``numlist''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/charcnt.phtml
2,5 → 2,5
tit:charcnt
type:$type_var
alias:charcount, charno, charnum, lengthof
syntax:!charcnt `string'
mean:Returns the number of characters in `string'.
syntax:!charcnt ``string''
mean:Returns the number of characters in ``string''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/column.phtml
2,10 → 2,10
tit:column
type:$type_both
alias:columns
syntax:!column `numlist' of `string'
mean:Outputs selected (comma-separated) columns of a matrix `string',\
according to `numlist'. Rows of the matrix can be separated either \
syntax:!column ``numlist'' of ``string''
mean:Outputs selected (comma-separated) columns of a matrix ``string'',\
according to ``numlist''. Rows of the matrix can be separated either \
by new lines or by semi-colon ``;''.
 
numlist:The output is separated by commas if only one column is selected, or\
separated in the same way as the matrix `string' otherwise.
separated in the same way as the matrix ``string'' otherwise.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/date.phtml
1,7 → 1,7
!! +exec+ +var+
tit:date
type:$type_both
syntax:!date `parm'
mean:This is simply an interface to the Linux `date' utility. `parm' is the parameter\
string to the Linux command `date', please refer to the man page of `date' for its syntax. \
The command returns the output of the `date' utility.
syntax:!date ``parm''
mean:This is simply an interface to the Linux ``date'' utility. ``parm'' is the parameter\
string to the Linux command ``date'', please refer to the man page of ``date'' for its syntax. \
The command returns the output of the ``date'' utility.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/debug.phtml
1,7 → 1,7
!! +exec+ +var+
tit:debug
type:$type_both
syntax:!debug `parms'
mean:This command is for debugging purposes: it substitutes the parameter `parms', \
syntax:!debug ``parms''
mean:This command is for debugging purposes: it substitutes the parameter ``parms'', \
and stops the execution with a module error sent to the user. The content of the\
error message contains the result of the substitution.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/declosing.phtml
1,7 → 1,7
!! +exec+ +var+ +string+
tit:declosing
type:$type_both
syntax:!declosing `string'
mean:Strips off enclosing pair of parentheses ((),[],{}) in `string'. \
syntax:!declosing ``string''
mean:Strips off enclosing pair of parentheses ((),[],{}) in ``string''. \
Useful for treatment of user-input vectors or sets, \
where some users use enclosing parentheses and other do not.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/default.phtml
1,6 → 1,6
!! +exec+ +vardef+
tit:default
type:$type_exec
syntax:!default `name'=`value'
mean:put `value' into the variable `name', if `name' is not already defined.\
`value' may be a variable command (together with optional parameters).
syntax:!default ``name''=``value''
mean:put ``value'' into the variable ``name'', if ``name'' is not already defined.\
``value'' may be a variable command (together with optional parameters).
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/defof.phtml
2,8 → 2,8
tit:defof
type:$type_both
alias:definitionof, getdef
syntax:!defof `vname' in `fname'
mean:Returns the definition of variables `vname' in the file `fname'.\
<p>When `vname' contains several names, the values of each will\
syntax:!defof ``vname'' in ``fname''
mean:Returns the definition of variables ``vname'' in the file ``fname''.\
<p>When ``vname'' contains several names, the values of each will\
be returned with the same separators as for the names.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/detag.phtml
1,7 → 1,7
!! +exec+ +var+ +string+
tit:detag
type:$type_both
syntax:!detag `string'
mean:Removes html tags in `string'. It is very rudimentary and should be used with care.\
syntax:!detag ``string''
mean:Removes html tags in ``string''. It is very rudimentary and should be used with care.\
Very useful for security enhancement in some occasions (apply to user-supplied strings).
 
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/distribute.phtml
1,10 → 1,10
!! +exec+ +vardef+
tit:distribute
type:$type_exec
syntax:!distribute `type string' into `namelist'
mean:Distribute the content of `string' into variables `namelist'. The distribution \
syntax:!distribute ``type string'' into ``namelist''
mean:Distribute the content of ``string'' into variables ``namelist''. The distribution \
can be done word by word, item by item, character by character or line by line, \
according to the word `type'. `type' can be one of the following: `words', `items', \
`lines', `chars'. <p> For example, if `type' is <span class="tt">words</span>, \
then the first (resp. second, etc.) variable in `namelist' will be set\
to the first (resp. second, etc.) word of `string'.</p>
according to the word ``type''. ``type'' can be one of the following: ``words'', ``items'', \
``lines'', ``chars''. <p> For example, if ``type'' is ``words'', \
then the first (resp. second, etc.) variable in ``namelist'' will be set\
to the first (resp. second, etc.) word of ``string''.</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/embraced.phtml
1,16 → 1,16
!! +exec+ +var+ +string+
tit:embraced
type:$type_both
syntax:!embraced `opword string'
mean:executes an operation `opword' in each substring of `string' enclosed in a pair \
syntax:!embraced ``opword string''
mean:executes an operation ``opword'' in each substring of ``string'' enclosed in a pair \
of curly braces.\
<p>\
The curly braces in `string' can be nested, but the execution runs from outmost pair \
The curly braces in ``string'' can be nested, but the execution runs from outmost pair \
to innermost pair.\
</p><p>\
Available `opword':\
Available ``opword'':\
</p><ul>\
<li><span class="tt">randitem</span>. Random item in every embraced text.</li>\
<li><span class="tt">extract</span>. Extracts the first (outmost) embraced text.</li>\
<li><span class="tt">delete</span>. Deletes all embraced contents (encluding the curly braces).</li>\
<li>``randitem''. Random item in every embraced text.</li>\
<li>``extract''. Extracts the first (outmost) embraced text.</li>\
<li>``delete''. Deletes all embraced contents (encluding the curly braces).</li>\
</ul>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/eval.phtml
2,10 → 2,10
tit:eval
type:$type_var
alias:evalue
syntax:!eval `expr'
mean:Returns the numerical value of the expression `expr'. `expr' must evaluate to \
syntax:!eval ``expr''
mean:Returns the numerical value of the expression ``expr''. ``expr'' must evaluate to \
a real number (under the current version of wims). The evaluation is internally done in double\
precision, but the print precision can be changed by setting the variable\
`wims_print_precision' (whose default value is 8). <br/>\
If an error is found in the expression `expr', 0 is returned.\
``wims_print_precision'' (whose default value is 8). <br/>\
If an error is found in the expression ``expr'', 0 is returned.\
(I know that this is very bad; I just have no time to make everything right.)
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/evalsubst.phtml
2,9 → 2,9
tit:evalsubst
type:$type_both
alias:evalsubstit, evalsubstitute, evaluesubst, evaluesubstit, evaluesubstitute
syntax:!evalsubst `name'=`val' in `expr'
mean:Manipulation of mathematical expressions: substitute variable `name' by `val' in `expr', \
then evaluate the expression to a real number. No regular expression is allowed in `name'. <br/>\
syntax:!evalsubst ``name''=``val'' in ``expr''
mean:Manipulation of mathematical expressions: substitute variable ``name'' by ``val'' in ``expr'', \
then evaluate the expression to a real number. No regular expression is allowed in ``name''. <br/>\
See also the commands\
$(ref1)cmdlist_mathsubst_&+cmd_choose=all$(ref2)cmdlist_mathsubst_">!mathsubst</a>,\
$(ref1)cmdlist_replace_&+cmd_choose=all$(ref2)cmdlist_replace_">!replace</a>.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/exec.phtml
2,7 → 2,7
tit:exec
type:$type_both
alias:execute, run, call
syntax:!exec `command parms'
mean:execute external command `command' with optional parameters `parms'. \
`command' must be a valid program name in the wims-public directory `bin'. <br/>\
syntax:!exec ``command parms''
mean:execute external command ``command'' with optional parameters ``parms''. \
``command'' must be a valid program name in the wims-public directory ``bin''. <br/>\
When used as variable command, returns the output of the called program.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/fileappend.phtml
2,11 → 2,11
tit:fileappend
type:$type_exec
alias:appendfile
syntax:!fileappend `fname content'
mean:Append `content' to file `fname'. `fname' is a file residing in directory of the module, \
under the subdirectory `writable'. <br/> A new line will be added at the end of the `content'.\
syntax:!fileappend ``fname content''
mean:Append ``content'' to file ``fname''. ``fname'' is a file residing in directory of the module, \
under the subdirectory ``writable''. <br/> A new line will be added at the end of the ``content''.\
<p>\
Special case: if the file name starts with `getfile/', the file is written to the getfile \
Special case: if the file name starts with ``getfile/'', the file is written to the getfile \
subdirectory of the session. This file is then accessible via the command\
</p>\
<pre>!href cmd=getfile&amp;special_parm=fname_without_getfile_prefix</pre>\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/filewrite.phtml
2,12 → 2,12
tit:filewrite
type:$type_exec
alias:writefile
syntax:!filewrite `fname content'
mean:Write `content' to file `fname'. `fname' is a file residing in the module\'s directory, \
under the subdirectory `writable'. <br/>\
A new-line character will be added at the end of the `content'.\
syntax:!filewrite ``fname content''
mean:Write ``content'' to file ``fname''. ``fname'' is a file residing in the module's directory, \
under the subdirectory ``writable''. <br/>\
A new-line character will be added at the end of the ``content''.\
<p>\
Special case: if the file name starts with `getfile', the file is written to the getfile\
Special case: if the file name starts with ``getfile'', the file is written to the getfile\
subdirectory of the session. This file is then accessible via the command\
</p>\
<pre>!href cmd=getfile&amp;special_parm=fname_without_getfile_prefix</pre>,\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/for.phtml
1,16 → 1,16
!! +exec+ +loop+ +jump+
tit:for
type:$type_exec
syntax:!for `var' = `start' to `end' [step `st' ]\
$ !for `var' from `start' to `end' [step `st' ]\
$ !for `var' in `list'<br/>\
syntax:!for ``var'' = ``start'' to ``end'' [step ``st'' ]\
$ !for ``var'' from ``start'' to ``end'' [step ``st'' ]\
$ !for ``var'' in ``list''<br/>\
... (multi-line content)<br/>\
!next
mean:For loop. In the first two forms, `var' goes from `start' to `end', with optional step `st'.\
<br/>In the last form, `var' takes successively items in the list\
`list'. `list' is a list of items separated by commas. <br/>\
mean:For loop. In the first two forms, ``var'' goes from ``start'' to ``end'', with optional step ``st''.\
<br/>In the last form, ``var'' takes successively items in the list\
``list''. ``list'' is a list of items separated by commas. <br/>\
The command <pre>!break</pre>\
within the for loop breaks it. `continue' is not yet implemented in this version. <br/>\
It is recommended that the variable name `var' be added to the\
within the for loop breaks it. ``continue'' is not yet implemented in this version. <br/>\
It is recommended that the variable name ``var'' be added to the\
<span class="tt">!next </span> line. This has no effect for the time being, but may be\
used in future versions of wims.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/form.phtml
1,25 → 1,25
!! +exec+ +html+
tit:form
type:$type_exec
syntax:!form `cmdvar'
syntax:!form ``cmdvar''
mean:Creates a html form pointing to the wims server. <br/>\
Whenever possible, this command should be used instead of a direct use of\
html tag `&lt;form&gt;'. <br/>\
html tag ``&lt;form&gt;''. <br/>\
This command will create a &lt;form&gt; tag pointing to the wims server, adding\
&lt;input&gt; fields to pass session number (and other reserved things in the\
future). In lines which follow, other input (or select) fields may be\
added to the form. A final `!formend' must also be added by the\
programmer. <br/> `cmdvar' is an optional parameter. Its value should be a valid\
value for the variable `cmd'. In this case the value `cmdvar' will \
be automatically submitted to the variable `cmd'. If this parameter is missing \
added to the form. A final ``!formend'' must also be added by the\
programmer. <br/> ``cmdvar'' is an optional parameter. Its value should be a valid\
value for the variable ``cmd''. In this case the value ``cmdvar'' will \
be automatically submitted to the variable ``cmd''. If this parameter is missing \
or is invalid, then the programmer should add a \
`&lt;input type="hidden" name="cmd" value="..." /&gt;' tag before the\
final `&lt;/form&gt;'. <p>\
The target of the form can be controlled by the variable `wims_ref_target'. \
It can also be defined via an optional word `target=...'. Note that in this case \
the target must start with `wims_'.\
``&lt;input type="hidden" name="cmd" value="..." /&gt;'' tag before the\
final ``&lt;/form&gt;''. <p>\
The target of the form can be controlled by the variable ``wims_ref_target''. \
It can also be defined via an optional word ``target=...''. Note that in this case \
the target must start with ``wims_''.\
</p><p>\
The variable `wims_form_method' which must be either `get' or `post' controls the method \
of the form. This method defaults to `post' for tool modules, and to `get' for all\
The variable ``wims_form_method'' which must be either ``get'' or ``post'' controls the method \
of the form. This method defaults to ``post'' for tool modules, and to ``get'' for all\
other modules.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/formbar.phtml
2,11 → 2,11
tit:formbar
type:$type_exec
alias:formradiobar, htmlbar, htmlradiobar
syntax:!formbar `name' from `n1' to `n2'\
!formradio `name' list `selectlist'
syntax:!formbar ``name'' from ``n1'' to ``n2''\
!formradio ``name'' list ``selectlist''
mean:Creates a bar of radio buttons under a previously defined html form. <br/>\
This bar should be arranged to represent values from small to big. No prompt is given \
to the user, except the indication that left is smaller. 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 default of the menu will be the current value of the variable `&#36;name'.
to the user, except the indication that left is smaller. 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 default of the menu will be the current value of the variable ``&#36;name''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/formcheckbox.phtml
2,26 → 2,26
tit:formcheckbox
type:$type_exec
alias:htmlcheckbox
syntax:!formcheckbox `name' from `n1' to `n2' prompt `promptlist'\
!formcheckbox `name' list `selectlist' prompt `promptlist'
syntax:!formcheckbox ``name'' from ``n1'' to ``n2'' prompt ``promptlist''\
!formcheckbox ``name'' list ``selectlist'' prompt ``promptlist''
 
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\
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\
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 \
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\
`&#36;name'.
``&#36;name''.
 
:sample:<table class="wimstable" summary="list some samples for formcheckbox command">\
<thead>\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/formend.phtml
2,4 → 2,4
tit:formend
type:$type_exec
syntax:!formend
mean:Creates the balise which closes the form created by `!form'
mean:Creates the balise which closes the form created by ``!form''
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/formradio.phtml
2,15 → 2,15
tit:formradio
type:$type_exec
alias:htmlradio
syntax:!formradio `name' from `n1' to `n2' prompt `promptlist'\
!formradio `name' list `selectlist' prompt `promptlist'
syntax:!formradio ``name'' from ``n1'' to ``n2'' prompt ``promptlist''\
!formradio ``name'' list ``selectlist'' prompt ``promptlist''
mean:Creates a radio button list menu under a previously defined html form. <br/>\
This command speeds up the creation of radio buttoned 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\
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/>\
The default of the menu will be the current value of the variable `&#36;name'.
The default of the menu will be the current value of the variable ``&#36;name''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/getopt.phtml
1,15 → 1,15
!! +var+ +string+
tit:getopt
type:$type_both
syntax:!getopt `name' in `string'
mean:This command allows to extract the definition of a word in `string' under the form `name=value'.\
syntax:!getopt ``name'' in ``string''
mean:This command allows to extract the definition of a word in ``string'' under the form ``name=value''.\
<p>\
It returns the defined `value' in the string, or the `name' itself if it appears in `string'\
but if there is no `=' sign following it, or an empty string if `name' does not appear \
in `string' as a word.\
It returns the defined ``value'' in the string, or the ``name'' itself if it appears in ``string''\
but if there is no ``='' sign following it, or an empty string if ``name'' does not appear \
in ``string'' as a word.\
</p><p>\
`value' can be a multi-word string, if it is enclosed by a pair of parentheses, brackets, \
``value'' can be a multi-word string, if it is enclosed by a pair of parentheses, brackets, \
curly braces or double quotes. The enclosing parentheses etc. will be removed from the output.\
</p><p>\
Spaces are allowed before and/or after the `=' sign.\
Spaces are allowed before and/or after the ``='' sign.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/goto.phtml
1,5 → 1,5
!! +exec+ +jump+
tit:goto
type:$type_exec
syntax:!goto `label'
mean:Unconditionally jump to `label'. `label' must be a valid label in the current file.
syntax:!goto ``label''
mean:Unconditionally jump to ``label''. ``label'' must be a valid label in the current file.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/header.phtml
2,6 → 2,6
tit:header
type:$type_exec
alias:htmlheader, wimsheader
syntax:!header `parm'
mean:Standardized header for html page outputs. Includes the variable `wims_html_header' \
and the commands `!headmenu' and `!title'. <p>`parm' is reserved for future implementation.</p>
syntax:!header ``parm''
mean:Standardized header for html page outputs. Includes the variable ``wims_html_header'' \
and the commands ``!headmenu'' and ``!title''. <p>``parm'' is reserved for future implementation.</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/headmenu.phtml
3,4 → 3,3
type:$type_exec
syntax:!headmenu
mean:Creates a standardised menu bar, usually to be included on the top of the page.
 
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/hex.phtml
2,11 → 2,9
tit:hex
type:$type_both
alias:tohex
syntax:!hex `string'
mean:Returns a new string replacing every character in `string' by its hexadecimal code.\
syntax:!hex ``string''
mean:Returns a new string replacing every character in ``string'' by its hexadecimal code.\
<p>\
In particular, the result can be used as part of a variable\
name whatever the content of `string' is (as long as it is not too long).\
name whatever the content of ``string'' is (as long as it is not too long).\
</p>
 
 
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/homeref.phtml
2,7 → 2,6
tit:homeref
type:$type_exec
alias:wimsref
syntax:!homeref `parm'
syntax:!homeref ``parm''
mean:Creates a standardised table of links to wims homepage (and eventually other things).\
`parm' is reserved for future implementation.
 
``parm'' is reserved for future implementation.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/href.phtml
1,18 → 1,18
!! +exec+ +html+
tit:href
type:$type_exec
syntax:!href `parms text'
syntax:!href ``parms text''
mean:Creates a hypertext reference pointing to the wims server. <br/>\
Whenever possible, this command should be used instead of a direct use of\
html tag `&lt;a href="..."&gt;'. <br/>\
`parms' is the string of parameters to the call to wims server,\
which should not contain white spaces. Usually a `cmd=...' pair should be at least present;\
html tag ``&lt;a href="..."&gt;''. <br/>\
``parms'' is the string of parameters to the call to wims server,\
which should not contain white spaces. Usually a ``cmd=...'' pair should be at least present;\
on the other hand, the session number and prefered language will be directly added by the server. \
<br/>\
`text' is the text on which the hypertext link sits. It can be\
``text'' is the text on which the hypertext link sits. It can be\
any text or a &lt;img...&gt; tag, but dynamic insertions are not accepted yet.\
<br/>There is no need to add the end tag `&lt;/a&gt;'.\
<br/>There is no need to add the end tag ``&lt;/a&gt;''.\
<p>The target of the reference can be controlled via the variable\
`wims_ref_target'. It can also be defined via an optional word\
`target=...'. Note that in this case the target must start with `wims_'.\
``wims_ref_target''. It can also be defined via an optional word\
``target=...''. Note that in this case the target must start with ``wims_''.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/htmlmath.phtml
2,8 → 2,8
tit:htmlmath
type:$type_both
alias:math2html
syntax:!htmlmath `expr'
mean:Translate the raw mathematical expression `expr', into a form which can be \
syntax:!htmlmath ``expr''
mean:Translate the raw mathematical expression ``expr'', into a form which can be \
best possibly rendered via html tags. If the expression is not a "machine-understandable\
mathematical expression", there is no garanty on the result (at the moment and in the future !).\
<ul><li>\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/if.phtml
1,9 → 1,9
!! +exec+ +jump+
tit:if
type:$type_exec
syntax:!if `string1 relation string2'<br/>\
syntax:!if ``string1 relation string2''<br/>\
... (multi-line content)<br/>\
$ !endif
mean:Conditional branching: execute the multi-line content between `!if' line and `!endif' line, \
if `relation' is verified. The leading and trailing spaces of `string1' and `string2' \
mean:Conditional branching: execute the multi-line content between ``!if'' line and ``!endif'' line, \
if ``relation'' is verified. The leading and trailing spaces of ``string1'' and ``string2'' \
will be stripped before making comparisons.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/ifval.phtml
1,8 → 1,8
!! +exec+ +jump+
tit:ifval
type:$type_exec
syntax:!if `string1 relation string2'<br/>\
syntax:!if ``string1 relation string2''<br/>\
... (multi-line content)<br/>\
$ !endif
mean:Same as $(ref1)cmdlist_if_$(ref2)cmdlist_if_">if</a>, but `=' (`=='), `!=' compares the\
numerical values of `string1' and `string2' rather than the strings themselves.
mean:Same as $(ref1)cmdlist_if_$(ref2)cmdlist_if_">if</a>, but ``='' (``==''), ``!='' compares the\
numerical values of ``string1'' and ``string2'' rather than the strings themselves.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/increase.phtml
2,5 → 2,5
tit:increase
type:$type_exec
alias:advance
syntax:!increase `var'
mean:Increase the value of `var' by one. The value of `var' is first rounded to an integer.
syntax:!increase ``var''
mean:Increase the value of ``var'' by one. The value of ``var'' is first rounded to an integer.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/insdraw.phtml
2,6 → 2,6
tit:insdraw
type:$type_pexec
alias:inspaint
syntax:!insdraw `drawsource'
mean:The server will call a paint program (`flydraw'), submit `drawsource' \
syntax:!insdraw ``drawsource''
mean:The server will call a paint program (``flydraw''), submit ``drawsource'' \
as its command (with variables substituted), and insert the result into the page.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/insmath.phtml
1,12 → 1,12
!! +exec+ +ins+
tit:insmath
type:$type_pexec
syntax:!insmath `formula'
mean:According to the complicatedness of `formula', the server will either render it \
as beautifully as possible using html tags, or translate `formula' into TeX source then\
syntax:!insmath ``formula''
mean:According to the complicatedness of ``formula'', the server will either render it \
as beautifully as possible using html tags, or translate ``formula'' into TeX source then\
call TeX to compile and finally transform the TeX result into a picture. The latter\
is inserted into the page (at the place of the command). <br/>\
If the user browser knows mathml, then the `formula' is simply translated into mathml \
If the user browser knows mathml, then the ``formula'' is simply translated into mathml \
and sent to the browser. What is done is the following:\
<ul><li>replace .. by ,\
</li><li> If there is no \ or { , apply rawmath if it is asked;\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/insplot.phtml
1,8 → 1,8
!! +exec+ +ins+
tit:insplot
type:$type_pexec
syntax:!insplot `plotsource'
syntax:!insplot ``plotsource''
mean:The server program will call an external plotting program (gnuplot for the current version),\
submit `plotsource' as the 2D plot command (with variables substituted),\
submit ``plotsource'' as the 2D plot command (with variables substituted),\
and insert the result into the page. <br/>\
The syntax of `plotsource' is that of the `plot' command of gnuplot.
The syntax of ``plotsource'' is that of the ``plot'' command of gnuplot.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/insplot3d.phtml
1,8 → 1,7
!! +exec+ +ins+
tit:insplot3d
type:$type_pexec
syntax:!insplot3d `plotsource'
syntax:!insplot3d ``plotsource''
mean:As for $(ref1)cmdlist_insplot_$(ref2)cmdlist_insplot_">insplot</a>,\
but `plotsource' is in the syntax of the `splot' command of gnuplot, and a 3D\
but ``plotsource'' is in the syntax of the ``splot'' command of gnuplot, and a 3D\
surface will be plotted.
 
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/instex.phtml
1,13 → 1,13
!! +exec+ +ins+
tit:instex
type:$type_pexec
syntax:!instex `texsource'
mean:The server program will call TeX to process the (plain) TeX source `texsource' \
syntax:!instex ``texsource''
mean:The server program will call TeX to process the (plain) TeX source ``texsource'' \
(after variable substitution), translate the result into a picture, and\
insert it into the page (at the place of the command). <br/>\
A tip: avoid using substituted variables in `texsource'\
A tip: avoid using substituted variables in ``texsource''\
whenever possible. In this case Wims will use static instex, improving\
performance dramatically over dynamic instex. <br/>\
The font color of the inserted text can be controled either by the variable\
`instex_color', or by a <span class="tt">\special{color=...}</span> string\
in the `texsource'.
``instex_color'', or by a <span class="tt">\special{color=...}</span> string\
in the ``texsource''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/instexstatic.phtml
2,7 → 2,7
tit:instexstatic
type:$type_pexec
alias:instexst, staticinstex, stinstex
syntax:!instexstatic `gifname texsource'
syntax:!instexstatic ``gifname texsource''
mean:This command is obsolete, and will be dropped in future versions.\
Use $(ref1)cmdlist_instex_&+cmd_choose=all$(ref2)cmdlist_instex_">!instex</a> instead.
 
11,22 → 11,22
$lst_mean This is similar to
$(ref1)cmdlist_instex_&+cmd_choose=all$(ref2)cmdlist_instex_">!instex</a>,
to the difference that no variable substitution is performed on
`texsource', and that the name of the gif file
`gifname' shoule be given (together with the extension
`.gif'). `gifname' should be the name of a file in
the module\'s home directory. <br/>
``texsource'', and that the name of the gif file
``gifname'' shoule be given (together with the extension
``.gif''). ``gifname'' should be the name of a file in
the module's home directory. <br/>
Wims will produce the gif file if it does not exist, or if the file
containing the command is newer than the gif file. No TeX is called in the
subsequent requests, thus greatly improving performance. <br/>
When `instexstatic' is used as a variable command, it returns
the tag string `&lt;IMG SRC=...>', which can be inserted
When ``instexstatic'' is used as a variable command, it returns
the tag string ``&lt;IMG SRC=...>'', which can be inserted
elsewhere in the document.
<p>
<span class="wims_warning">Important</span>.
Since version 0.11.5, `gifname' is optional, and
Since version 0.11.5, ``gifname'' is optional, and
<span class="tt">!instex</span> will automatically use static insertion whenever there is
no real variable substitution in `texsource'. Therefore
no real variable substitution in ``texsource''. Therefore
<span class="tt">!instexstatic</span> is no longuer really necessary, and is provided only
for backward compatibility. so <font color=red><b>avoid using
it!</b></font> Use <span class="tt">!instex</span> instead.
for backward compatibility. so <span class="wims_warning">avoid using
it!</span> Use <span class="tt">!instex</span> instead.
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/item.phtml
2,6 → 2,5
tit:item
type:$type_both
alias:items
syntax:!item `numlist' of `string'
mean:Outputs selected (comma-separated) items of `string', according to `numlist'.
 
syntax:!item ``numlist'' of ``string''
mean:Outputs selected (comma-separated) items of ``string'', according to ``numlist''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/itemcnt.phtml
2,5 → 2,5
tit:itemcnt
type:$type_var
alias:itemcount, itemno, itemnum
syntax:!itemcnt `list'
mean:Returns the number of items in `list'.
syntax:!itemcnt ``list''
mean:Returns the number of items in ``list''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/items2lines.phtml
2,5 → 2,5
tit:items2lines
type:$type_both
alias:itemstolines, list2lines, listtolines
syntax:!items2lines `string'
mean:This command changes multiple items in `string' into multiple lines.
syntax:!items2lines ``string''
mean:This command changes multiple items in ``string'' into multiple lines.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/items2words.phtml
2,5 → 2,5
tit:items2words
type:$type_both
alias:itemstowords, list2words, listtowords
syntax:!items2words `string'
mean:This command changes multiple items in `string' into multiple words.
syntax:!items2words ``string''
mean:This command changes multiple items in ``string'' into multiple words.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/let.phtml
2,6 → 2,6
tit:let
type:$type_exec
alias:def, define, set
syntax:!let `name'=`value'
mean:put `value' into the variable `name'. `value' may be a variable command\
syntax:!let ``name''=``value''
mean:put ``value'' into the variable ``name''. ``value'' may be a variable command\
(together with optional parameters).
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/leveldata.phtml
2,10 → 2,10
tit:leveldata
type:$type_both
alias:levelpoints
syntax:!leveldata size `xsize,ysize' ranges `x1,x2,y1,y2' function `f(x,y)' [levels `l1,l2,...']
mean:Computes coordinates of points on the level curve of `f(x,y)', at levels `l1,l2,...'\
syntax:!leveldata size ``xsize,ysize'' ranges ``x1,x2,y1,y2'' function ``f(x,y)'' [levels ``l1,l2,...'']
mean:Computes coordinates of points on the level curve of ``f(x,y)'', at levels ``l1,l2,...''\
(defaults to one level 0). <p>\
The computation is made from `(x1,y1)' to `(x2,y2)', and points are computed as integer\
positions in a picture with size `xsize,ysize'. </p><p>\
The computation is made from ``(x1,y1)'' to ``(x2,y2)'', and points are computed as integer\
positions in a picture with size ``xsize,ysize''. </p><p>\
Order of the fields is not important. All the fields except levels are mandatory.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/line.phtml
2,5 → 2,5
tit:line
type:$type_both
alias:lines
syntax:!line `numlist' of `string'
mean:Outputs selected lines of `string', according to `numlist'.
syntax:!line ``numlist'' of ``string''
mean:Outputs selected lines of ``string'', according to ``numlist''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/linecnt.phtml
2,7 → 2,5
tit:linecnt
type:$type_var
alias:linecount, lineno, linenum
syntax:!linecnt `string'
mean:Returns the number of lines in `string'.
 
 
syntax:!linecnt ``string''
mean:Returns the number of lines in ``string''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/lines2items.phtml
2,6 → 2,5
tit:lines2items
type:$type_both
alias:linestoitems, lines2list, linestolist
syntax:!lines2items `string'
mean:This command changes multiple lines in `string' into multiple items.
 
syntax:!lines2items ``string''
mean:This command changes multiple lines in ``string'' into multiple items.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/lines2words.phtml
2,5 → 2,5
tit:lines2words
type:$type_both
alias:linestowords
syntax:!lines2words `string'
mean:This command changes multiple lines in `string' into multiple words.
syntax:!lines2words ``string''
mean:This command changes multiple lines in ``string'' into multiple words.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/listcomplement.phtml
1,6 → 1,5
!! +exec+ +var+ +string+
tit:listcomplement
type:$type_both
syntax:!listcomplement `list1' in `list2'
mean:Returns items appearing in `list2' but not in `list1'. Repetitive occurrences are eliminated.
 
syntax:!listcomplement ``list1'' in ``list2''
mean:Returns items appearing in ``list2'' but not in ``list1''. Repetitive occurrences are eliminated.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/listfile.phtml
2,7 → 2,7
tit:listfile
type:$type_both; $type_adm
alias:listfiles, filelist, ls, dir
syntax:!listfile `filespec'
mean:list files specified in `filespec'. Options to Linux command `ls' are accepted. \
syntax:!listfile ``filespec''
mean:list files specified in ``filespec''. Options to Linux command ``ls'' are accepted. \
The base directory is the base of the wims server. So if you want to list files \
in the current module, type <pre>!listfile &#36;module_dir</pre>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/listintersect.phtml
2,6 → 2,5
tit:listintersect
type:$type_both
alias:listintersection
syntax:!listintersect `list1' and `list2'
mean:Returns items appearing in both `list1' and `list2'. Repetitive occurrences are eliminated.
 
syntax:!listintersect ``list1'' and ``list2''
mean:Returns items appearing in both ``list1'' and ``list2''. Repetitive occurrences are eliminated.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/listunion.phtml
1,6 → 1,5
!! +exec+ +var+ +string+
tit:listunion
type:$type_both
syntax:!listunion `list1' and `list2'
mean:Returns items appearing in either `list1' or `list2'. Repetitive occurrences are eliminated.
 
syntax:!listunion ``list1'' and ``list2''
mean:Returns items appearing in either ``list1'' or ``list2''. Repetitive occurrences are eliminated.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/listuniq.phtml
2,5 → 2,5
tit:listuniq
type:$type_both
alias:listunique
syntax:!listuniq `list'
mean:Returns items in `list', with repetitive occurrences eliminated.
syntax:!listuniq ``list''
mean:Returns items in ``list'', with repetitive occurrences eliminated.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/lookup.phtml
1,11 → 1,11
!! +var+ +exec+ +string+
tit:lookup
type:$type_both
syntax:!lookup `defname' in `fname'
mean:Returns the definition of word `defname' in the file `fname' which must be\
syntax:!lookup ``defname'' in ``fname''
mean:Returns the definition of word ``defname'' in the file ``fname'' which must be\
a dictionary file in the same syntax as for the program <span class="tt">translator</span>\
(not necessarily sorted).\
<p>\
`fname' may be either in the module directory (in this case the\
``fname'' may be either in the module directory (in this case the\
module directory need not be specified), or in the directory bases.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/lower.phtml
2,5 → 2,5
tit:lower
type:$type_both
alias:lowercase, tolower
syntax:!lower `string'
mean:Returns `string' with all upper case letters replaced by their lowercase counterparts.
syntax:!lower ``string''
mean:Returns ``string'' with all upper case letters replaced by their lowercase counterparts.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/mailto.phtml
1,7 → 1,7
!! +exec+ +adm+
tit:mailto
type:$type_exec; $type_adm
syntax:!mailto `...'
syntax:!mailto ``...''
mean:sends a email to a person whose address is the first line of the parameter.\
The second line is the subject of the message.\
And the rest is the body of the message.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/mailurl.phtml
1,7 → 1,7
!! +exec+ +var+
tit:mailurl
type:$type_both
syntax:!mailurl `address name ...'
syntax:!mailurl ``address name ...''
mean:Creates a javascript-crypted email interface that is difficult\
for spammer-robot to decrypt.\
<p>\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/makelist.phtml
1,13 → 1,13
!! +var+ +exec+ +string+
tit:makelist
type:$type_both
syntax:!makelist `templ' for `v'=`v1' to `v2' [step `st'], or <br/>
$ !makelist `templ' for `v' in `v1,v2,v3,...'
mean:Outputs a list consisting of `templ' with variable `v' successively substituted \
by values `v1', ..., `v2'. <p>\
syntax:!makelist ``templ'' for ``v''=``v1'' to ``v2'' [step ``st''], or <br/>
$ !makelist ``templ'' for ``v'' in ``v1,v2,v3,...''
mean:Outputs a list consisting of ``templ'' with variable ``v'' successively substituted \
by values ``v1'', ..., ``v2''. <p>\
In the second syntax, the substitutions are done with respect to each item in\
the list `v1,v2,...'. </p><p>\
The variable `v' should appear in `templ' as a math variable \
the list ``v1,v2,...''. </p><p>\
The variable ``v'' should appear in ``templ'' as a math variable \
(that is, with no preceeding character). </p><p>For example, the command</p>\
<pre>!makelist [x;x+1;xx] for x in a,x and y,1,(2,3)</pre>\
gives the result\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/mathmlmath.phtml
2,8 → 2,8
tit:mathmlmath
type:$type_both
alias:math2mathml
syntax:!mathmlmath `expr'
mean:Translate the raw mathematical expression `expr', into a form which can be best \
syntax:!mathmlmath ``expr''
mean:Translate the raw mathematical expression ``expr'', into a form which can be best \
possibly rendered via mathml tags. The transformations\
are the same as in htmlmath command and the result is in html if mathml is not available.\
If the expression is not a "machine-understandable mathematical expression",\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/mathsubst.phtml
2,9 → 2,9
tit=mathsubst
type:$type_both
alias:mathsubstit, mathsubstitute
syntax:!mathsubst `name'=`val' in `expr'
mean:Manipulation of mathematical expressions: substitute variable `name' by `val' in `expr'. <br/>\
No regular expression is allowed in `name'. <br/>\
syntax:!mathsubst ``name''=``val'' in ``expr''
mean:Manipulation of mathematical expressions: substitute variable ``name'' by ``val'' in ``expr''. <br/>\
No regular expression is allowed in ``name''. <br/>\
See also the commands\
$(ref1)cmdlist_evalsubst_&+cmd_choose=all$(ref2)cmdlist_evalsubst_">!evalsubst</a>,\
$(ref1)cmdlist_replace_&+cmd_choose=all$(ref2)cmdlist_replace_">!replace</a>.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/mexec.phtml
1,8 → 1,8
!! +exec+
tit:mexec
type:$type_both; $type_adm
syntax:!mexec `command parms'
mean:execute a module-private external command `command' with optional parameters `parms'. \
`command' must be a valid program name in the module\'home directory. But the command is\
syntax:!mexec ``command parms''
mean:execute a module-private external command ``command'' with optional parameters ``parms''. \
``command'' must be a valid program name in the module'home directory. But the command is\
executed from the base directory of the server. <br/>\
When used as variable command, returns the output of the called program.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/module.phtml
1,9 → 1,9
!! +exec+ +var+ +vardef+
tit:module
type:$type_both
syntax:!module `defname' `modname'
mean:Returns the definition for `defname' of the module `modname'.\
syntax:!module ``defname'' ``modname''
mean:Returns the definition for ``defname'' of the module ``modname''.\
The most common use of this command is to get the title of a module \
(`defname' is then <span class="tt">title</span>). <br/>\
The INDEX file of the module `modname' will be parsed to look\
for the definition of `defname'.
(``defname'' is then <span class="tt">title</span>). <br/>\
The INDEX file of the module ``modname'' will be parsed to look\
for the definition of ``defname''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/msg.phtml
1,6 → 1,6
!! +exec+ +jump+
tit:msg
type:$type_exec
syntax:!msg `error' [`parm']
mean:Put an error message of type `error', with eventual `parm' depending on error.
syntax:!msg ``error'' [``parm'']
mean:Put an error message of type ``error'', with eventual ``parm'' depending on error.
 
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/nonempty.phtml
2,6 → 2,5
tit:nonempty
type:$type_both
alias:non_empty
syntax:!nonempty `obj' `content'
mean:`obj' can be `item' or `line'. The non-empty items or lines in `content' will be extracted.
 
syntax:!nonempty ``obj'' ``content''
mean:``obj'' can be ``item'' or ``line''. The non-empty items or lines in ``content'' will be extracted.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/nospace.phtml
1,6 → 1,5
!! +exec+ +var+ +string+
tit:nospace
type:$type_both
syntax:!nospace `string'
mean:Collapses all space characters (\' \', tab, newline) in `string'.
 
syntax:!nospace ``string''
mean:Collapses all space characters (' ', tab, newline) in ``string''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/nosubst.phtml
1,6 → 1,5
!! +var+
tit:nosubst
type:$type_var
syntax:!nosubst `string'
mean:Returns `string' `as-is', without variable substitution.
 
syntax:!nosubst ``string''
mean:Returns ``string'' as-is, without variable substitution.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/numlist
1,25 → 1,25
!if $numlist_type=record
!set numlist_str=`fname'
!set numlist_str=``fname''
!else
!set numlist_str=`string'
!set numlist_str=``string''
!endif
!if $numlist_type=char
!set numlist_type=character
!endif
 
`numlist' can be a single integer, a comma-separated list of
``numlist'' can be a single integer, a comma-separated list of
integers, or a range of integers.
<br/>
A positive integer denotes the number of $numlist_type in $numlist_str
counted from the beginning,
with `1' corresponding to the first
with ``1'' corresponding to the first
$numlist_type. A negative integer denotes the number of $numlist_type from
the end of $numlist_str: `-1'
means the last $numlist_type, `-2' means
the end of $numlist_str: ``-1''
means the last $numlist_type, ``-2'' means
the next-to-last $numlist_type, etc. <p>
The syntax for a range of integers is
<span class="tt">`n1' to`n2'</span>
For example, <span class="tt">`2 to -2'</span>
``n1 to n2''
For example, ``2 to -2''
means the whole $numlist_str except the first
and the last $(numlist_type)s.
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/pedia.phtml
2,13 → 2,13
tit:pedia
type:$type_both
alias:encyclopedia, encyclo
syntax:!pedia `keyword',`name'
syntax:!pedia ``keyword'', ``name''
mean:Creates a hypertext link pointing to an online encyclopedia.\
`keyword' will be the name under which the reference is looked for, \
``keyword'' will be the name under which the reference is looked for, \
and should be a phrase with one or several words separated by space.\
Examples: `finite field' or `linear transformation'.\
Examples: ``finite field'' or ``linear transformation''.\
<br/>\
`name' is the name of the link (i.e. what people see in their page, and can click on).\
``name'' is the name of the link (i.e. what people see in their page, and can click on).\
<p>\
Actually wims use\
<a href="www.wikipedia.org">Wikipedia</a>\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/positionof.phtml
2,12 → 2,12
tit:positionof
type:$type_both
alias:position, positions
syntax:!positionof [`type'] `s' in `string'
mean:Reports the positions of the object `s' in `string'. <br/>\
`type' can be <span class="tt">char</span>, <span class="tt">word</span>, <span class="tt">item</span> or\
syntax:!positionof [``type''] ``s'' in ``string''
mean:Reports the positions of the object ``s'' in ``string''. <br/>\
``type'' can be <span class="tt">char</span>, <span class="tt">word</span>, <span class="tt">item</span> or\
<span class="tt">line</span>. If it is specified, then the comparison only takes place for\
corresponding objects of `string' which are identical to `s'. <br/>\
corresponding objects of ``string'' which are identical to ``s''. <br/>\
The output of the command is a list of positions (char, word, item or\
line, according to the value of `type') where `s' is found in `string'. <br/>\
If `type' is missing, then `s' is searched in `string' as a substring,\
line, according to the value of ``type'') where ``s'' is found in ``string''. <br/>\
If ``type'' is missing, then ``s'' is searched in ``string'' as a substring,\
and the positions reported are character positions.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/product.phtml
2,9 → 2,9
tit:product
type:$type_both
alias:prod, multiply
syntax:!product `fn' for `v'=`v1' to `v2' [step `st']\
$ !product `fn' for `v' in `v1,v2,v3,...'
mean:Computes the product of a function `fn(v)' with variable `v' replaced \
successively by values `v1', ..., `v2'. <p>\
In the second syntax, the values are given with respect to each item in the list `v1,v2,...'.\
syntax:!product ``fn'' for ``v''=``v1'' to ``v2'' [step ``st'']\
$ !product ``fn'' for ``v'' in ``v1,v2,v3,...''
mean:Computes the product of a function ``fn(v)'' with variable ``v'' replaced \
successively by values ``v1'', ..., ``v2''. <p>\
In the second syntax, the values are given with respect to each item in the list ``v1,v2,...''.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/randchar.phtml
1,6 → 1,5
!! +var+ +random+ +string+
tit:randchar
type:$type_var
syntax:!randchar `str'
mean:Returns a random character in `str'.
 
syntax:!randchar ``str''
mean:Returns a random character in ``str''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/randfile.phtml
2,5 → 2,5
tit:randfile
type:$type_var
alias:randrecord
syntax:!randfile `fname'
mean:Returns a random record in the datafile `fname'.
syntax:!randfile ``fname''
mean:Returns a random record in the datafile ``fname''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/randint.phtml
1,12 → 1,12
!! +var+ +random+
tit:randint
type:$type_var
syntax:!randint `n1', `n2'\
!randint `n1', `n2' repeat `i'
mean:Returns a random integer between `n1' and `n2' (inclusive). <br/>\
Substitution and evaluation are done on `n1' and `n2' before applying random. <br/>\
If `n2' is missing, returns random integer between $(m_pm)1 and `n1' (inclusive). <br/>\
If both `n1' and `n2' are missing, returns 0.\
syntax:!randint ``n1'', ``n2''\
!randint ``n1'', ``n2'' repeat ``i''
mean:Returns a random integer between ``n1'' and ``n2'' (inclusive). <br/>\
Substitution and evaluation are done on ``n1'' and ``n2'' before applying random. <br/>\
If ``n2'' is missing, returns random integer between $(m_pm)1 and ``n1'' (inclusive). <br/>\
If both ``n1'' and ``n2'' are missing, returns 0.\
<br/>\
You can also type <span class="tt">!randint `n1, n2' repeat `i'</span> to repeatedly generate\
`i' random integers.
You can also type <span class="tt">!randint ``n1, n2'' repeat ``i''</span> to repeatedly generate\
``i'' random integers.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/randitem.phtml
1,5 → 1,5
!! +var+ +random+ +string+
tit:randitem
type:$type_var
syntax:!randitem `list'
mean:Returns a random item in `list'. Items are separated by commas.
syntax:!randitem ``list''
mean:Returns a random item in ``list''. Items are separated by commas.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/randline.phtml
1,6 → 1,5
!! +var+ +random+ +string+
tit:randline
type:$type_var
syntax:!randline `str'
mean:Returns a random line in `str'.
 
syntax:!randline ``str''
mean:Returns a random line in ``str''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/random.phtml
2,10 → 2,10
tit:random
type:$type_var
alias:randdouble, randfloat
syntax:!random `n1', `n2'
mean:Returns a random real number between `n1' and `n2'. <br/>\
Substitution and evaluation are done on `n1' and `n2' before applying random. <br/>\
If `n2' is missing, returns random number between 0 and `n1'. <br/>\
If both `n1' and `n2' are missing, returns 0.<br/>\
You can also type <span class="tt">!random `n1',`n2' repeat `i'</span> to repeatedly generate\
`i' random numbers.
syntax:!random ``n1'', ``n2''
mean:Returns a random real number between ``n1'' and ``n2''. <br/>\
Substitution and evaluation are done on ``n1'' and ``n2'' before applying random. <br/>\
If ``n2'' is missing, returns random number between 0 and ``n1''. <br/>\
If both ``n1'' and ``n2'' are missing, returns 0.<br/>\
You can also type <span class="tt">!random ``n1'',``n2'' repeat ``i''</span> to repeatedly generate\
``i'' random numbers.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/randword.phtml
1,6 → 1,6
!! +var+ +random+ +string+
tit:randword
type:$type_var
syntax:!randword `str'
mean:Returns a random word in `str'.
syntax:!randword ``str''
mean:Returns a random word in ``str''.
 
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/rawmath.phtml
1,10 → 1,10
!! +exec+ +var+ +string+
tit:rawmath
type:$type_both
syntax:!rawmath `expr'
mean:Translate the mathematical expression `expr', possibly with common user errors, \
syntax:!rawmath ``expr''
mean:Translate the mathematical expression ``expr'', possibly with common user errors, \
into a machine-understandable mathematical expression. <br/>\
It will replace `(x+1)(x-1)' into `(x+1)*(x-1)', `5x^3' into `5*x^3', etc.\
It will replace ``(x+1)(x-1)'' into ``(x+1)*(x-1)'', ``5x^3'' into ``5*x^3'', etc.\
More precisely,\
<ul><li>\
Replace some badcharacters as **, ², ³.\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/rawmatrix.phtml
1,6 → 1,6
!! +exec+ +var+ +string+
tit:rawmatrix
type:$type_both
syntax:!rawmatrix `expr'
mean:Translate the matrix `expr', possibly with common user errors, \
syntax:!rawmatrix ``expr''
mean:Translate the matrix ``expr'', possibly with common user errors, \
into a machine-understandable matrix expression.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/reaccent.phtml
1,9 → 1,9
!! +exec+ +var+ +string+
tit:reaccent
type:$type_both
syntax:!reaccent `string'
mean:Replace accented letter compositions in `string' by accented letters \
(replacing <span class="tt">e\'</span> by é, <span class="tt">a\`</span> by à,\
syntax:!reaccent ``string''
mean:Replace accented letter compositions in ``string'' by accented letters \
(replacing <span class="tt">e'</span> by é, <span class="tt">a`</span> by à,\
<span class="tt">i"</span> by ï, <span class="tt">o^</span> by ô, etc.)\
The only exception is that ç and Ç are composed from <span class="tt">c~</span>\
and <span class="tt">C~</span> respectivement.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/read.phtml
2,11 → 2,11
tit:read
type:$type_exec
alias:include, input
syntax:!read `file' [`parm']
mean:Insert the content of `file', and process it. `file' must be a valid file name with \
the module\'s home directory as base directory. (directory structure may be specified in `file',\
syntax:!read ``file'' [``parm'']
mean:Insert the content of ``file'', and process it. ``file'' must be a valid file name with \
the module's home directory as base directory. (directory structure may be specified in ``file'',\
but backtracing to parent directories is prohibited.)\
<br/>And the parameter `parm' can be accessed from within\
the called `file' under the variable name `wims_read_parm'.\
<br/>And the parameter ``parm'' can be accessed from within\
the called ``file'' under the variable name ``wims_read_parm''.\
<br/>\
WIMS will try to cache the file for repeated use, unless the filename is preceded by "./".
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/readproc.phtml
1,9 → 1,9
!! +exec+ +jump+
tit:readproc
type:$type_exec
syntax:!readproc `file' [`parm']
mean:Include a variable processing file `file'. `file' must be a valid file name\
with the module\'s home directory as base directory. (directory structure may be specified \
in `file', but backtracing to parent directories is prohibited.)\
<br/>And the parameter `parm' can be accessed from within\
the called `file' under the variable name `wims_read_parm'.
syntax:!readproc ``file'' [``parm'']
mean:Include a variable processing file ``file''. ``file'' must be a valid file name\
with the module's home directory as base directory. (directory structure may be specified \
in ``file'', but backtracing to parent directories is prohibited.)\
<br/>And the parameter ``parm'' can be accessed from within\
the called ``file'' under the variable name ``wims_read_parm''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/record.phtml
2,5 → 2,5
tit:record
type:$type_both
alias:records
syntax:!record `numlist' of `fname'
mean:Outputs selected records of the datafile `fname', according to `numlist'.
syntax:!record ``numlist'' of ``fname''
mean:Outputs selected records of the datafile ``fname'', according to ``numlist''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/recordcnt.phtml
2,5 → 2,5
tit:recordcnt
type:$type_var
alias:recordcount, recordno, recordnum
syntax:!recordcnt `fname'
mean:Returns the number of records in the datafile `fname'.
syntax:!recordcnt ``fname''
mean:Returns the number of records in the datafile ``fname''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/recursion.phtml
1,12 → 1,12
!! +var+ +exec+ +string+
tit:recursion
type:$type_both
syntax:!recursion `fn' for `v'=`v1' to `v2' [step `st']\
$ !recursion `fn' for `v' in `v1,v2,v3,...'
mean:Computes the outcome of a recursion using the function `fn' in which the\
variable `v' is replaced successively by values `v1', ..., `v2'. <p>\
syntax:!recursion ``fn'' for ``v''=``v1'' to ``v2'' [step ``st'']\
$ !recursion ``fn'' for ``v'' in ``v1,v2,v3,...''
mean:Computes the outcome of a recursion using the function ``fn'' in which the\
variable ``v'' is replaced successively by values ``v1'', ..., ``v2''. <p>\
In the second syntax, the values are given with respect to each item in\
the list `v1,v2,...'. </p><p>\
The function `fn' should use the variable `last' to indicate the value of the previous \
the list ``v1,v2,...''. </p><p>\
The function ``fn'' should use the variable ``last'' to indicate the value of the previous \
recursion step. And the starting value can be put into the WIMS variable\
<span class="tt">&#36;recursion_start</span>. </p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/reinput.phtml
1,12 → 1,12
!! +exec+ +var+ +string+
tit:reinput
type:$type_both
syntax:!reinput `string'
mean:Prepares `string' to be inserted into a form input or textarea.\
syntax:!reinput ``string''
mean:Prepares ``string'' to be inserted into a form input or textarea.\
<p>\
Browsers translate &amp; primitives into corresponding (special) characters\
even when these primitives occur in input or textarea fields. Also, if\
`string' contains html tags, they may confuse browsers. You can\
``string'' contains html tags, they may confuse browsers. You can\
use this command on the string (usually derived from an earlier user input)\
before inserting them back into a input or textarea, to avoid the above problems.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/rename.phtml
1,8 → 1,8
!! +var+ +string+
tit:rename
type:$type_both
syntax:!rename `f'
mean:Changes the reference to a file `f', such as a graphics file reachable by direct http, \
syntax:!rename ``f''
mean:Changes the reference to a file ``f'', such as a graphics file reachable by direct http, \
into one with a different name using the method <span class="tt">!getfile</span>.\
<p>\
This command is useful with exercises where important information is carried\
10,8 → 10,8
name of the multimedia file that otherwise would give clues to the solution\
of the problem.\
</p><p>\
The renamed file must be located within the module, and the filename `f' should start \
with `&#36;module_dir'.\
The renamed file must be located within the module, and the filename ``f'' should start \
with ``&#36;module_dir''.\
</p><p>\
The command returns a string which is the new URL. The file is not\
effectively copied or renamed on the server.\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/replace.phtml
1,19 → 1,19
!! +exec+ +var+ +string+
tit:replace
type:$type_both
syntax:!replace [internal] `s1' by `s2' in `string'\
!replace `obj' `ident' by `s' in `string'
syntax:!replace [internal] ``s1'' by ``s2'' in ``string''\
!replace ``obj'' ``ident'' by ``s'' in ``string''
mean:String manipulation. <p>\
Under the first syntax, variable substitution is first done on `string'.\
Then all occurences of substring `s1' are replaced by `s2'. <br/>\
When the keyword `internal' is absent, the Linux utility `sed' is called to make the replacements,\
therefore regular expressions are accepted in `s1' and `s2'.\
Please refer to the man page of `sed' for details. </p><p>\
Under the second syntax, `obj' can be `char', `word', `item' or `line'.\
Then the word, item or line identified by `ident' in `string' is replaced\
by `s', after variable substitutions. <br/>\
`ident' can be a string, in this case all objects (words, items or lines) matching `ident' \
will be replaced. It can also be a number (positive or negative integer `n'), preceded\
by the word `number'. In this case the object number `n' will be replaced.\
Under the first syntax, variable substitution is first done on ``string''.\
Then all occurences of substring ``s1'' are replaced by ``s2''. <br/>\
When the keyword ``internal'' is absent, the Linux utility ``sed'' is called to make the replacements,\
therefore regular expressions are accepted in ``s1'' and ``s2''.\
Please refer to the man page of ``sed'' for details. </p><p>\
Under the second syntax, ``obj'' can be ``char'', ``word'', ``item'' or ``line''.\
Then the word, item or line identified by ``ident'' in ``string'' is replaced\
by ``s'', after variable substitutions. <br/>\
``ident'' can be a string, in this case all objects (words, items or lines) matching ``ident'' \
will be replaced. It can also be a number (positive or negative integer ``n''), preceded\
by the word ``number''. In this case the object number ``n'' will be replaced.\
(In the case where n&lt;0, it is the last -n th object which is replaced.)\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/reset.phtml
1,5 → 1,5
!! +exec+ +vardef+
tit:reset
type:$type_exec
syntax:!reset `name1' [ ,`name2',...]
mean:erase the content of the variable(s) `name1', `name2'...
syntax:!reset ``name1'' [ ,``name2'',...]
mean:erase the content of the variable(s) ``name1'', ``name2''...
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/restart.phtml
1,8 → 1,8
!! +exec+ +html+ +adm+
tit:restart
type:$type_exec; $type_adm
syntax:!restart `parm'
mean:Restart from a new request with parameters `parm', usually for jumping to another module.\
syntax:!restart ``parm''
mean:Restart from a new request with parameters ``parm'', usually for jumping to another module.\
<p>\
This command can be only used before output starts. Repeated restart is disabled, \
to avoid infinite loops.\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/select.phtml
1,9 → 1,9
!! +var+ +exec+ +string+
tit:select
type:$type_both
syntax:!select `data' where `condition'
mean:Outputs rows of a matrix `data', according to `condition'. \
Rows of the matrix can be separated either by new lines or by semi-colon `;'. <p>\
The condition can use words `column 1', `column 2', etc. to\
syntax:!select ``data'' where ``condition''
mean:Outputs rows of a matrix ``data'', according to ``condition''. \
Rows of the matrix can be separated either by new lines or by semi-colon ``;''. <p>\
The condition can use words ``column 1'', ``column 2'', etc. to\
designate comma-separated columns in each row.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/setdef.phtml
1,6 → 1,6
!! +exec+ +vardef+
tit:setdef
type:$type_exec
syntax:!setdef `defstr' in `fname'
mean:Set definitions `defstr' in the file `fname'.
<p> `defstr' maybe multiple line, each being a definition string.</p>
syntax:!setdef ``defstr'' in ``fname''
mean:Set definitions ``defstr'' in the file ``fname''.
<p> ``defstr'' maybe multiple line, each being a definition string.</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/shuffle.phtml
3,14 → 3,14
tit:shuffle
type:$type_var
alias:randperm, randpermute
syntax:!shuffle [even|odd] `n'
!shuffle [even|odd] `list'
mean:Randomly permutes a set of `n' elements. `n' must be a positive integer \
not greater than 1024 in the first usage, or is the number of items in `list' in the second\
syntax:!shuffle [even|odd] ``n''
!shuffle [even|odd] ``list''
mean:Randomly permutes a set of ``n'' elements. ``n'' must be a positive integer \
not greater than 1024 in the first usage, or is the number of items in ``list'' in the second\
usage. <br/>\
For the first usage, the command returns a comma-separated list `i<sub>1</sub>, i<sub>2</sub>, ...,\
i<sub>n</sub>', where the items `i<sub>k</sub>' are\
randomly ordered elements of the set `{1,2,...,n}'. <br/>\
For the first usage, the command returns a comma-separated list ``i<sub>1</sub>, i<sub>2</sub>, ...,\
i<sub>n</sub>'', where the items ``i<sub>k</sub>'' are\
randomly ordered elements of the set ``{1,2,...,n}''. <br/>\
This command can be used in conjunction with commands\
$(ref1)cmdlist_item_&+cmd_choose=all$(ref2)cmdlist_item_">!item</a>,\
$(ref1)cmdlist_line_&+cmd_choose=all$(ref2)cmdlist_line_">!line</a>,\
17,7 → 17,7
$(ref1)cmdlist_word_&+cmd_choose=all$(ref2)cmdlist_word_">!word</a>,\
$(ref1)cmdlist_char_&+cmd_choose=all$(ref2)cmdlist_char_">!char</a>,\
to randomly permute items, lines, words, or characters in a string. <br/>\
For the second usage, a new list with randomly permuted items in `list' is returned. <br/>\
In any case, the variable `wims_shuffle_order' is set to be\
the list `i<sub>1</sub>, i<sub>2</sub>, ..., i<sub>n</sub>'. <br/>\
When the optional word `even' or `odd' is present, only even/odd permutations are produced.
For the second usage, a new list with randomly permuted items in ``list'' is returned. <br/>\
In any case, the variable ``wims_shuffle_order'' is set to be\
the list ``i<sub>1</sub>, i<sub>2</sub>, ..., i<sub>n</sub>''. <br/>\
When the optional word ``even'' or ``odd'' is present, only even/odd permutations are produced.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/singlespace.phtml
1,8 → 1,8
!! +exec+ +var+ +string+
tit:singlespace
type:$type_both
syntax:!singlespace `string'
mean:Returns `string' with all space characters (space, tab, newline) replaced by ` ', \
syntax:!singlespace ``string''
mean:Returns ``string'' with all space characters (space, tab, newline) replaced by `` '', \
and multiple occurrences of space characters collapsed into single one. <br/>\
Leading and ending spaces are not removed. You can use this command in conjunction with\
$(ref1)cmdlist_trim_$(ref2)cmdlist_trim_">trim</a> if you want also to\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/solve.phtml
2,9 → 2,9
tit:solve
type:$type_both
alias:rootof
syntax:!solve `fn' for `v'=`v1' to `v2'
mean:Find out (real simple) roots of the function/equation `fn'\
for the variable `v' between `v1' and`v2'.\
<p>`fn' may have several roots in the interval [v1,v2], but\
syntax:!solve ``fn'' for ``v''=``v1'' to ``v2''
mean:Find out (real simple) roots of the function/equation ``fn''\
for the variable ``v'' between ``v1'' and``v2''.\
<p>``fn'' may have several roots in the interval [v1,v2], but\
roots too close to each other may be overlooked.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/sort.phtml
1,10 → 1,10
!! +exec+ +var+ +string+
tit:sort
type:$type_both
syntax:!sort [nocase] [reverse] [numeric] `type' [of] `string'
mean:Sort `string'. The `type' of the sort may be char, word, list or line. <br/>\
syntax:!sort [nocase] [reverse] [numeric] ``type'' [of] ``string''
mean:Sort ``string''. The ``type'' of the sort may be char, word, list or line. <br/>\
After this command is executed, the sort order is stored in the variable\
`wims_sort_order' (as a list). This can therefore be used\
``wims_sort_order'' (as a list). This can therefore be used\
for relational sorting, in conjunction with commands\
$(ref1)cmdlist_item_&+cmd_choose=all$(ref2)cmdlist_item_">!item</a>,\
$(ref1)cmdlist_line_&+cmd_choose=all$(ref2)cmdlist_line_">!line</a>,\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/sql.bak
1,6 → 1,6
!! +exec+ +var+
tit:sql
type:$type_both
syntax:!sql `SQL command'</span>
syntax:!sql ``SQL command''
mean:Query or manage wims database (modules, user, etc). This command
is only available to privileged modules. (Command no longer available.)
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/sum.phtml
2,9 → 2,9
tit:sum
type:$type_both
alias:add
syntax:!sum `fn' for `v'=`v1' to `v2' [step `st']\
$ !sum `fn' for `v' in `v1,v2,v3,...'
mean:Computes the sum of a function `fn(v)' with variable `v' replaced successively\
by values `v1', ..., `v2'. <p>\
In the second syntax, the values are given with respect to each item in the list `v1,v2,...'.\
syntax:!sum ``fn'' for ``v''=``v1'' to ``v2'' [step ``st'']\
$ !sum ``fn'' for ``v'' in ``v1,v2,v3,...''
mean:Computes the sum of a function ``fn(v)'' with variable ``v'' replaced successively\
by values ``v1'', ..., ``v2''. <p>\
In the second syntax, the values are given with respect to each item in the list ``v1,v2,...''.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/tail.phtml
1,6 → 1,6
!! +exec+ +html+
tit:tail
type:$type_exec
syntax:!tail `parm'
mean:Standardized ending for html page outputs. Includes the command `!homeref'. \
<p>`parm' is reserved for future implementation.</p>
syntax:!tail ``parm''
mean:Standardized ending for html page outputs. Includes the command ``!homeref''. \
<p>``parm'' is reserved for future implementation.</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/texmath.phtml
2,8 → 2,8
tit:texmath
type:$type_both
alias:TeXmath, math2tex
syntax:!texmath `expr'
mean:Translate the mathematical expression `expr' into a TeX source. If the expression \
syntax:!texmath ``expr''
mean:Translate the mathematical expression ``expr'' into a TeX source. If the expression \
is not a "machine-understandable mathematical expression", there is no garanty on the result \
(at the moment and in the future !).\
The transformations made are the following:\
12,7 → 12,7
</li><li>\
Transforms A/B in {1 over B} A or { A over B} according to the priority of\
the presume type of A and B (integer, numeric, variable, poly, transcend).\
</li><li> transforms <=, <=> =>, -> in tex/latex codes.\
</li><li> transforms &lt;=, &lt;=&gt; =&gt;, -&gt; in tex/latex codes.\
</li><li>\
Transforms a relation without a second member by adding 1.\
</li><li>\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/text.phtml
1,93 → 1,93
!! +exec+ +var+ +string+
tit:text
type:$type_both
syntax:!text `operation' `parameter'
syntax:!text ``operation'' ``parameter''
mean:This is intended to be a very powerful text manipulation tool,\
allowing very sophisticated processing of long text strings with high speed. <br/>\
Many of the `operations' accept masks. A mask is a string composed of `0's and `1's. \
Many of the ``operations'' accept masks. A mask is a string composed of ``0''s and ``1''s. \
For operations which accept a mask, only characters at positions whose corresponding\
character in the mask is not a `0' are processed. (In this sense positions\
corresponding to `0's are `masked'.) Empty mask is considered\
as of being entirely composed of `1's. <br/>\
A mask which is too short repeats itself, unless it terminates with a `+',\
in which case it fills the rest with `1's, or with a `-', in which case\
it fills the rest with `0's. <br/>\
For the time being, implemented `operations' are as follows.\
character in the mask is not a ``0'' are processed. (In this sense positions\
corresponding to ``0''s are ``masked''.) Empty mask is considered\
as of being entirely composed of ``1''s. <br/>\
A mask which is too short repeats itself, unless it terminates with a ``+'',\
in which case it fills the rest with ``1''s, or with a ``-'', in which case\
it fills the rest with ``0''s. <br/>\
For the time being, implemented ``operations'' are as follows.\
<ul>\
<li><span class="tt">!text common `text1' and `text2' [mask `maskstring']</span> <br/>\
Extracts characters in `text1' one by one, for those identical\
to the corresponding characters in `text2' and whose\
positions are not masked by `maskstring'.\
</li><li><span class="tt">!text compare `text1' and `text2'\
<li><span class="tt">!text common ``text1'' and ``text2'' [mask ``maskstring'']</span> <br/>\
Extracts characters in ``text1'' one by one, for those identical\
to the corresponding characters in ``text2'' and whose\
positions are not masked by ``maskstring''.\
</li><li><span class="tt">!text compare ``text1'' and ``text2''\
</span> <br/>\
Compares the strings `text1' and `text2' character by character, \
and returns a mask string with `0's onpositions where the corresponding characters in `text1'\
and `text2' are equal, and `1's otherwise.\
</li><li><span class="tt">!text copy `text' [mask `maskstring']</span> <br/>\
Returns non-masked characters in `text'.\
</li><li><span class="tt">!text count `charlist' in `text' [mask `maskstring']</span> <br/>\
Returns the number of characters in `text' whose positions\
are not masked by `maskstring', and who appear in `charlist'.\
</li><li><span class="tt">!text diff `text1' from `text2' [mask `maskstring']</span> <br/>\
Extracts characters in `text1' one by one, for those different to the corresponding \
characters in `text2' and whose positions are not masked by `maskstring'. <br/>\
Compares the strings ``text1'' and ``text2'' character by character, \
and returns a mask string with ``0''s onpositions where the corresponding characters in ``text1''\
and ``text2'' are equal, and ``1''s otherwise.\
</li><li><span class="tt">!text copy ``text'' [mask ``maskstring'']</span> <br/>\
Returns non-masked characters in ``text''.\
</li><li><span class="tt">!text count ``charlist'' in ``text'' [mask ``maskstring'']</span> <br/>\
Returns the number of characters in ``text'' whose positions\
are not masked by ``maskstring'', and who appear in ``charlist''.\
</li><li><span class="tt">!text diff ``text1'' from ``text2'' [mask ``maskstring'']</span> <br/>\
Extracts characters in ``text1'' one by one, for those different to the corresponding \
characters in ``text2'' and whose positions are not masked by ``maskstring''. <br/>\
(Synonyme of diff: differ).\
</li><li><span class="tt">!text expand `text' using `maskstring'\
</li><li><span class="tt">!text expand ``text'' using ``maskstring''\
</span> <br/>\
Produces a string, where positions corresponding to `0's in\
`maskstring' are filled by `&nbsp;' (the space character),\
and where positions corresponding to `1's in `maskstring' are filled by characters of \
`text'. The characters in `text' are used one by one, and the\
resulting string stops when all the characters in `text' are exhausted \
Produces a string, where positions corresponding to ``0''s in\
``maskstring'' are filled by ``&nbsp;'' (the space character),\
and where positions corresponding to ``1''s in ``maskstring'' are filled by characters of \
``text''. The characters in ``text'' are used one by one, and the\
resulting string stops when all the characters in ``text'' are exhausted \
(or when the string reaches the length limit).\
</li><li><span class="tt">!text insert `text1' into `text2' [mask `maskstring']</span> <br/>\
Returns `text2' with non-masked characters replaced by characters `text1'. \
Characters in `text1' are used one by one (without taking into account the masking), and\
the replacement stops when there is no character left in `text1'.\
</li><li><span class="tt">!text interact `text1' and `text2' table `itab' [mask `maskstring']</span> <br/>\
</li><li><span class="tt">!text insert ``text1'' into ``text2'' [mask ``maskstring'']</span> <br/>\
Returns ``text2'' with non-masked characters replaced by characters ``text1''. \
Characters in ``text1'' are used one by one (without taking into account the masking), and\
the replacement stops when there is no character left in ``text1''.\
</li><li><span class="tt">!text interact ``text1'' and ``text2'' table ``itab'' [mask ``maskstring'']</span> <br/>\
Returns a new text which is result of interactions of characters\
in corresponding positions in `text1' and `text2'. The rule of the interaction is defined in\
`itab'. <br/> `itab' contains n+1 lines, each of n characters.\
in corresponding positions in ``text1'' and ``text2''. The rule of the interaction is defined in\
``itab''. <br/> ``itab'' contains n+1 lines, each of n characters.\
The first line defines the characters corresponding to each position\
in the following n lines which defines the multiplication table.\
<br/>\
The multiplication table needs not to be symmetric. In this case, the rows correspond \
to characters in `text1', and the columns correspond to characters in `text2'.\
to characters in ``text1'', and the columns correspond to characters in ``text2''.\
<br/>\
If `text1' or `text2' contains a character not in the first line of `itab', \
If ``text1'' or ``text2'' contains a character not in the first line of ``itab'', \
the interaction at the corresponding position is considered as empty. Also, masked\
positions are ignored.<br/>\
If `text1' and `text2' have different lengths, the longer is cut to fit the shorter.\
</li><li><span class="tt">!text mark `charlist' in `text'</span> <br/>\
Returns a mask string with `1's on positions where the corresponding character in `text' \
appears in `charlist', and with `0's on other positions.\
</li><li><span class="tt">!text max `text1' and `text2' [mask `maskstring']</span> <br/>\
If ``text1'' and ``text2'' have different lengths, the longer is cut to fit the shorter.\
</li><li><span class="tt">!text mark ``charlist'' in ``text''</span> <br/>\
Returns a mask string with ``1''s on positions where the corresponding character in ``text'' \
appears in ``charlist'', and with ``0''s on other positions.\
</li><li><span class="tt">!text max ``text1'' and ``text2'' [mask ``maskstring'']</span> <br/>\
Returns a string which at each position is the character with highest\
ASCII code between corresponding characters in `text1' and `text2'. \
ASCII code between corresponding characters in ``text1'' and ``text2''. \
The length of the result is that of the longest of the two. Masked positions are skipped.\
</li><li><span class="tt">!text min `text1' and `text2' [mask `maskstring']</span> <br/>\
</li><li><span class="tt">!text min ``text1'' and ``text2'' [mask ``maskstring'']</span> <br/>\
Returns a string which at each position is the character with lowest\
ASCII code between corresponding characters in `text1' and `text2'. \
ASCII code between corresponding characters in ``text1'' and ``text2''. \
The length of the result is that of the\
shortest of the two. Masked positions are skipped.\
</li><li><span class="tt">!text occur `charlist' in `text' [mask `maskstring']</span> <br/>\
Returns characters in `charlist' which occur in unmasked positions in `text'. <br/>\
</li><li><span class="tt">!text occur ``charlist'' in ``text'' [mask ``maskstring'']</span> <br/>\
Returns characters in ``charlist'' which occur in unmasked positions in ``text''. <br/>\
(Synonymes of occur: appear, occurrence).\
</li><li><span class="tt">!text remove `charlist' in `text' [mask `maskstring']</span> <br/>\
Returns `text' in which masked characters and characters\
appearing in `charlist' are removed. <br/>(Synonymes of remove: drop, delete).\
</li><li><span class="tt">!text reorder `text' by `orderlist'</span> <br/>\
Returns a reordered `text' using the order list `orderlist'. Reordering is cyclic \
if `orderlist' is shorter than `text'. <br/>\
`orderlist' must be a list of n positive integers, which\
is a permutation of the set {1,...,n}. If `orderlist' contains\
</li><li><span class="tt">!text remove ``charlist'' in ``text'' [mask ``maskstring'']</span> <br/>\
Returns ``text'' in which masked characters and characters\
appearing in ``charlist'' are removed. <br/>(Synonymes of remove: drop, delete).\
</li><li><span class="tt">!text reorder ``text'' by ``orderlist''</span> <br/>\
Returns a reordered ``text'' using the order list ``orderlist''. Reordering is cyclic \
if ``orderlist'' is shorter than ``text''. <br/>\
``orderlist'' must be a list of n positive integers, which\
is a permutation of the set {1,...,n}. If ``orderlist'' contains\
items other than integers within the bound, empty string is returned.\
However, unicity check is not performed on items of `orderlist'.\
</li><li><span class="tt">!text repeat `text' to `len'</span> <br/>\
Repeat the string `text' cyclicly, up to length `len'.\
</li><li><span class="tt">!text reverse `text'</span> <br/>\
Reverse the order of `text', with the last character coming first, etc.\
</li><li><span class="tt">!text select `charlist' in `text' [mask `maskstring']</span> <br/>\
Returns `text' in which masked characters and characters not appearing in \
`charlist' are removed. <br/> (Synonymes of select: pick, pickup).\
However, unicity check is not performed on items of ``orderlist''.\
</li><li><span class="tt">!text repeat ``text'' to ``len''</span> <br/>\
Repeat the string ``text'' cyclicly, up to length ``len''.\
</li><li><span class="tt">!text reverse ``text''</span> <br/>\
Reverse the order of ``text'', with the last character coming first, etc.\
</li><li><span class="tt">!text select ``charlist'' in ``text'' [mask ``maskstring'']</span> <br/>\
Returns ``text'' in which masked characters and characters not appearing in \
``charlist'' are removed. <br/> (Synonymes of select: pick, pickup).\
</li></ul>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/title.phtml
2,5 → 2,5
tit:title
type:$type_exec
alias:htmltitle, wimstitle
syntax:!title `parm'
mean:Puts page\'s title in a standardized format. `parm' is reserved for future implementation.
syntax:!title ``parm''
mean:Puts page's title in a standardized format. ``parm'' is reserved for future implementation.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/translate.phtml
1,12 → 1,12
!! +var+ +exec+ +string+
tit:translate
type:$type_both
syntax:!translate [internal] `s1' to `s2' in `string'\
!translate [internal] `s1' in `string' to `s2'
mean:String manipulation: variable substitution is first done on `string'. \
syntax:!translate [internal] ``s1'' to ``s2'' in ``string''\
!translate [internal] ``s1'' in ``string'' to ``s2''
mean:String manipulation: variable substitution is first done on ``string''. \
Then all occurences of the first (resp. second, ...)\
character of `s1' is replaced by the first (resp. second, ...)\
character of `s2'. <br/>\
When the keyword `internal' is absent, the Linux utility `tr' is called to make the translations,\
therefore regular expressions are accepted in `s1' and `s2'. \
Please refer to the man page of `tr' for details.
character of ``s1'' is replaced by the first (resp. second, ...)\
character of ``s2''. <br/>\
When the keyword ``internal'' is absent, the Linux utility ``tr'' is called to make the translations,\
therefore regular expressions are accepted in ``s1'' and ``s2''. \
Please refer to the man page of ``tr'' for details.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/trim.phtml
1,5 → 1,5
!! +var+ +string+
tit:trim
type:$type_var
syntax:!trim `string'
mean:Returns `string' with leading and trailing spaces stripped off.
syntax:!trim ``string''
mean:Returns ``string'' with leading and trailing spaces stripped off.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/upper.phtml
2,5 → 2,5
tit:upper
type:$type_both
alias:uppercase, toupper
syntax:!upper `string'
mean:Returns `string' with all lower case letters replaced by their uppercase counterparts.
syntax:!upper ``string''
mean:Returns ``string'' with all lower case letters replaced by their uppercase counterparts.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/values.phtml
1,14 → 1,14
!! +var+ +exec+ +string+
tit:values
type:$type_both
syntax:!values `fns' for `v'=`v1' to `v2' [step `st']\
$ !values `fns' for `v' in `v1,v2,v3,...'
mean:Outputs a list of values of `fns' with variable `v' replaced successively by values \
`v1', ..., `v2'. <p>In the second syntax, the values are given with respect \
to each item in the list `v1,v2,...'. </p><p>\
`fns' may be a comma-separated list of functions. </p><p>\
syntax:!values ``fns'' for ``v''=``v1'' to ``v2'' [step ``st'']\
$ !values ``fns'' for ``v'' in ``v1,v2,v3,...''
mean:Outputs a list of values of ``fns'' with variable ``v'' replaced successively by values \
``v1'', ..., ``v2''. <p>In the second syntax, the values are given with respect \
to each item in the list ``v1,v2,...''. </p><p>\
``fns'' may be a comma-separated list of functions. </p><p>\
This command can also be used to make recursions. If the functions\
`fns' contain a variable named `last', this variable\
``fns'' contain a variable named ``last'', this variable\
will take the value of the last step each time. And the starting value\
can be put into the WIMS variable <span class="tt">&#36;recursion_start</span>.\
</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/varlist.phtml
2,7 → 2,7
tit:varlist
type:$type_both
alias:listvar
syntax:!varlist [nofn] `formula'
syntax:!varlist [nofn] ``formula''
mean:Manipulation of mathematical expressions: returns list of variable\
names (and function names) appearing in the `formula'. <p>\
If the switch `nofn' is present, function names will not be listed.</p>
names (and function names) appearing in the ``formula''. <p>\
If the switch ``nofn'' is present, function names will not be listed.</p>
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/warn.phtml
2,7 → 2,6
tit:warn
type:$type_exec
alias:warning
syntax:!warn `subject'
mean:Outputs a warning message related to `subject'. Does nothing if no warning \
message about `subject' is present.
 
syntax:!warn ``subject''
mean:Outputs a warning message related to ``subject''. Does nothing if no warning \
message about ``subject'' is present.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/while.phtml
1,12 → 1,12
!! +exec+ +jump+
tit:while
type:$type_exec
syntax:!while `string1 relation string2'<br/>
syntax:!while ``string1 relation string2''<br/>
... (multi-line content)<br/>
!endwhile
mean:Conditional branching: execute the multi-line content between\
`!while' line and `!endwhile' line, until `relation' is no longer verified.\
The leading and trailing spaces of `string1' and `string2' will be stripped\
``!while'' line and ``!endwhile'' line, until ``relation'' is no longer verified.\
The leading and trailing spaces of ``string1'' and ``string2'' will be stripped\
before making comparisons.\
<p>\
The syntax is the same as for\
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/whileval.phtml
2,5 → 2,5
tit:whileval
type:$type_exec
syntax:Same as the command $(ref1)cmdlist_while_$(ref2)cmdlist_while_">while</a>,\
but `=' (`=='), `!=' compares the numerical values of `string1' and `string2'\
but ``='' (``==''), ``!='' compares the numerical values of ``string1'' and ``string2''\
rather than the strings themselves.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/word.phtml
2,5 → 2,5
tit:word
type:$type_both
alias:words
syntax:!word `numlist' of `string'
mean:Outputs selected words of `string', according to `numlist'.
syntax:!word ``numlist'' of ``string''
mean:Outputs selected words of ``string'', according to ``numlist''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/wordcnt.phtml
2,5 → 2,5
tit:wordcnt
type:$type_var
alias:wordcount, wordno, wordnum
syntax:!wordcnt `string'
mean:Returns the number of words in `string'.
syntax:!wordcnt ``string''
mean:Returns the number of words in ``string''.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/words2items.phtml
2,5 → 2,5
tit:words2items
type:$type_both
alias:wordstoitems, words2list, wordstolist
syntax:!words2items `string'
mean:This command changes multiple words in `string' into multiple items.
syntax:!words2items ``string''
mean:This command changes multiple words in ``string'' into multiple items.
/trunk/wims/public_html/modules/help/wimsdoc.en/cmd/words2lines.phtml
2,5 → 2,5
tit:words2lines
type:$type_both
alias:wordstolines
syntax:!words2lines `string'
mean:This command changes multiple words in `string' into multiple lines.
syntax:!words2lines ``string''
mean:This command changes multiple words in ``string'' into multiple lines.