Commit fca26ba8 authored by Joshua Slive's avatar Joshua Slive
Browse files

Some doc updates realted to ssi. 

1. Add info on how to activate ssi to upgrading.html.

2. Remove mention of the ssi magic mime-types, since they no
longer work.

3. Place a warning on xbithack that it doesn't currently work,
and reference the bug report.

4. Add a warning about mod_include parsing non-html content.

5. Misc little fixups.


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@89655 13f79535-47bb-0310-9956-ffa450edef68
parent 1c6b4e2d

docs/manual/howto/ssi.html.en

+1 −1
Original line number Diff line number Diff line
@@ -83,7 +83,7 @@ Tutorial: Introduction to Server Side Includes</a></h2> 
 <a href="../mod/core.html#options">Options</a><br>

<a href="../mod/mod_include.html#xbithack">XBitHack</a><br>

<a href="../mod/mod_mime.html#addtype">AddType</a><br>

<a href="../mod/mod_mime.html#addhandler">AddHandler</a><br>

<a href="../mod/core.html.html#setoutputfilter">SetOutputFilter</a><br>

<a href=

"../mod/mod_setenvif.html#BrowserMatchNoCase">BrowserMatchNoCase</a><br>

docs/manual/mod/mod_include.html

+19 −10
Original line number Diff line number Diff line
@@ -49,7 +49,7 @@ variables.</p> 
</UL>



<p>See also: <a href="core.html#options">Options</a>

and <a href="mod_mime.html#addhandler">AddHandler</a>.</p>

and <a href="core.html.html#SetOutputFilter">SetOutputFilter</a>.</p>





<H2>Enabling Server-Side Includes</H2>
@@ -68,6 +68,16 @@ AddType text/html .shtml<br> 
&lt;/FilesMatch&gt;

</code></blockquote>



<p>Be careful to properly scope the INCLUDES filter to process only

the correct files.  The filter is <strong>not</strong> restricted to

processing only HTML files.  So, for example, if the INCLUDES filter

is activated using a <code>&lt;Directory&gt;</code> section and that

directory includes GIF files, mod_include will process the GIF files.

This can have two adverse consequences: 1. there will be extra

overhead in serving these files, and 2. these files could become

corrupted if they happen to contain something that looks like an SSI

element.</p>



<p>The following directive must be given for the directories containing

the shtml files (typically in a <CODE>&lt;Directory&gt;</CODE> section,

but this directive is also valid .htaccess files if <CODE>AllowOverride
@@ -77,15 +87,8 @@ Options</CODE> is set):</p> 
Options +Includes

</code></blockquote>



<p>Alternatively the <A HREF="#xbithack"><CODE>XBitHack</CODE></A>

directive can be used to parse normal (<CODE>text/html</CODE>) files,

based on file permissions.</p>



<p>For backwards compatibility, documents with mime type

<CODE>text/x-server-parsed-html</CODE> or

<CODE>text/x-server-parsed-html3</CODE> will also be parsed

(and the resulting output given the mime type <CODE>text/html</CODE>)

as will documents with the handler <code>server-parsed</code>.

<p>For more information, see our <a href="../howto/ssi.html">Tutorial

on Server Side Includes</a>.</p>



<H2>Basic Elements</H2>
@@ -442,6 +445,12 @@ customized server error documents. 
 REL="Help"

><STRONG>Module:</STRONG></A> mod_include<P>



<p><strong>Warning:</strong> This directive is not yet working in

Apache 2.0.  The issue is being tracked in <a

href="http://bugs.apache.org/index.cgi/full/7751">PR7751</a>.</p>







The XBitHack directives controls the parsing of ordinary html documents.

This directive only affects files associated with the MIME type

<CODE>text/html</CODE>.  XBitHack can take on the following values:

docs/manual/upgrading.html

+20 −3
Original line number Diff line number Diff line
@@ -24,9 +24,9 @@ Features</A> document, or in the <CODE>src/CHANGES</CODE> file. 


<UL>

<LI>Apache now uses an <code>autoconf</code> and <code>libtool</code>

system for configuring the build processes.  Using this system

is similar to, but not the same as, using the APACI system in

Apache 1.3.  Further documentation to follow.</li>

system for <a href="install.html">configuring the build processes</a>.

Using this system is similar to, but not the same as, using the APACI

system in Apache 1.3.</li>



<li>In addition to the usual selection of modules which you can choose

to compile, Apache 2.0 has moved the main part of request processing
@@ -36,6 +36,7 @@ into <a href="mpm.html">Multi-Processing Modules</a> (MPMs).</li> 
<H3>Run-Time Configuration Changes</H3>



<UL>



<li>Many directives that were in the core server in Apache 1.3

are now in the MPMs.  If you wish the behavior of the server

to be as similar as possible to the behavior of Apache 1.3,
@@ -43,6 +44,22 @@ you should select the <a href="mod/prefork.html">prefork</a> 
MPM.  Other MPMs will have different directives to control process

creation and request processing.</li>



<li>Server-Side Includes provided by <a

href="mod/mod_include.html">mod_include</a> are now implemented using

the new

<a href="filter.html">filter system</a> rather than as a handler.

This provides much more power and flexibility, but requires 

the use of the <a href="mod/core.html#setoutputfilter">SetOutputFilter</a>

to activate server-parsed content.  If you were using

<code>AddHandler server-parsed .shtml</code>, you can get

similar functionality using

<blockquote><code>

&lt;FilesMatch "\.shtml(\..+)?$"&gt;<br>

&nbsp;&nbsp;SetOutputFilter INCLUDES<br>

&lt;/FilesMatch&gt;

</code></blockquote></li>





<li>The <code>CacheNegotiatedDocs</code> directive now takes

the argument <code>on</code> or <code>off</code>.  Existing

instances of <code>CacheNegotiatedDocs</code> should be replaced

docs/manual/upgrading.html.en

+20 −3
Original line number Diff line number Diff line
@@ -24,9 +24,9 @@ Features</A> document, or in the <CODE>src/CHANGES</CODE> file. 


<UL>

<LI>Apache now uses an <code>autoconf</code> and <code>libtool</code>

system for configuring the build processes.  Using this system

is similar to, but not the same as, using the APACI system in

Apache 1.3.  Further documentation to follow.</li>

system for <a href="install.html">configuring the build processes</a>.

Using this system is similar to, but not the same as, using the APACI

system in Apache 1.3.</li>



<li>In addition to the usual selection of modules which you can choose

to compile, Apache 2.0 has moved the main part of request processing
@@ -36,6 +36,7 @@ into <a href="mpm.html">Multi-Processing Modules</a> (MPMs).</li> 
<H3>Run-Time Configuration Changes</H3>



<UL>



<li>Many directives that were in the core server in Apache 1.3

are now in the MPMs.  If you wish the behavior of the server

to be as similar as possible to the behavior of Apache 1.3,
@@ -43,6 +44,22 @@ you should select the <a href="mod/prefork.html">prefork</a> 
MPM.  Other MPMs will have different directives to control process

creation and request processing.</li>



<li>Server-Side Includes provided by <a

href="mod/mod_include.html">mod_include</a> are now implemented using

the new

<a href="filter.html">filter system</a> rather than as a handler.

This provides much more power and flexibility, but requires 

the use of the <a href="mod/core.html#setoutputfilter">SetOutputFilter</a>

to activate server-parsed content.  If you were using

<code>AddHandler server-parsed .shtml</code>, you can get

similar functionality using

<blockquote><code>

&lt;FilesMatch "\.shtml(\..+)?$"&gt;<br>

&nbsp;&nbsp;SetOutputFilter INCLUDES<br>

&lt;/FilesMatch&gt;

</code></blockquote></li>





<li>The <code>CacheNegotiatedDocs</code> directive now takes

the argument <code>on</code> or <code>off</code>.  Existing

instances of <code>CacheNegotiatedDocs</code> should be replaced