Subversion Repositories wimsdev

Compare Revisions

Ignore whitespace Rev 7808 → Rev 7809

/trunk/wims/public_html/modules/help/wimsdoc.en/variables.phtml
1,12 → 1,12
!read tabletheme
<h4>Definition and substitution of variables</h4>
 
Wims variables has only one type: they are all string variables. Numerical
evaluation can be done on variables via the variable command
Wims variables have only one type: they are all string variables. Numerical
evaluation can be done on variables via the variable command
$(ref1)cmdlist_eval_&+cmd_choose=all$(ref2)cmdlist_eval_">!eval</a>.
<p>
A variable may be defined or modified in a variable processing file, or by
the commands
the commands
$(ref1)cmdlist_let_&+cmd_choose=all$(ref2)cmdlist_let_">!let</a> and
$(ref1)cmdlist_default_&+cmd_choose=all$(ref2)cmdlist_default_">!default</a>.
</p><p>
63,7 → 63,7
then the string<pre>
$$(a$$[$$i-1])*x+$$(a$$[$$i-2])</pre>will become<pre>
pi*x+3</pre>after substitution.
</li><li>If the value of a variable being substituted contains the character
</li><li>If the value of a variable being substituted contains the character
$emph$$$emphend, this value will again be substituted, until no more
substitution is needed. The server has a built-in limit of nested
substitutions; infinite nested substitions will violate this limit and
103,7 → 103,7
of the current module (with respect to the public home directory of the
server). This value is usually $emph $$module_dir=module/$$module $emphend
(but may vary with the config of the installation).
</li><li>Variable names starting with $emph module_$emphend will have special
</li><li>Variable names starting with $emph module_$emphend will have special
meanings: they are used to hold variables defined in the module's INDEX
file. Currently implemented variables:
 
129,7 → 129,7
$table_tr<td>$emph module_data$emphend</td><td>address of datamodule</td></tr>
 
</table>
Also, variables $emph module_has_intro$emphend,
Also, variables $emph module_has_intro$emphend,
$emph module_has_help$emphend and
$emph module_has_about$emphend
have value "yes" if the module's directory contains the respective
136,7 → 136,7
.phtml file. These variables are used in the command <span class="tt">!homeref</span>.
</li><li>Certain environment variables setup by httpd are readable by wims
modules under names starting with $emph httpd_$emphend. For example, the
environment variable $emph REMOTE_HOST$emphend becomes
environment variable $emph REMOTE_HOST$emphend becomes
$emph httpd_REMOTE_HOST$emphend under wims. <br/>
Please refer to httpd protocol specifications for details of such variables.
</li><li>All variable names starting with $emph ins_$emphend, $emph