Subversion Repositories wimsdev

<h4>Definition and substitution of variables</h4>

<h4>Definition and substitution of variables</h4>

$(ref1)cmdlist_eval_&+cmd_choose=all$(ref2)cmdlist_eval_">!eval</a>.

$(ref1)cmdlist_eval_&+cmd_choose=all$(ref2)cmdlist_eval_">!eval</a>.

<p>

<p>

A variable may be defined or modified in a variable processing file, or by

A variable may be defined or modified in a variable processing file, or by

$(ref1)cmdlist_let_&+cmd_choose=all$(ref2)cmdlist_let_">!let</a> and

$(ref1)cmdlist_let_&+cmd_choose=all$(ref2)cmdlist_let_">!let</a> and

$(ref1)cmdlist_default_&+cmd_choose=all$(ref2)cmdlist_default_">!default</a>.

$(ref1)cmdlist_default_&+cmd_choose=all$(ref2)cmdlist_default_">!default</a>.

</p><p>

</p><p>

Variable names can contain any alphanumeric character, as well as the

Variable names can contain any alphanumeric character, as well as the

underscore character $(emph)_$emphend. There is a limit to the length of

underscore character $(emph)_$emphend. There is a limit to the length of

  $(emph)a1$emphend has value $(emph)3$emphend and <br/>

  $(emph)a1$emphend has value $(emph)3$emphend and <br/>

  $(emph)a2$emphend has value $(emph)pi$emphend, <br/>

  $(emph)a2$emphend has value $(emph)pi$emphend, <br/>

  then the string<pre>

  then the string<pre>

  $$(a$$[$$i-1])*x+$$(a$$[$$i-2])</pre>will become<pre>

  $$(a$$[$$i-1])*x+$$(a$$[$$i-2])</pre>will become<pre>

  pi*x+3</pre>after substitution.

  pi*x+3</pre>after substitution.

  $emph$$$emphend, this value will again be substituted, until no more

  $emph$$$emphend, this value will again be substituted, until no more

  substitution is needed. The server has a built-in limit of nested

  substitution is needed. The server has a built-in limit of nested

  substitutions; infinite nested substitions will violate this limit and

  substitutions; infinite nested substitions will violate this limit and

  generate an error message.

  generate an error message.

  </li>

  </li>

  original meaning will be lost.

  original meaning will be lost.

 </li><li>The variable $emph module_dir$emphend has a value preset to the directory

 </li><li>The variable $emph module_dir$emphend has a value preset to the directory

  of the current module (with respect to the public home directory of the

  of the current module (with respect to the public home directory of the

  server). This value is usually $emph $$module_dir=module/$$module $emphend

  server). This value is usually $emph $$module_dir=module/$$module $emphend

  (but may vary with the config of the installation).

  (but may vary with the config of the installation).

  meanings: they are used to hold variables defined in the module's INDEX

  meanings: they are used to hold variables defined in the module's INDEX

  file. Currently implemented variables:

  file. Currently implemented variables:

  $table_header

  $table_header

  $table_tr<th> Variables</th><th>Meaning</th></tr>

  $table_tr<th> Variables</th><th>Meaning</th></tr>

   $table_tr<td>$emph module_keywords$emphend</td><td>keywords, to be placed in the html header</td></tr>

   $table_tr<td>$emph module_keywords$emphend</td><td>keywords, to be placed in the html header</td></tr>

   $table_tr<td>$emph module_scoring$emphend</td><td>= yes if the module gives scores according to wims standard</td></tr>

   $table_tr<td>$emph module_scoring$emphend</td><td>= yes if the module gives scores according to wims standard</td></tr>

   $table_tr<td>$emph module_data$emphend</td><td>address of datamodule</td></tr>

   $table_tr<td>$emph module_data$emphend</td><td>address of datamodule</td></tr>

  </table>

  </table>

  $emph module_has_help$emphend and

  $emph module_has_help$emphend and

  $emph module_has_about$emphend

  $emph module_has_about$emphend

  have value "yes" if the module's directory contains the respective

  have value "yes" if the module's directory contains the respective

  .phtml file. These variables are used in the command <span class="tt">!homeref</span>.

  .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

 </li><li>Certain environment variables setup by httpd are readable by wims

  modules under names starting with $emph httpd_$emphend. For example, the

  modules under names starting with $emph httpd_$emphend. For example, the

  $emph httpd_REMOTE_HOST$emphend under wims. <br/>

  $emph httpd_REMOTE_HOST$emphend under wims. <br/>

  Please refer to httpd protocol specifications for details of such variables.

  Please refer to httpd protocol specifications for details of such variables.

 </li><li>All variable names starting with $emph ins_$emphend, $emph

 </li><li>All variable names starting with $emph ins_$emphend, $emph

  insplot_$emphend, $emph instex_$emphend will have special meanings for the

  insplot_$emphend, $emph instex_$emphend will have special meanings for the

  corresponding dynamic insertion engines. A module should read or write them

  corresponding dynamic insertion engines. A module should read or write them