From: Nick Kew Date: Tue, 11 Dec 2012 12:11:29 +0000 (+0000) Subject: PR 54269 X-Git-Tag: 2.5.0-alpha~6032 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b7a0c5d1fc01b2385dc943673bef7582b977f2a4;p=thirdparty%2Fapache%2Fhttpd.git PR 54269 Tidy up mod_proxy_html docs git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1420120 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/mod/mod_proxy_html.xml b/docs/manual/mod/mod_proxy_html.xml index 41c5ef77ae3..d961af5c16d 100644 --- a/docs/manual/mod/mod_proxy_html.xml +++ b/docs/manual/mod/mod_proxy_html.xml @@ -46,6 +46,7 @@ extensive Turns on or off extra pre-parsing of metadata in HTML <head> sections. ProxyHTMLMeta On|Off +ProxyHTMLMeta Off server config virtual hostdirectory @@ -82,6 +83,7 @@ module for earlier 2.x versions. ProxyHTMLEnable Turns the proxy_html filter on or off. ProxyHTMLEnable On|Off +ProxyHTMLEnable Off server config virtual hostdirectory @@ -113,7 +115,8 @@ module for earlier 2.x versions.

This is the key directive for rewriting HTML links. When parsing a document, whenever a link target matches from-pattern, the matching portion will be rewritten to to-pattern, as modified by any -flags supplied.

+flags supplied and by the ProxyHTMLExtended +directive.

The optional third argument may define any of the following Flags. Flags are case-sensitive.

@@ -191,6 +194,7 @@ in mod_proxy_html 3.x for HTTPD 2.0 and 2.2 is also supported.

Enables per-request interpolation of ProxyHTMLURLMap rules. ProxyHTMLInterp On|Off +ProxyHTMLInterp Off server config virtual hostdirectory @@ -267,19 +271,27 @@ Only use them if you know you have a broken backend server.

Determines whether to fix links in inline scripts, stylesheets, and scripting events. ProxyHTMLExtended On|Off +ProxyHTMLExtended Off server config virtual hostdirectory Version 2.4 and later; available as a third-party for earlier 2.x versions -

Set to Off, HTML links are rewritten according +

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

-

Set to On, all scripting events and embedded scripts or +

Set to On, all scripting events (as determined by +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.

+parsing, performance will be best if you only enable it when strictly necessary. +

+You'll also need to take care over patterns matched, since the parser has no +knowledge of what is a URL within an embedded script or stylesheet. +In particular, extended matching of / is likely to lead to +false matches. +

 @@ -287,6 +299,7 @@ parsing, performance will be best if you only enable it when strictly necessary. ProxyHTMLStripComments Determines whether to strip HTML comments. ProxyHTMLStripComments On|Off +ProxyHTMLStripComments Off server config virtual hostdirectory @@ -314,12 +327,13 @@ stylesheets. Version 2.4 and later; available as a third-party for earlier 2.x versions -

In order to parse non-HTML content (stylesheets and scripts), mod_proxy_html +

In order to parse non-HTML content (stylesheets and scripts) embedded +in HTML documents, mod_proxy_html has to read the entire script or stylesheet into a buffer. This buffer will be expanded as necessary to hold the largest script or stylesheet in a page, -in increments of [nnnn] as set by this directive.

+in increments of bytes as set by this directive.

The default is 8192, and will work well for almost all pages. However, -if you know you're proxying a lot of pages containing stylesheets and/or +if you know you're proxying pages containing stylesheets and/or scripts bigger than 8K (that is, for a single script or stylesheet, NOT in total), it will be more efficient to set a larger buffer size and avoid the need to resize the buffer dynamically during a request. @@ -338,11 +352,14 @@ 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 appropriate. +apply ProxyHTMLURLMaps to where enabled. You can specify any number of attributes in one or more ProxyHTMLEvents directives.

-

The default configuration defines the events in standard HTML 4 -and XHTML 1.

+

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 +and defines the events in standard HTML 4 and XHTML 1.

 @@ -359,8 +376,11 @@ 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, but it can have any number of attributes.

-

The default configuration defines the HTML links for standard HTML 4 -and XHTML 1.

+

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 +and defines the HTML links for standard HTML 4 and XHTML 1.