General review and updating of document. Added mention of the other

modules located in the modules/mappers directory that aren't already
mentioned, and made a note to come back and flesh this out a little
later.

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

diff --git a/docs/manual/urlmapping.html.en b/docs/manual/urlmapping.html.en
index ffdece5e1f317b6533d972556d8e9415959f8e6d..cc1c2c07a83786140fcff955c439f9521e17f03e 100644 (file)
--- a/docs/manual/urlmapping.html.en
+++ b/docs/manual/urlmapping.html.en
@@ -37,12 +37,13 @@
 <li><img alt="" src="./images/down.gif" /> <a href="#proxy">Reverse Proxy</a></li>
 <li><img alt="" src="./images/down.gif" /> <a href="#rewrite">Rewriting Engine</a></li>
 <li><img alt="" src="./images/down.gif" /> <a href="#notfound">File Not Found</a></li>
+<li><img alt="" src="./images/down.gif" /> <a href="#other">Other URL Mapping Modules</a></li>
 </ul></div>
 <div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 <div class="section">
 <h2><a name="related" id="related">Related Modules and Directives</a></h2>
 
-<table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="./mod/mod_alias.html">mod_alias</a></code></li><li><code class="module"><a href="./mod/mod_proxy.html">mod_proxy</a></code></li><li><code class="module"><a href="./mod/mod_rewrite.html">mod_rewrite</a></code></li><li><code class="module"><a href="./mod/mod_userdir.html">mod_userdir</a></code></li><li><code class="module"><a href="./mod/mod_speling.html">mod_speling</a></code></li><li><code class="module"><a href="./mod/mod_vhost_alias.html">mod_vhost_alias</a></code></li></ul></td><td><ul><li><code class="directive"><a href="./mod/mod_alias.html#alias">Alias</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#aliasmatch">AliasMatch</a></code></li><li><code class="directive"><a href="./mod/mod_speling.html#checkspelling">CheckSpelling</a></code></li><li><code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code></li><li><code class="directive"><a href="./mod/core.html#errordocument">ErrorDocument</a></code></li><li><code class="directive"><a href="./mod/core.html#options">Options</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypass">ProxyPass</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypassreverse">ProxyPassReverse</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypassreversecookiedomain">ProxyPassReverseCookieDomain</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypassreversecookiepath">ProxyPassReverseCookiePath</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#redirect">Redirect</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#redirectmatch">RedirectMatch</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewritecond">RewriteCond</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewriterule">RewriteRule</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#scriptaliasmatch">ScriptAliasMatch</a></code></li><li><code class="directive"><a href="./mod/mod_userdir.html#userdir">UserDir</a></code></li></ul></td></tr></table>
+<table class="related"><tr><th>Related Modules</th><th>Related Directives</th></tr><tr><td><ul><li><code class="module"><a href="./mod/mod_actions.html">mod_actions</a></code></li><li><code class="module"><a href="./mod/mod_alias.html">mod_alias</a></code></li><li><code class="module"><a href="./mod/mod_dir.html">mod_dir</a></code></li><li><code class="module"><a href="./mod/mod_imagemap.html">mod_imagemap</a></code></li><li><code class="module"><a href="./mod/mod_negotiation.html">mod_negotiation</a></code></li><li><code class="module"><a href="./mod/mod_proxy.html">mod_proxy</a></code></li><li><code class="module"><a href="./mod/mod_rewrite.html">mod_rewrite</a></code></li><li><code class="module"><a href="./mod/mod_speling.html">mod_speling</a></code></li><li><code class="module"><a href="./mod/mod_userdir.html">mod_userdir</a></code></li><li><code class="module"><a href="./mod/mod_vhost_alias.html">mod_vhost_alias</a></code></li></ul></td><td><ul><li><code class="directive"><a href="./mod/mod_alias.html#alias">Alias</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#aliasmatch">AliasMatch</a></code></li><li><code class="directive"><a href="./mod/mod_speling.html#checkspelling">CheckSpelling</a></code></li><li><code class="directive"><a href="./mod/core.html#documentroot">DocumentRoot</a></code></li><li><code class="directive"><a href="./mod/core.html#errordocument">ErrorDocument</a></code></li><li><code class="directive"><a href="./mod/core.html#options">Options</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypass">ProxyPass</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypassreverse">ProxyPassReverse</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypassreversecookiedomain">ProxyPassReverseCookieDomain</a></code></li><li><code class="directive"><a href="./mod/mod_proxy.html#proxypassreversecookiepath">ProxyPassReverseCookiePath</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#redirect">Redirect</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#redirectmatch">RedirectMatch</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewritecond">RewriteCond</a></code></li><li><code class="directive"><a href="./mod/mod_rewrite.html#rewriterule">RewriteRule</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#scriptalias">ScriptAlias</a></code></li><li><code class="directive"><a href="./mod/mod_alias.html#scriptaliasmatch">ScriptAliasMatch</a></code></li><li><code class="directive"><a href="./mod/mod_userdir.html#userdir">UserDir</a></code></li></ul></td></tr></table>
 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 <div class="section">
 <h2><a name="documentroot" id="documentroot">DocumentRoot</a></h2>
@@ -200,7 +201,7 @@
 of the local server.  This technique is called <em>reverse
 proxying</em> because the web server acts like a proxy server by
 fetching the documents from a remote server and returning them to the
-client.  It is different from normal proxying because, to the client,
+client.  It is different from normal (forward) proxying because, to the client,
 it appears the documents originate at the reverse proxy server.</p>
 
 <p>In the following example, when clients request documents under the
@@ -226,11 +227,19 @@ directory on the local server.  Similarly, the
 and <code class="directive"><a href="./mod/mod_proxy.html#proxypassreversecookiepath">ProxyPassReverseCookiePath</a></code>
 rewrite cookies set by the backend server.</p>
 <p>It is important to note, however, that
-links inside the documents will not be rewritten.  So any absolute
+links inside the documents will not be rewritten. So any absolute
 links on <code>internal.example.com</code> will result in the client
 breaking out of the proxy server and requesting directly from
-<code>internal.example.com</code>.  A third-party module
-<a href="http://apache.webthing.com/mod_proxy_html/">mod_proxy_html</a>
+<code>internal.example.com</code>. You can modify these links (and other
+content) in a page as it is being served to the client using
+<code class="module"><a href="./mod/mod_substitute.html">mod_substitute</a></code>.</p>
+
+<div class="example"><p><code>
+Substitute s/internal\.example\.com/www.example.com/i
+</code></p></div>
+
+<p>Additionally, a third-party module,
+<a href="http://apache.webthing.com/mod_proxy_html/">mod_proxy_html</a>,
 is available to rewrite links in HTML and XHTML.</p>
 </div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
 <div class="section">
@@ -238,7 +247,7 @@ is available to rewrite links in HTML and XHTML.</p>
 
     <p>When even more powerful substitution is required, the rewriting
     engine provided by <code class="module"><a href="./mod/mod_rewrite.html">mod_rewrite</a></code>
-    can be useful. The directives provided by this module use
+    can be useful. The directives provided by this module can use
     characteristics of the request such as browser type or source IP
     address in deciding from where to serve content. In addition,
     mod_rewrite can use external database files or programs to
@@ -287,6 +296,26 @@ is available to rewrite links in HTML and XHTML.</p>
     and can be customized in a flexible manner as discussed in the
     <a href="custom-error.html">Custom error responses</a>
     document.</p>
+</div><div class="top"><a href="#page-header"><img alt="top" src="./images/up.gif" /></a></div>
+<div class="section">
+<h2><a name="other" id="other">Other URL Mapping Modules</a></h2>
+
+
+
+    <p>Other modules available for URL mapping include:
+    <ul>
+    <li><code class="module"><a href="./mod/mod_actions.html">mod_actions</a></code> - Maps a request to a CGI script
+    based on the request method, or resource MIME type.</li>
+    <li><code class="module"><a href="./mod/mod_dir.html">mod_dir</a></code> - Provides basic mapping of a trailing
+    slash into an index file such as <code>index.html</code>.</li>
+    <li><code class="module"><a href="./mod/mod_imagemap.html">mod_imagemap</a></code> - Maps a request to a URL based
+    on where a user clicks on an image embedded in a HTML document.</li>
+    <li><code class="module"><a href="./mod/mod_negotiation.html">mod_negotiation</a></code> - Selects an appropriate
+    document based on client preferences such as language or content
+    compression.</li>
+    </ul>
+    </p>
+
 </div></div>
 <div class="bottomlang">
 <p><span>Available Languages: </span><a href="./en/urlmapping.html" title="English">&nbsp;en&nbsp;</a> |

diff --git a/docs/manual/urlmapping.xml b/docs/manual/urlmapping.xml
index db6b6e090aea4b4b82065298215ec9f313401077..e316622f0ccf2264a2179921842c11c4cea30f2b 100644 (file)
--- a/docs/manual/urlmapping.xml
+++ b/docs/manual/urlmapping.xml
@@ -34,11 +34,15 @@
 
 <related>
 <modulelist>
+<module>mod_actions</module>
 <module>mod_alias</module>
+<module>mod_dir</module>
+<module>mod_imagemap</module>
+<module>mod_negotiation</module>
 <module>mod_proxy</module>
 <module>mod_rewrite</module>
-<module>mod_userdir</module>
 <module>mod_speling</module>
+<module>mod_userdir</module>
 <module>mod_vhost_alias</module>
 </modulelist>
 <directivelist>
@@ -227,7 +231,7 @@
 of the local server.  This technique is called <em>reverse
 proxying</em> because the web server acts like a proxy server by
 fetching the documents from a remote server and returning them to the
-client.  It is different from normal proxying because, to the client,
+client.  It is different from normal (forward) proxying because, to the client,
 it appears the documents originate at the reverse proxy server.</p>
 
 <p>In the following example, when clients request documents under the
@@ -253,11 +257,19 @@ directory on the local server.  Similarly, the
 and <directive module="mod_proxy">ProxyPassReverseCookiePath</directive>
 rewrite cookies set by the backend server.</p>
 <p>It is important to note, however, that
-links inside the documents will not be rewritten.  So any absolute
+links inside the documents will not be rewritten. So any absolute
 links on <code>internal.example.com</code> will result in the client
 breaking out of the proxy server and requesting directly from
-<code>internal.example.com</code>.  A third-party module
-<a href="http://apache.webthing.com/mod_proxy_html/">mod_proxy_html</a>
+<code>internal.example.com</code>. You can modify these links (and other
+content) in a page as it is being served to the client using
+<module>mod_substitute</module>.</p>
+
+<example>
+Substitute s/internal\.example\.com/www.example.com/i
+</example>
+
+<p>Additionally, a third-party module,
+<a href="http://apache.webthing.com/mod_proxy_html/">mod_proxy_html</a>,
 is available to rewrite links in HTML and XHTML.</p>
 </section>
 
@@ -265,7 +277,7 @@ is available to rewrite links in HTML and XHTML.</p>
 
     <p>When even more powerful substitution is required, the rewriting
     engine provided by <module>mod_rewrite</module>
-    can be useful. The directives provided by this module use
+    can be useful. The directives provided by this module can use
     characteristics of the request such as browser type or source IP
     address in deciding from where to serve content. In addition,
     mod_rewrite can use external database files or programs to
@@ -316,4 +328,24 @@ is available to rewrite links in HTML and XHTML.</p>
     document.</p>
 </section>
 
+<section id="other"><title>Other URL Mapping Modules</title>
+
+<!-- TODO Flesh out each of the items in the list below. -->
+
+    <p>Other modules available for URL mapping include:
+    <ul>
+    <li><module>mod_actions</module> - Maps a request to a CGI script
+    based on the request method, or resource MIME type.</li>
+    <li><module>mod_dir</module> - Provides basic mapping of a trailing
+    slash into an index file such as <code>index.html</code>.</li>
+    <li><module>mod_imagemap</module> - Maps a request to a URL based
+    on where a user clicks on an image embedded in a HTML document.</li>
+    <li><module>mod_negotiation</module> - Selects an appropriate
+    document based on client preferences such as language or content
+    compression.</li>
+    </ul>
+    </p>
+
+</section>
+
 </manualpage>