Subversion Repositories wimsdev

Rev

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

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