Subversion Repositories wimsdev

Rev

Rev 1091 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

  1. !set var_lst=<li>The variable $emph
  2.  
  3. <h4>Variables for general purposes by wims server</h4>
  4. <ul>
  5.  $var_lst wims_exec_error$emphend is used to store error messages
  6.   of the external program called by
  7.   $(ref1)cmdlist_exec_&cmd_choose=all$(ref2)cmdlist_exec_>!exec</a>.
  8.   For this reason,
  9.   this variable will be overwritten each time a $emph!exec$emphend
  10.   command is executed.
  11.  $var_lst wims_module_log$emphend is used for individual
  12.   module's log files: if this variable is non-empty, wims.cgi will put its
  13.  content into the module's log file, at the end of the process of the
  14.   user request.
  15.  $var_lst wims_version$emphend has a value preset to the
  16.   current version of the wims server.
  17.  $var_lst wims_version_date$emphend has a value preset to the
  18.   last compile date of the server program.
  19.  $var_lst wims_site_manager$emphend contains the electronic address of the
  20.   site manager, as defined in the configuration file
  21.   $emph wims.conf$emphend of the site. Modules should not modify this
  22.   variable.
  23.  $var_lst wims_print_precision$emphend defines the printing precision when a
  24.   result of evaluation (via <tt>!eval</tt> or <tt>$[...]</tt>) is converted to
  25.   a character string. Default value: $emph$wims_print_precision$emphend
  26.   (may be modified in wims.conf).
  27.  $var_lst wims_warn_$emphend... is ...
  28.  $var_lst wims_compare_precision$emphend is used to define error tolerance
  29.   when wims compares two numerical values. Formula: <tt>!ifval a=b</tt> will
  30.   return TRUE if <center>
  31.   abs(a-b)*$$wims_compare_precision&lt;abs(a+b)+1/$$wims_compare_precision. </center>
  32.   Default value: $emph$wims_compare_precision$emphend (may be modified in wims.conf).
  33.  $var_lst wims_texsize$emphend can be used to modify TeX sizes for the
  34.   module. Default value is 0 (no change). Maybe 1,2,... (increase TeX size) or
  35.   -1,-2... (decrease TeX size).
  36.  $var_lst wims_homeref_parm$emphend is reserved for future use in the command
  37.   <tt>!homeref</tt>.
  38.  $var_list wims_homeref_bgcolor$emphend is...
  39.  $var_list wims_rawmath_functions$emphend is used to tell rawmath routine that
  40.   the words contained in the variable value should be treated as function names.
  41.   These words can be separated either by white space or by comma.
  42.  $var_list wims_rawmath_variables$emphend is used to tell rawmath routine that
  43.   the words contained in the variable value should be treated as math variable
  44.   names. These words can be separated either by white space or by comma.
  45.  $var_lst wims_ref_target$emphend defines the target of the command
  46.   <tt>!href, !homeref, !form</tt>. Its value is <b>not</b> automatically
  47.   reset to empty after the commands. (Defaults to empty string, meaning that
  48.   the target is the current document.)
  49.  $var_lst wims_html_header$emphend is the standardised html header for all
  50.   its modules' html outputs. Its value is defined in the file
  51.  html/header.phtml. It is highly recommended that modules use this variable
  52.  to define their html headers.
  53. $var_lst wims_expire$emphend is used to define expiration dates of the
  54.  pages sent to clients. Don't touch it if you don't know what this means.
  55. $var_lst module_init_parm$emphend is...
  56. </ul>
  57.  
  58. <hr><h4>Variables reserved for dynamic insertions</h4>
  59. !set resetyes=<br>This variable is reset to empty after a dynamic insertion.
  60. <ul>
  61. $var_lst ins_align$emphend defines the manner in which the inline picture
  62.  is aligned with respect to the line. Possible values: bottom, middle or top.
  63.  Default is empty (which means bottom).
  64. $var_lst ins_attr$emphend is used to define miscallaneous attributes of a
  65.  dynamic insertion. Examples:
  66.  <pre>  ins_attr = align=middle</pre>
  67.  (aligns the middle of the image with the baseline for the current
  68.  textline), or
  69.  <pre>  ins_attr = ismap</pre>
  70.  (coordinates of the click will be passed back to the server; if the link
  71.  of the element is the wims server, the coordinates will be registered
  72.  under the variable $emph no_name$emphend.)
  73.  $resetyes
  74. $var_lst ins_border$emphend is used to define border width of the html
  75.  element $emph IMG $emphend
  76.  resulted from the dynamic insertion. Its value should be a positive
  77.  number.
  78.  $resetyes
  79. $var_lst ins_density$emphend is used to define the density of the dynamic
  80.  insertions. Default value: $emph 100x100 $emphend.
  81.  <br>
  82.  <b><font color=red>Avoid using this variable!</font></b> We are planning to
  83.  suppress it. Will be replaced by a server-managed variable.
  84. $var_lst ins_format$emphend can be used to determine the format of the
  85.  graphics file of the dynamic insertion: its value should be either $emph
  86.  gif$emphend or $emph jpg$emphend. The default value of this variable is
  87.  $emph gif$emphend (which can be changed by modifying the file $emph
  88.  wims.conf$emphend; but such change is not recommended). <br>
  89.  Some types of dynamic insertions may not be affected by this variable.
  90. $var_lst ins_quality$emphend is used to define quality of the graphics
  91.  convertion used in dynamic insertions. Its value should be between 0 and
  92.  100. Affects only dynamic insertions whose graphics format is jpg.
  93. $var_lst ins_tag$emphend is used for dynamic insertions within a form.
  94.  In this case define<br>
  95.  <tt>ins_tag=form </tt>$emph name$emphend<br>
  96.  where $emph name$emphend is the name of the html element $emph IMG $emphend
  97.  within the form (optional).
  98.  $resetyes
  99.  <p>
  100. $var_lst insdraw_size$emphend is ...
  101.  <p>
  102. $var_lst insplot_data$emphend is ...
  103. $var_lst insplot_font$emphend is ...
  104. $var_lst insplot_set $emphend is ...
  105. $var_lst insplot_split$emphend is ...
  106. $var_lst insplot_transparent$emphend is used to define transparent color
  107.  for insertions. Default is empty (no transparency). Usual value: 255,255,255
  108.  (white is transparent).
  109. </ul>
  110.  
  111. !! module_about
  112. !! module_about_bgcolor
  113. !! ins_anim_loop
  114. !! ins_anim_delay
  115. !! ins_anim_frames
  116.  
  117.