From f5fefc7092d677c3649e64b968493e7ccb4bf50d Mon Sep 17 00:00:00 2001 From: Christophe Jaillet Date: Wed, 1 Nov 2017 22:25:05 +0000 Subject: [PATCH] Improve mod_proxy_html doc - add some links and color highligh - remove some (i.e. italic) around parameters that should be written unmodified (On|Off...) r1813997 in trunk + some small modifications to synch with trunk git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1814012 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/mod_proxy_html.xml | 49 +++++++++++++++--------------- 1 file changed, 24 insertions(+), 25 deletions(-) diff --git a/docs/manual/mod/mod_proxy_html.xml b/docs/manual/mod/mod_proxy_html.xml index c687d69da2..5811b6eab9 100644 --- a/docs/manual/mod/mod_proxy_html.xml +++ b/docs/manual/mod/mod_proxy_html.xml @@ -57,7 +57,7 @@ extensive ProxyHTMLMeta Turns on or off extra pre-parsing of metadata in HTML <head> sections. -ProxyHTMLMeta On|Off +ProxyHTMLMeta On|Off ProxyHTMLMeta Off server config virtual hostdirectory @@ -71,7 +71,7 @@ module for earlier 2.x versions.

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.

-

ProxyHTMLMeta has two effects. Firstly and most importantly +

ProxyHTMLMeta has two effects. Firstly and most importantly it enables detection of character encodings declared in the form

<meta http-equiv="Content-Type" content="text/html;charset=foo">

or, in the case of an XHTML document, an XML declaration. @@ -81,10 +81,10 @@ module for earlier 2.x versions. You may also be able to dispense with it where documents use a default declared using xml2EncDefault, but that risks propagating an - incorrect declaration. A ProxyHTMLCharsetOut + incorrect declaration. A ProxyHTMLCharsetOut can remove that risk, but is likely to be a bigger processing overhead than enabling ProxyHTMLMeta.

-

The other effect of enabling ProxyHTMLMeta is to parse all +

The other effect of enabling ProxyHTMLMeta is to parse all <meta http-equiv=...> declarations and convert them to real HTTP headers, in keeping with the original purpose of this form of the HTML <meta> element.

@@ -103,7 +103,7 @@ module for earlier 2.x versions. ProxyHTMLEnable Turns the proxy_html filter on or off. -ProxyHTMLEnable On|Off +ProxyHTMLEnable On|Off ProxyHTMLEnable Off server config virtual hostdirectory @@ -191,20 +191,20 @@ A string of the form ${varname|default} will be replaced by the value of environment variable varname. If that is unset, it is replaced by default. The |default is optional.

NOTE: interpolation will only be enabled if -ProxyHTMLInterp is On.

+ProxyHTMLInterp is On.

v

Interpolate environment variables in from-pattern. Patterns supported are as above.

NOTE: interpolation will only be enabled if -ProxyHTMLInterp is On.

+ProxyHTMLInterp is On.

The optional fourth cond argument defines a condition that will be evaluated per Request, provided -ProxyHTMLInterp is On. +ProxyHTMLInterp is On. If the condition evaluates FALSE the map will not be applied in this request. If TRUE, or if no condition is defined, the map is applied.

A cond is evaluated by the ProxyHTMLInterp Enables per-request interpolation of ProxyHTMLURLMap rules. -ProxyHTMLInterp On|Off +ProxyHTMLInterp On|Off ProxyHTMLInterp Off server config virtual hostdirectory @@ -227,7 +227,7 @@ for earlier 2.x versions

This enables per-request interpolation in - ProxyHTMLURLMap to- and from- patterns.

+ ProxyHTMLURLMap to- and from- patterns.

If interpolation is not enabled, all rules are pre-compiled at startup. With interpolation, they must be re-compiled for every request, which implies an extra processing overhead. It should therefore be @@ -238,8 +238,8 @@ for earlier 2.x versions ProxyHTMLDocType Sets an HTML or XHTML document type declaration. -ProxyHTMLDocType HTML|XHTML [Legacy]
OR -
ProxyHTMLDocType fpi [SGML|XML] +ProxyHTMLDocType HTML|XHTML [Legacy]
OR +
ProxyHTMLDocType fpi [SGML|XML] server config virtual hostdirectory @@ -271,7 +271,7 @@ module="core">LogLevel Debug.

ProxyHTMLFixups Fixes for simple HTML errors. -ProxyHTMLFixups [lowercase] [dospath] [reset] +ProxyHTMLFixups [lowercase] [dospath] [reset] server config virtual hostdirectory @@ -286,7 +286,7 @@ for earlier 2.x versions

Take care when using these. The fixes will correct certain authoring mistakes, but risk also erroneously fixing links that were correct to start with. -Only use them if you know you have a broken backend server.

+Only use them if you know you have a broken backend server.

 @@ -294,7 +294,7 @@ Only use them if you know you have a broken backend server.

ProxyHTMLExtended Determines whether to fix links in inline scripts, stylesheets, and scripting events. -ProxyHTMLExtended On|Off +ProxyHTMLExtended On|Off ProxyHTMLExtended Off server config virtual hostdirectory @@ -303,11 +303,11 @@ and scripting events. for earlier 2.x versions

Set to Off, HTML links are rewritten according to the -ProxyHTMLURLMap directives, but links appearing +ProxyHTMLURLMap directives, but links appearing in Javascript and CSS are ignored.

Set to On, all scripting events (as determined by -ProxyHTMLEvents) and embedded scripts or -stylesheets are also processed by the ProxyHTMLURLMap +ProxyHTMLEvents) and embedded scripts or +stylesheets are also processed by the ProxyHTMLURLMap rules, according to the flags set for each rule. Since this requires more parsing, performance will be best if you only enable it when strictly necessary.

@@ -322,7 +322,7 @@ false matches. ProxyHTMLStripComments Determines whether to strip HTML comments. -ProxyHTMLStripComments On|Off +ProxyHTMLStripComments On|Off ProxyHTMLStripComments Off server config virtual hostdirectory @@ -376,10 +376,10 @@ size and avoid the need to resize the buffer dynamically during a request. for earlier 2.x versions

Specifies one or more attributes to treat as scripting events and -apply ProxyHTMLURLMaps to where enabled. +apply ProxyHTMLURLMaps to where enabled. You can specify any number of attributes in one or more -ProxyHTMLEvents directives.

-

Normally you'll set this globally. If you set ProxyHTMLEvents in more than +ProxyHTMLEvents directives.

+

Normally you'll set this globally. If you set ProxyHTMLEvents in more than one scope so that one overrides the other, you'll need to specify a complete set in each of those scopes.

A default configuration is supplied in proxy-html.conf @@ -399,9 +399,9 @@ for earlier 2.x versions

Specifies elements that have URL attributes that should be rewritten using standard ProxyHTMLURLMaps. -You will need one ProxyHTMLLinks directive per element, +You will need one ProxyHTMLLinks directive per element, but it can have any number of attributes.

-

Normally you'll set this globally. If you set ProxyHTMLLinks in more than +

Normally you'll set this globally. If you set ProxyHTMLLinks in more than one scope so that one overrides the other, you'll need to specify a complete set in each of those scopes.

A default configuration is supplied in proxy-html.conf @@ -450,4 +450,3 @@ will generate output using the same encoding as the input.

- -- 2.40.0