WebSVN – wimsdev – Diff – /trunk/wims/public_html/modules/help/wimsdoc.en/variables.phtml



  and the variable $(emph)alpha3beta$emphend has value $(emph)pi$emphend,
  the string<pre>3*$$(alpha$$(i)beta)*x</pre>
  will become<pre>3*pi*x</pre>
  after substitution.
  <p>
  Array addressing: if the variable $(emph)i$emphend contains a
  comma-separated list $(emph)a,b,c,d,e$emphend, then the string
  <span class="tt">$$(i[3])</span> gives <span class="tt">c</span> after substitution, and
  <span class="tt">$$(i[2 to 4])</span> gives <span class="tt">b,c,d</span>, etc.
  </p><p>
  Two-dimensional array addressing is also available: if</p>
  <pre>$$M=x,y,z;a,b,c</pre>
  (a 2x3 matrix), then
  <pre>$$(M[1;3,2])=z,y</pre>

  reserved for future enhancements of the language.
 </li><li>Variables named
  !for i in cmd,module,session,lang,special_parm,user,useropts,worksheet
   $emph$i$emphend,
  !next i
  are reserved for special parameter passed by the user. A module's variable
  processing file or phtml file can read but cannot set them. <br/>
  Refer to the section $emph$title_structure$emphend for the meaning of
  these variables.
 </li><li>The variable $emph no_name$emphend has a special use: <br/>
  Parameters in the user query string with no name (for example when the
  coordinate of a mappable image is passed this way to the http server) will

  $table_tr<th> Variables</th><th>Meaning</th></tr>
   $table_tr<td>$emph module_title$emphend</td><td>title of the module</td></tr>
   $table_tr<td>$emph module_description$emphend</td><td>short description of the module</td></tr>
   $table_tr<td>$emph module_author$emphend</td><td>name(s) of author(s) of the module</td></tr>
   $table_tr<td>$emph module_address$emphend</td><td>e-mail address of the (principal) author</td></tr>
   $table_tr<td>$emph module_maintainer$emphend</td><td>name of the current maintainer</td></tr>
   $table_tr<td>$emph module_maintainer_address$emphend</td><td>e-mail address of the maintainer</td></tr>
   $table_tr<td>$emph module_copyright$emphend</td><td>copyright notice of the module</td></tr>
   $table_tr<td>$emph module_version$emphend</td><td>current version of the module</td></tr>
   $table_tr<td>$emph module_wims_version$emphend</td><td>minimal wims version required<br/>
        to run this module</td></tr>

   $table_tr<td>$emph module_domain$emphend</td><td>algebra, analysis, geometry, ...</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_data$emphend</td><td>address of datamodule</td></tr>
 
  $table_end
  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
  .phtml file. These variables are used in the command <span class="tt">!homeref</span>.
 </li><li>Some 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
  $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

Subversion Repositories wimsdev

(root)/trunk/wims/public_html/modules/help/wimsdoc.en/variables.phtml – Rev 7809 → 15649

Rev 7809		Rev 15649
Line 38...		Line 38...
38	and the variable $(emph)alpha3beta$emphend has value $(emph)pi$emphend,	38	and the variable $(emph)alpha3beta$emphend has value $(emph)pi$emphend,
39	the string<pre>3$$(alpha$$(i)beta)x</pre>	39	the string<pre>3$$(alpha$$(i)beta)x</pre>
40	will become<pre>3pix</pre>	40	will become<pre>3pix</pre>
41	after substitution.	41	after substitution.
42	<p>	42	<p>
43	Array addressing: if the variable $(emph)l$emphend contains a	43	Array addressing: if the variable $(emph)i$emphend contains a
44	comma-separated list $(emph)a,b,c,d,e$emphend, then the string	44	comma-separated list $(emph)a,b,c,d,e$emphend, then the string
45	<span class="tt">$$(i[3])</span> gives <span class="tt">c</span> after substitution, and	45	<span class="tt">$$(i[3])</span> gives <span class="tt">c</span> after substitution, and
46	<span class="tt">$$(i[2 to 4])</span> ~~tives~~ <span class="tt">b,c,d</span>, etc.	46	<span class="tt">$$(i[2 to 4])</span> gives <span class="tt">b,c,d</span>, etc.
47	</p><p>	47	</p><p>
48	Two-dimensional array addressing is also available: if</p>	48	Two-dimensional array addressing is also available: if</p>
49	<pre>$$M=x,y,z;a,b,c</pre>	49	<pre>$$M=x,y,z;a,b,c</pre>
50	(a 2x3 matrix), then	50	(a 2x3 matrix), then
51	<pre>$$(M[1;3,2])=z,y</pre>	51	<pre>$$(M[1;3,2])=z,y</pre>
Line 82...		Line 82...
82	reserved for future enhancements of the language.	82	reserved for future enhancements of the language.
83	</li><li>Variables named	83	</li><li>Variables named
84	!for i in cmd,module,session,lang,special_parm,user,useropts,worksheet	84	!for i in cmd,module,session,lang,special_parm,user,useropts,worksheet
85	$emph$i$emphend,	85	$emph$i$emphend,
86	!next i	86	!next i
87	are reserved for special parameter ~~passing~~ by the user. A module's variable	87	are reserved for special parameter passed by the user. A module's variable
88	processing ~~files~~ or phtml ~~files~~ can read but cannot set them. <br/>	88	processing file or phtml file can read but cannot set them. <br/>
89	Refer to the section $emph$title_structure$emphend for the meaning of	89	Refer to the section $emph$title_structure$emphend for the meaning of
90	these variables.	90	these variables.
91	</li><li>The variable $emph no_name$emphend has a special use: <br/>	91	</li><li>The variable $emph no_name$emphend has a special use: <br/>
92	Parameters in the user query string with no name (for example when the	92	Parameters in the user query string with no name (for example when the
93	coordinate of a mappable image is passed this way to the http server) will	93	coordinate of a mappable image is passed this way to the http server) will
Line 111...		Line 111...
111	$table_tr<th> Variables</th><th>Meaning</th></tr>	111	$table_tr<th> Variables</th><th>Meaning</th></tr>
112	$table_tr<td>$emph module_title$emphend</td><td>title of the module</td></tr>	112	$table_tr<td>$emph module_title$emphend</td><td>title of the module</td></tr>
113	$table_tr<td>$emph module_description$emphend</td><td>short description of the module</td></tr>	113	$table_tr<td>$emph module_description$emphend</td><td>short description of the module</td></tr>
114	$table_tr<td>$emph module_author$emphend</td><td>name(s) of author(s) of the module</td></tr>	114	$table_tr<td>$emph module_author$emphend</td><td>name(s) of author(s) of the module</td></tr>
115	$table_tr<td>$emph module_address$emphend</td><td>e-mail address of the (principal) author</td></tr>	115	$table_tr<td>$emph module_address$emphend</td><td>e-mail address of the (principal) author</td></tr>
116	$table_tr<td>$emph module_maintainer$emphend</td><td>name of the ~~actual~~ maintainer</td></tr>	116	$table_tr<td>$emph module_maintainer$emphend</td><td>name of the current maintainer</td></tr>
117	$table_tr<td>$emph module_maintainer_address$emphend</td><td>e-mail address of the maintainer</td></tr>	117	$table_tr<td>$emph module_maintainer_address$emphend</td><td>e-mail address of the maintainer</td></tr>
118	$table_tr<td>$emph module_copyright$emphend</td><td>copyright notice of the module</td></tr>	118	$table_tr<td>$emph module_copyright$emphend</td><td>copyright notice of the module</td></tr>
119	$table_tr<td>$emph module_version$emphend</td><td>current version of the module</td></tr>	119	$table_tr<td>$emph module_version$emphend</td><td>current version of the module</td></tr>
120	$table_tr<td>$emph module_wims_version$emphend</td><td>minimal wims version required<br/>	120	$table_tr<td>$emph module_wims_version$emphend</td><td>minimal wims version required<br/>
121	to run this module</td></tr>	121	to run this module</td></tr>
Line 126...		Line 126...
126	$table_tr<td>$emph module_domain$emphend</td><td>algebra, analysis, geometry, ...</td></tr>	126	$table_tr<td>$emph module_domain$emphend</td><td>algebra, analysis, geometry, ...</td></tr>
127	$table_tr<td>$emph module_keywords$emphend</td><td>keywords, to be placed in the html header</td></tr>	127	$table_tr<td>$emph module_keywords$emphend</td><td>keywords, to be placed in the html header</td></tr>
128	$table_tr<td>$emph module_scoring$emphend</td><td>= yes if the module gives scores according to wims standard</td></tr>	128	$table_tr<td>$emph module_scoring$emphend</td><td>= yes if the module gives scores according to wims standard</td></tr>
129	$table_tr<td>$emph module_data$emphend</td><td>address of datamodule</td></tr>	129	$table_tr<td>$emph module_data$emphend</td><td>address of datamodule</td></tr>
130		130
131	~~</table>~~	131	$table_end
132	Also, variables $emph module_has_intro$emphend,	132	Also, variables $emph module_has_intro$emphend,
133	$emph module_has_help$emphend and	133	$emph module_has_help$emphend and
134	$emph module_has_about$emphend	134	$emph module_has_about$emphend
135	have value "yes" if the module's directory contains the respective	135	have value "yes" if the module's directory contains the respective
136	.phtml file. These variables are used in the command <span class="tt">!homeref</span>.	136	.phtml file. These variables are used in the command <span class="tt">!homeref</span>.
137	</li><li>~~Certain~~ environment variables setup by httpd are readable by wims	137	</li><li>Some environment variables setup by httpd are readable by wims
138	modules under names starting with $emph httpd_$emphend. For example, the	138	modules under names starting with $emph httpd_$emphend. For example, the
139	environment variable $emph REMOTE_HOST$emphend becomes	139	environment variable $emph REMOTE_HOST$emphend becomes
140	$emph httpd_REMOTE_HOST$emphend under wims. <br/>	140	$emph httpd_REMOTE_HOST$emphend under wims. <br/>
141	Please refer to httpd protocol specifications for details of such variables.	141	Please refer to httpd protocol specifications for details of such variables.
142	</li><li>All variable names starting with $emph ins_$emphend, $emph	142	</li><li>All variable names starting with $emph ins_$emphend, $emph