]> granicus.if.org Git - apache/blobdiff - docs/manual/mod/mod_negotiation.xml
Merge in APR[-util] macros from branches/trunk-buildconf-noapr
[apache] / docs / manual / mod / mod_negotiation.xml
index 8afaff070ce04a323c283ebc71a969f46c8f4791..97a11b04b06ae0edcaae6575d2002dcebdda1b98 100644 (file)
@@ -122,12 +122,12 @@ Negotiation</a></seealso>
       <dd>uri of the file containing the variant (of the given
       media type, encoded with the given content encoding). These
       are interpreted as URLs relative to the map file; they must
-      be on the same server (!), and they must refer to files to
+      be on the same server, and they must refer to files to
       which the client would be granted access if they were to be
       requested directly.</dd>
 
       <dt><code>Body:</code></dt>
-      <dd>New in Apache 2.0, the actual content of the resource may
+      <dd>The actual content of the resource may
       be included in the type-map file using the Body header.  This
       header must contain a string that designates a delimiter for
       the body content. Then all following lines in the type map
@@ -145,6 +145,56 @@ Negotiation</a></seealso>
       </example>
       </dd>
     </dl>
+
+    <p>Consider, for example, a resource called
+    <code>document.html</code> which is available in English, French,
+    and German. The files for each of these are called
+    <code>document.html.en</code>, <code>document.html.fr</code>, and
+    <code>document.html.de</code>, respectively. The type map file will
+    be called <code>document.html.var</code>, and will contain the
+    following:</p>
+
+    <example>
+    URI: document.html<br />
+    <br />
+    Content-language: en<br />
+    Content-type: text/html<br />
+    URI: document.html.en<br />
+    <br />
+    Content-language: fr<br />
+    Content-type: text/html<br />
+    URI: document.html.fr<br />
+    <br />
+    Content-language: de<br />
+    Content-type: text/html<br />
+    URI: document.html.de<br />
+    <br />
+
+    </example>
+
+    <p>All four of these files should be placed in the same directory,
+    and the <code>.var</code> file should be associated with the
+    <code>type-map</code> handler with an <directive
+    module="mod_mime">AddHandler</directive> directive:</p>
+
+    <highlight language="config">
+    AddHandler type-map .var
+    </highlight>
+
+    <p>A request for <code>document.html.var</code> in this directory will
+    result in choosing the variant which most closely matches the language preference
+    specified in the user's <code>Accept-Language</code> request
+    header.</p>
+
+    <p>If <code>Multiviews</code> is enabled, and <directive module="mod_mime"
+    >MultiviewsMatch</directive> is set to "handlers" or "any",  a request to
+    <code>document.html</code> will discover <code>document.html.var</code> and
+    continue negotiating with the explicit type map.</p>
+
+    <p>Other configuration directives, such as <directive module="mod_alias"
+    >Alias</directive> can be used to map <code>document.html</code> to
+    <code>document.html.var</code>.</p>
+
 </section>
 
 <section id="multiviews"><title>Multiviews</title>
@@ -167,13 +217,12 @@ Negotiation</a></seealso>
 
 <directivesynopsis>
 <name>CacheNegotiatedDocs</name>
-<description>Allows content-negotiated documents to be 
+<description>Allows content-negotiated documents to be
 cached by proxy servers</description>
 <syntax>CacheNegotiatedDocs On|Off</syntax>
 <default>CacheNegotiatedDocs Off</default>
 <contextlist><context>server config</context><context>virtual host</context>
 </contextlist>
-<compatibility>The syntax changed in version 2.0.</compatibility>
 
 <usage>
     <p>If set, this directive allows content-negotiated documents
@@ -187,23 +236,18 @@ cached by proxy servers</description>
     the caching of negotiated documents, and this directive has no
     effect in responses to HTTP/1.1 requests.</p>
 
-    <p>Prior to version 2.0,
-    <directive>CacheNegotiatedDocs</directive> did not take an
-    argument; it was turned on by the presence of the directive by
-    itself.</p>
 </usage>
 </directivesynopsis>
 
 <directivesynopsis>
 <name>ForceLanguagePriority</name>
-<description>Action to take if a single acceptable document is not 
+<description>Action to take if a single acceptable document is not
 found</description>
 <syntax>ForceLanguagePriority None|Prefer|Fallback [Prefer|Fallback]</syntax>
 <default>ForceLanguagePriority Prefer</default>
 <contextlist><context>server config</context><context>virtual host</context>
 <context>directory</context><context>.htaccess</context></contextlist>
 <override>FileInfo</override>
-<compatibility>Available in version 2.0.30 and later</compatibility>
 
 <usage>
     <p>The <directive>ForceLanguagePriority</directive> directive uses
@@ -221,10 +265,10 @@ found</description>
     (equally acceptable) then the first matching variant, <code>en</code>,
     will be served.</p>
 
-    <example>
-      LanguagePriority en fr de<br />
-      ForceLanguagePriority Prefer
-    </example>
+    <highlight language="config">
+LanguagePriority en fr de
+ForceLanguagePriority Prefer
+    </highlight>
 
     <p><code>ForceLanguagePriority Fallback</code> uses
     <directive module="mod_negotiation">LanguagePriority</directive> to
@@ -235,10 +279,10 @@ found</description>
     variant from the <directive module="mod_negotiation"
     >LanguagePriority</directive> list below will be served.</p>
 
-    <example>
-      LanguagePriority en fr de<br />
-      ForceLanguagePriority Fallback
-    </example>
+    <highlight language="config">
+LanguagePriority en fr de
+ForceLanguagePriority Fallback
+    </highlight>
 
     <p>Both options, <code>Prefer</code> and <code>Fallback</code>, may be
     specified, so either the first matching variant from <directive
@@ -252,7 +296,7 @@ found</description>
 
 <directivesynopsis>
 <name>LanguagePriority</name>
-<description>The precendence of language variants for cases where
+<description>The precedence of language variants for cases where
 the client does not express a preference</description>
 <syntax>LanguagePriority <var>MIME-lang</var> [<var>MIME-lang</var>]
 ...</syntax>
@@ -266,9 +310,9 @@ the client does not express a preference</description>
     express a preference, when handling a Multiviews request. The list
     of <var>MIME-lang</var> are in order of decreasing preference.</p>
 
-    <example><title>Example:</title>
+    <highlight language="config">
       LanguagePriority en fr de
-    </example>
+    </highlight>
 
     <p>For a request for <code>foo.html</code>, where
     <code>foo.html.fr</code> and <code>foo.html.de</code> both