diff options
Diffstat (limited to 'docs/manual/mod/mod_include.html.en')
| -rw-r--r-- | docs/manual/mod/mod_include.html.en | 32 |
1 files changed, 22 insertions, 10 deletions
diff --git a/docs/manual/mod/mod_include.html.en b/docs/manual/mod/mod_include.html.en index f0f9fdaf..1b5ea74d 100644 --- a/docs/manual/mod/mod_include.html.en +++ b/docs/manual/mod/mod_include.html.en @@ -64,13 +64,13 @@ <li><img alt="" src="../images/down.gif" /> <a href="#ssiundefinedecho">SSIUndefinedEcho</a></li> <li><img alt="" src="../images/down.gif" /> <a href="#xbithack">XBitHack</a></li> </ul> -<h3>See also</h3> +<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_include">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_include">Report a bug</a></li></ul><h3>See also</h3> <ul class="seealso"> <li><code class="directive"><a href="../mod/core.html#options">Options</a></code></li> <li><code class="directive"><a href="../mod/core.html#acceptpathinfo">AcceptPathInfo</a></code></li> <li><a href="../filter.html">Filters</a></li> <li><a href="../howto/ssi.html">SSI Tutorial</a></li> -</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> +<li><a href="#comments_section">Comments</a></li></ul></div> <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="enabling" id="enabling">Enabling Server-Side Includes</a></h2> @@ -138,6 +138,8 @@ AddOutputFilter INCLUDES .shtml</pre> <table class="bordered"> <tr><th>Element</th><th>Description</th></tr> + <tr><td><code><a href="#element.comment">comment</a></code></td> + <td>SSI comment</td></tr> <tr><td><code><a href="#element.config">config</a></code></td> <td>configure output formats</td></tr> <tr><td><code><a href="#element.echo">echo</a></code></td> @@ -161,14 +163,24 @@ AddOutputFilter INCLUDES .shtml</pre> <code class="module"><a href="../mod/mod_cgi.html">mod_cgi</a></code>, and will only be available if this module is loaded.</p> + <h3><a name="element.comment" id="element.comment">The comment Element</a></h3> + <p>This command doesn't output anything. Its only use is to + add comments within a file. These comments are not printed.</p> + + <p>This syntax is available in version 2.4.21 and later.</p> + + <div class="example"><p><code> + <!--#comment Blah Blah Blah --> + </code></p></div> + + <h3><a name="element.config" id="element.config">The config Element</a></h3> <p>This command controls various aspects of the parsing. The valid attributes are:</p> <dl> <dt><code>echomsg</code> (<em>Apache 2.1 and later</em>)</dt> - <dd> - <p>The value is a message that is sent back to the + <dd><p>The value is a message that is sent back to the client if the <code><a href="#element.echo">echo</a></code> element attempts to echo an undefined variable. This overrides any <code class="directive"><a href="#ssiundefinedecho">SSIUndefinedEcho</a></code> directives.</p> @@ -181,7 +193,7 @@ AddOutputFilter INCLUDES .shtml</pre> <dd><p>The value is a message that is sent back to the client if an error occurs while parsing the document. This overrides any <code class="directive"><a href="#ssierrormsg">SSIErrorMsg</a></code> directives.</p> - + <div class="example"><p><code> <!--#config errmsg="[Oops, something broke.]" --> </code></p></div> @@ -197,19 +209,19 @@ AddOutputFilter INCLUDES .shtml</pre> <div class="example"><p><code> <!--#config sizefmt="abbrev" --> </code></p></div> + </dd> <dt><code>timefmt</code></dt> <dd><p>The value is a string to be used by the <code>strftime(3)</code> library routine when printing dates.</p> - + <div class="example"><p><code> <!--#config timefmt=""%R, %B %d, %Y"" --> </code></p></div> </dd> - </dl> @@ -362,7 +374,7 @@ AddOutputFilter INCLUDES .shtml</pre> </code></p></div> The value of <code>file</code> cannot start with a slash - (<code>/</code>), nor can it contain <code>../</code> so as to + (<code>/</code>), nor can it contain <code>../</code> so as to refer to a file above the current directory or outside of the document root. Attempting to so will result in the error message: <code>The given path was above the root path</code>. @@ -985,8 +997,8 @@ server.</td></tr> output of a file each processing different commands (possibly at different times).</p> - <pre class="prettyprint lang-config"> SSIStartTag "<%"<br /> - SSIEndTag "%>"</pre> + <pre class="prettyprint lang-config">SSIStartTag "<%" +SSIEndTag "%>"</pre> <p>The example given above, which also specifies a matching |