Add missing documentation for ProxyHTMLMeta directive.

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

diff --git a/docs/manual/mod/mod_proxy_html.xml b/docs/manual/mod/mod_proxy_html.xml
index f18a55e39a95b159bc5da3470c6a753148d55fa9..41c5ef77ae33b3f5a139eca711294e6f55eda40e 100644 (file)
--- a/docs/manual/mod/mod_proxy_html.xml
+++ b/docs/manual/mod/mod_proxy_html.xml
@@ -41,6 +41,43 @@ extensive <a href="http://apache.webthing.com/mod_proxy_html/"
 >documentation</a> may be useful to users.</p>
 </summary>
 
+<directivesynopsis>
+<name>ProxyHTMLMeta</name>
+<description>Turns on or off extra pre-parsing of metadata in HTML
+<code>&lt;head&gt;</code> sections.</description>
+<syntax>ProxyHTMLMeta <var>On|Off</var></syntax>
+<contextlist><context>server config</context>
+<context>virtual host</context><context>directory</context>
+</contextlist>
+<compatibility>Version 2.4 and later; available as a third-party
+module for earlier 2.x versions.</compatibility>
+
+<usage>
+    <p>This turns on or off pre-parsing of metadata in HTML
+    <code>&lt;head&gt;</code> sections.</p>
+    <p>If not required, turning ProxyHTMLMeta Off will give a small
+    performance boost by skipping this parse step.  However, it
+    is sometimes necessary for internationalisation to work correctly.</p>
+    <p>ProxyHTMLMeta has two effects.  Firstly and most importantly
+    it enables detection of character encodings declared in the form</p>
+    <pre>&lt;meta http-equiv="Content-Type" content="text/html;charset=<var>foo</var>"&gt;</pre>
+    <p>or, in the case of an XHTML document, an XML declaration.
+    It is NOT required if the charset is declared in a real HTTP header
+    (which is always preferable) from the backend server, nor if the
+    document is <var>utf-8</var> (unicode) or a subset such as ASCII.
+    You may also be able to dispense with it where documents use a
+    default declared using <directive module="mod_xml2enc"
+    >xml2EncDefault</directive>, but that risks propagating an
+    incorrect declaration.  A <directive>ProxyHTMLCharsetOut</directive>
+    can remove that risk, but is likely to be a bigger processing
+    overhead than enabling ProxyHTMLMeta.</p>
+    <p>The other effect of enabling ProxyHTMLMeta is to parse all
+    <code>&lt;meta http-equiv=...&gt;</code> declarations and convert
+    them to real HTTP headers, in keeping with the original purpose
+    of this form of the HTML &lt;meta&gt; element.</p>
+</usage>
+</directivesynopsis>
+
 <directivesynopsis>
 <name>ProxyHTMLEnable</name>
 <description>Turns the proxy_html filter on or off.</description>