httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From n..@apache.org
Subject svn commit: r966890 - in /httpd/httpd/trunk/docs/manual: filter.xml mod/core.xml mod/mod_buffer.xml mod/mod_deflate.xml mod/mod_filter.xml mod/mod_mime.xml
Date Thu, 22 Jul 2010 22:50:12 GMT
Author: niq
Date: Thu Jul 22 22:50:12 2010
New Revision: 966890

URL: http://svn.apache.org/viewvc?rev=966890&view=rev
Log:
Update documentation for AddOutputFilterByType move

Modified:
    httpd/httpd/trunk/docs/manual/filter.xml
    httpd/httpd/trunk/docs/manual/mod/core.xml
    httpd/httpd/trunk/docs/manual/mod/mod_buffer.xml
    httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml
    httpd/httpd/trunk/docs/manual/mod/mod_filter.xml
    httpd/httpd/trunk/docs/manual/mod/mod_mime.xml

Modified: httpd/httpd/trunk/docs/manual/filter.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/filter.xml?rev=966890&r1=966889&r2=966890&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/filter.xml (original)
+++ httpd/httpd/trunk/docs/manual/filter.xml Thu Jul 22 22:50:12 2010
@@ -163,9 +163,8 @@ Relevant directives are
     <directive module="mod_filter">FilterProvider</directive>.</p>
 
 <p>One further directive <directive
-module="core">AddOutputFilterByType</directive> is still supported,
-but may be problematic and is now deprecated.  Use dynamic
-configuration instead.</p>
+module="mod_filter">AddOutputFilterByType</directive> is still supported,
+but deprecated.  Use dynamic configuration instead.</p>
 
   </section>
 </manualpage>

Modified: httpd/httpd/trunk/docs/manual/mod/core.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/core.xml?rev=966890&r1=966889&r2=966890&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/core.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/core.xml Thu Jul 22 22:50:12 2010
@@ -259,71 +259,6 @@ content-type is <code>text/plain</code> 
 </directivesynopsis>
 
 <directivesynopsis>
-<name>AddOutputFilterByType</name>
-<description>assigns an output filter to a particular media-type</description>
-<syntax>AddOutputFilterByType <var>filter</var>[;<var>filter</var>...]
-<var>media-type</var> [<var>media-type</var>] ...</syntax>
-<contextlist><context>server config</context>
-<context>virtual host</context><context>directory</context>
-<context>.htaccess</context></contextlist>
-<override>FileInfo</override>
-<compatibility>Available in Apache httpd 2.0.33 and later; deprecated in Apache httpd
2.1 and later</compatibility>
-
-<usage>
-    <p>This directive activates a particular output <a
-    href="../filter.html">filter</a> for a request depending on the
-    response <glossary>media-type</glossary>.  Because of certain
-    problems discussed below, this directive is deprecated.  The same
-    functionality is available using <module>mod_filter</module>.</p>
-
-    <p>The following example uses the <code>DEFLATE</code> filter, which
-    is provided by <module>mod_deflate</module>. It will compress all
-    output (either static or dynamic) which is labeled as
-    <code>text/html</code> or <code>text/plain</code> before it is
sent
-    to the client.</p>
-
-    <example>
-      AddOutputFilterByType DEFLATE text/html text/plain
-    </example>
-
-    <p>If you want the content to be processed by more than one filter, their
-    names have to be separated by semicolons. It's also possible to use one
-    <directive>AddOutputFilterByType</directive> directive for each of
-    these filters.</p>
-
-    <p>The configuration below causes all script output labeled as
-    <code>text/html</code> to be processed at first by the
-    <code>INCLUDES</code> filter and then by the <code>DEFLATE</code>
-    filter.</p>
-
-    <example>
-    &lt;Location /cgi-bin/&gt;<br />
-    <indent>
-      Options Includes<br />
-      AddOutputFilterByType INCLUDES;DEFLATE text/html<br />
-    </indent>
-    &lt;/Location&gt;
-    </example>
-
-    <note type="warning"><title>Note</title>
-      <p>Enabling filters with <directive>AddOutputFilterByType</directive>
-      may fail partially or completely in some cases. For example, no
-      filters are applied if the <glossary>media-type</glossary> could not
-      be determined.  If you want to make sure that the filters will be
-      applied, assign the content type to a resource explicitly; for
-      example, with <directive module="mod_mime">AddType</directive> or
-      <directive module="core">ForceType</directive>. Setting the
-      content type within a (non-nph) CGI script is also safe.</p>
-
-    </note>
-</usage>
-
-<seealso><directive module="mod_mime">AddOutputFilter</directive></seealso>
-<seealso><directive module="core">SetOutputFilter</directive></seealso>
-<seealso><a href="../filter.html">filters</a></seealso>
-</directivesynopsis>
-
-<directivesynopsis>
 <name>AllowEncodedSlashes</name>
 <description>Determines whether encoded path separators in URLs are allowed to
 be passed through</description>

Modified: httpd/httpd/trunk/docs/manual/mod/mod_buffer.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_buffer.xml?rev=966890&r1=966889&r2=966890&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_buffer.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_buffer.xml Thu Jul 22 22:50:12 2010
@@ -52,7 +52,7 @@
     <directive module="core">SetInputFilter</directive>,
     <directive module="core">SetOutputFilter</directive>,
     <directive module="mod_mime">AddOutputFilter</directive> or
-    <directive module="core">AddOutputFilterByType</directive> directives.</p>
+    <directive module="mod_filter">AddOutputFilterByType</directive> directives.</p>
 
       <example><title>Using buffer with mod_include</title>
         AddOutputFilterByType INCLUDES;BUFFER text/html<br />

Modified: httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml?rev=966890&r1=966889&r2=966890&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_deflate.xml Thu Jul 22 22:50:12 2010
@@ -95,7 +95,7 @@ client</description>
       will be ignored.</p>
       
       <p>If you want to restrict the compression to particular MIME types
-      in general, you may use the <directive module="core"
+      in general, you may use the <directive module="mod_filter"
       >AddOutputFilterByType</directive> directive. Here is an example of
       enabling compression only for the html files of the Apache
       documentation:</p>

Modified: httpd/httpd/trunk/docs/manual/mod/mod_filter.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_filter.xml?rev=966890&r1=966889&r2=966890&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_filter.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_filter.xml Thu Jul 22 22:50:12 2010
@@ -54,7 +54,7 @@
     great deal of flexibility in configuring the filter chain.  In fact,
     filters can be inserted based on any Request Header, Response Header
     or Environment Variable.  This generalises the limited flexibility offered
-    by <directive module="core">AddOutputFilterByType</directive>, and fixes
+    by <directive>AddOutputFilterByType</directive>, and fixes
     it to work correctly with dynamic content, regardless of the
     content generator.  The ability to dispatch based on Environment
     Variables offers the full flexibility of configuration with
@@ -157,8 +157,7 @@
 <section id="examples"><title>Examples</title>
     <dl>
     <dt>Server side Includes (SSI)</dt>
-    <dd>A simple case of using <module>mod_filter</module> in place of
-    <directive module="core">AddOutputFilterByType</directive>
+    <dd>A simple case of replacing <directive>AddOutputFilterByType</directive>
     <example>
       FilterDeclare SSI<br/>
       FilterProvider SSI INCLUDES "$resp{Content-Type} = /^text\/html/"<br/>
@@ -252,6 +251,71 @@
 </section>
 
 <directivesynopsis>
+<name>AddOutputFilterByType</name>
+<description>assigns an output filter to a particular media-type</description>
+<syntax>AddOutputFilterByType <var>filter</var>[;<var>filter</var>...]
+<var>media-type</var> [<var>media-type</var>] ...</syntax>
+<contextlist><context>server config</context>
+<context>virtual host</context><context>directory</context>
+<context>.htaccess</context></contextlist>
+<override>FileInfo</override>
+<compatibility>Available in Apache httpd 2.0.33 and later; deprecated in Apache httpd
2.1 and later</compatibility>
+
+<usage>
+    <p>This directive activates a particular output <a
+    href="../filter.html">filter</a> for a request depending on the
+    response <glossary>media-type</glossary>.  Because of certain
+    problems discussed below, this directive is deprecated.  The same
+    functionality is available using <module>mod_filter</module>.</p>
+
+    <p>The following example uses the <code>DEFLATE</code> filter, which
+    is provided by <module>mod_deflate</module>. It will compress all
+    output (either static or dynamic) which is labeled as
+    <code>text/html</code> or <code>text/plain</code> before it is
sent
+    to the client.</p>
+
+    <example>
+      AddOutputFilterByType DEFLATE text/html text/plain
+    </example>
+
+    <p>If you want the content to be processed by more than one filter, their
+    names have to be separated by semicolons. It's also possible to use one
+    <directive>AddOutputFilterByType</directive> directive for each of
+    these filters.</p>
+
+    <p>The configuration below causes all script output labeled as
+    <code>text/html</code> to be processed at first by the
+    <code>INCLUDES</code> filter and then by the <code>DEFLATE</code>
+    filter.</p>
+
+    <example>
+    &lt;Location /cgi-bin/&gt;<br />
+    <indent>
+      Options Includes<br />
+      AddOutputFilterByType INCLUDES;DEFLATE text/html<br />
+    </indent>
+    &lt;/Location&gt;
+    </example>
+
+    <note type="warning"><title>Note</title>
+      <p>Enabling filters with <directive>AddOutputFilterByType</directive>
+      may fail partially or completely in some cases. For example, no
+      filters are applied if the <glossary>media-type</glossary> could not
+      be determined.  If you want to make sure that the filters will be
+      applied, assign the content type to a resource explicitly; for
+      example, with <directive module="mod_mime">AddType</directive> or
+      <directive module="core">ForceType</directive>. Setting the
+      content type within a (non-nph) CGI script is also safe.</p>
+
+    </note>
+</usage>
+
+<seealso><directive module="mod_mime">AddOutputFilter</directive></seealso>
+<seealso><directive module="core">SetOutputFilter</directive></seealso>
+<seealso><a href="../filter.html">filters</a></seealso>
+</directivesynopsis>
+
+<directivesynopsis>
 <name>FilterDeclare</name>
 <description>Declare a smart filter</description>
 <syntax>FilterDeclare <var>filter-name</var> <var>[type]</var></syntax>

Modified: httpd/httpd/trunk/docs/manual/mod/mod_mime.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_mime.xml?rev=966890&r1=966889&r2=966890&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_mime.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_mime.xml Thu Jul 22 22:50:12 2010
@@ -485,7 +485,7 @@ later.</compatibility>
     href="../filter.html">filters</a> which will process responses
     from the server before they are sent to the client. This is in
     addition to any filters defined elsewhere, including <directive
-    module="core">SetOutputFilter</directive> and <directive module="core"
+    module="core">SetOutputFilter</directive> and <directive module="mod_filter"
     >AddOutputFilterByType</directive> directive. This mapping is merged
     over any already in force, overriding any mappings that already exist
     for the same <var>extension</var>.</p>



Mime
View raw message