diff options
| author | Nick Kew <niq@apache.org> | 2020-05-09 00:39:36 +0200 |
|---|---|---|
| committer | Nick Kew <niq@apache.org> | 2020-05-09 00:39:36 +0200 |
| commit | 3ef70e1267a45cb0233767f2e54a08f0c4fc87b0 (patch) | |
| tree | 934d69fcce295d8c9b82c154405f518b771716a8 /docs/manual/mod/mod_proxy_html.xml | |
| parent | mod_ssl: Update the ssl_var_lookup() API: (diff) | |
| download | apache2-3ef70e1267a45cb0233767f2e54a08f0c4fc87b0.tar.xz apache2-3ef70e1267a45cb0233767f2e54a08f0c4fc87b0.zip | |
Update mod_proxy_html docs to reflect
https://lists.apache.org/thread.html/rc26df3094f42cfa742690282b4430483d56f85f3e033337b1a08ec53%40%3Cusers.httpd.apache.org%3E
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1877522 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs/manual/mod/mod_proxy_html.xml')
| -rw-r--r-- | docs/manual/mod/mod_proxy_html.xml | 35 |
1 files changed, 18 insertions, 17 deletions
diff --git a/docs/manual/mod/mod_proxy_html.xml b/docs/manual/mod/mod_proxy_html.xml index 480a8060b1..9d33112bf2 100644 --- a/docs/manual/mod/mod_proxy_html.xml +++ b/docs/manual/mod/mod_proxy_html.xml @@ -125,25 +125,20 @@ versions where filter directives were used to activate mod_proxy_html.</strong>< module for earlier 2.x versions.</compatibility> <usage> + <note> + <p>ProxyHTMLMeta was part of i18n support in earlier mod_proxy_html + versions, including those for Apache HTTPD 2.0 and 2.2. + That functionality has now been separated out into the separate + module <module>mod_xml2enc</module>. ProxyHTMLMeta no longer + serves any purpose likely to be useful in an operational server, + though it might serve as a testing/debugging aid for developers + of software such as browsers.</p> + </note> + <p>This turns on or off pre-parsing of metadata in HTML <code><head></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><directive>ProxyHTMLMeta</directive> has two effects. Firstly and most importantly - it enables detection of character encodings declared in the form</p> - <pre><meta http-equiv="Content-Type" content="text/html;charset=<var>foo</var>"></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 module="mod_proxy_html">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 <directive>ProxyHTMLMeta</directive> is to parse all + + <p>Enabling <directive>ProxyHTMLMeta</directive> will parse all <code><meta http-equiv=...></code> declarations and convert them to real HTTP headers, in keeping with the original purpose of this form of the HTML <meta> element.</p> @@ -510,6 +505,12 @@ normally be used, as any change from the default <code>UTF-8</code> processing overhead. The special token <code>ProxyHTMLCharsetOut *</code> will generate output using the same encoding as the input.</p> <p>Note that this relies on <module>mod_xml2enc</module> being loaded.</p> +<note> +<p>This does not support encoding HTML Entities. If a document contains +characters that cannot be represented in the target charset, it will +fail and the document is likely to be corrupted. This applies even if +such characters are represented as entities in the input document.</p> +</note> </usage> </directivesynopsis> |