Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_ssi_module.xml @ 966:95c3c3bbf1ce

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Text review.
author Egor Nikitin <yegor.nikitin@gmail.com>
date Wed, 14 Aug 2013 12:03:41 +0400
parents ae785c6aaa91
children f09f77ef45e9
comparison
equal deleted inserted replaced
965:fadccc156188 966:95c3c3bbf1ce
62 <context>server</context> 62 <context>server</context>
63 <context>location</context> 63 <context>location</context>
64 <appeared-in>1.5.1</appeared-in> 64 <appeared-in>1.5.1</appeared-in>
65 65
66 <para> 66 <para>
67 Allows to preserve the <header>Last-Modified</header> header field 67 Allows preserving the <header>Last-Modified</header> header field
68 from the original response during SSI processing 68 from the original response during SSI processing
69 to facilitate response caching. 69 to facilitate response caching.
70 </para> 70 </para>
71 71
72 <para> 72 <para>
100 <context>http</context> 100 <context>http</context>
101 <context>server</context> 101 <context>server</context>
102 <context>location</context> 102 <context>location</context>
103 103
104 <para> 104 <para>
105 Allows to suppress output of the string 105 If enabled, suppresses the output of the
106 “<literal>[an error occurred while processing the directive]</literal>” 106 “<literal>[an error occurred while processing the directive]</literal>”
107 if an error occurred during SSI processing. 107 string if an error occurred during SSI processing.
108 </para> 108 </para>
109 109
110 </directive> 110 </directive>
111 111
112 112
132 <context>http</context> 132 <context>http</context>
133 <context>server</context> 133 <context>server</context>
134 <context>location</context> 134 <context>location</context>
135 135
136 <para> 136 <para>
137 Sets the maximum length for values of parameters in SSI commands. 137 Sets the maximum length of parameter values in SSI commands.
138 </para> 138 </para>
139 139
140 </directive> 140 </directive>
141 141
142 </section> 142 </section>
214 The command has the following parameters: 214 The command has the following parameters:
215 215
216 <list type="tag"> 216 <list type="tag">
217 <tag-name><literal>var</literal></tag-name> 217 <tag-name><literal>var</literal></tag-name>
218 <tag-desc> 218 <tag-desc>
219 variable name. 219 the variable name.
220 </tag-desc> 220 </tag-desc>
221 221
222 <tag-name><literal>encoding</literal></tag-name> 222 <tag-name><literal>encoding</literal></tag-name>
223 <tag-desc> 223 <tag-desc>
224 encoding method. 224 the encoding method.
225 Possible values include <literal>none</literal>, <literal>url</literal>, and 225 Possible values include <literal>none</literal>, <literal>url</literal>, and
226 <literal>entity</literal>. 226 <literal>entity</literal>.
227 By default, <literal>entity</literal> is used. 227 By default, <literal>entity</literal> is used.
228 </tag-desc> 228 </tag-desc>
229 229
230 <tag-name><literal>default</literal></tag-name> 230 <tag-name><literal>default</literal></tag-name>
231 <tag-desc> 231 <tag-desc>
232 non-standard parameter that sets a string to be output 232 a non-standard parameter that sets a string to be output
233 if a variable is undefined. 233 if a variable is undefined.
234 By default, “<literal>none</literal>” is output. 234 By default, “<literal>none</literal>” is output.
235 The command 235 The command
236 <example> 236 <example>
237 &lt;!--# echo var="name" default="<emphasis>no</emphasis>" --&gt; 237 &lt;!--# echo var="name" default="<emphasis>no</emphasis>" --&gt;
337 parameter should be used. 337 parameter should be used.
338 </tag-desc> 338 </tag-desc>
339 339
340 <tag-name><literal>stub</literal></tag-name> 340 <tag-name><literal>stub</literal></tag-name>
341 <tag-desc> 341 <tag-desc>
342 non-standard parameter that names the block whose 342 a non-standard parameter that names the block whose
343 content will be output if an included request results in an empty 343 content will be output if the included request results in an empty
344 body or if an error occurs during request processing, for example: 344 body or if an error occurs during the request processing, for example:
345 <example> 345 <example>
346 &lt;!--# block name="one" --&gt;&amp;nbsp;&lt;!--# endblock --&gt; 346 &lt;!--# block name="one" --&gt;&amp;nbsp;&lt;!--# endblock --&gt;
347 &lt;!--# include virtual="/remote/body.php?argument=value" stub="one" --&gt; 347 &lt;!--# include virtual="/remote/body.php?argument=value" stub="one" --&gt;
348 </example> 348 </example>
349 The replacement block content is processed in the included request context. 349 The replacement block content is processed in the included request context.
350 </tag-desc> 350 </tag-desc>
351 351
352 <tag-name><literal>wait</literal></tag-name> 352 <tag-name><literal>wait</literal></tag-name>
353 <tag-desc> 353 <tag-desc>
354 non-standard parameter that instructs to wait for a request to fully 354 a non-standard parameter that instructs to wait for a request to fully
355 complete before continuing with SSI processing, for example: 355 complete before continuing with SSI processing, for example:
356 <example> 356 <example>
357 &lt;!--# include virtual="/remote/body.php?argument=value" wait="yes" --&gt; 357 &lt;!--# include virtual="/remote/body.php?argument=value" wait="yes" --&gt;
358 </example> 358 </example>
359 </tag-desc> 359 </tag-desc>
360 360
361 <tag-name><literal>set</literal></tag-name> 361 <tag-name><literal>set</literal></tag-name>
362 <tag-desc> 362 <tag-desc>
363 non-standard parameter that instructs to write a successful result 363 a non-standard parameter that instructs to write a successful result
364 of request processing to the specified variable, 364 of request processing to the specified variable,
365 for example: 365 for example:
366 <example> 366 <example>
367 &lt;!--# include virtual="/remote/body.php?argument=value" set="one" --&gt; 367 &lt;!--# include virtual="/remote/body.php?argument=value" set="one" --&gt;
368 </example> 368 </example>
383 The command has the following parameters: 383 The command has the following parameters:
384 384
385 <list type="tag"> 385 <list type="tag">
386 <tag-name><literal>var</literal></tag-name> 386 <tag-name><literal>var</literal></tag-name>
387 <tag-desc> 387 <tag-desc>
388 variable name. 388 the variable name.
389 </tag-desc> 389 </tag-desc>
390 390
391 <tag-name><literal>value</literal></tag-name> 391 <tag-name><literal>value</literal></tag-name>
392 <tag-desc> 392 <tag-desc>
393 variable value. 393 the variable value.
394 If an assigned value contains variables, 394 If an assigned value contains variables,
395 their values are substituted. 395 their values are substituted.
396 </tag-desc> 396 </tag-desc>
397 </list> 397 </list>
398 398
411 two embedded variables: 411 two embedded variables:
412 <list type="tag"> 412 <list type="tag">
413 413
414 <tag-name><var>$date_local</var></tag-name> 414 <tag-name><var>$date_local</var></tag-name>
415 <tag-desc> 415 <tag-desc>
416 current time in local time zone. 416 current time in the local time zone.
417 The format is set by the <literal>config</literal> command 417 The format is set by the <literal>config</literal> command
418 with the <literal>timefmt</literal> parameter. 418 with the <literal>timefmt</literal> parameter.
419 </tag-desc> 419 </tag-desc>
420 420
421 <tag-name><var>$date_gmt</var></tag-name> 421 <tag-name><var>$date_gmt</var></tag-name>