<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
-<modulesynopsis>
+<!-- $LastChangedRevision$ -->
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<modulesynopsis metafile="mod_negotiation.xml.meta">
<name>mod_negotiation</name>
<description>Provides for <a
<code>type-map</code>) which explicitly lists the files
containing the variants.</li>
- <li>A MultiViews search (enabled by the <code>MultiViews</code>
+ <li>A Multiviews search (enabled by the <code>Multiviews</code>
<directive module="core">Options</directive>), where the server does
an implicit filename pattern match, and choose from amongst the
results.</li>
<dt><code>Content-Type:</code></dt>
<dd>
- The MIME media type of the document, with optional
- parameters. Parameters are separated from the media type
- and from one another by a semi-colon, with a syntax of
- <code>name=value</code>. Common parameters include:
+ The <glossary ref="mime-type">MIME media type</glossary> of
+ the document, with optional parameters. Parameters are
+ separated from the media type and from one another by a
+ semi-colon, with a syntax of <code>name=value</code>. Common
+ parameters include:
<dl>
<dt><code>level</code></dt>
0.</dd>
<dt><code>qs</code></dt>
- <dd>a floating-point number with a value in the range 0.0
- to 1.0, indicating the relative 'quality' of this variant
+ <dd>a floating-point number with a value in the range 0[.000]
+ to 1[.000], indicating the relative 'quality' of this variant
compared to the other available variants, independent of
the client's capabilities. For example, a jpeg file is
usually of higher source quality than an ascii file if it
<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
</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>
- <p>A MultiViews search is enabled by the <code>MultiViews</code>
+<section id="multiviews"><title>Multiviews</title>
+ <p>A Multiviews search is enabled by the <code>Multiviews</code>
<directive module="core">Options</directive>. If the server receives a
request for <code>/some/dir/foo</code> and
<code>/some/dir/foo</code> does <em>not</em> exist, then the
content-encodings it would have if the client had asked for one
of them by name. It then chooses the best match to the client's
requirements, and returns that document.</p>
+
+ <p>The <directive module="mod_mime">MultiviewsMatch</directive>
+ directive configures whether Apache will consider files
+ that do not have content negotiation meta-information assigned
+ to them when choosing files.</p>
</section>
<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
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
the given <directive
module="mod_negotiation">LanguagePriority</directive> to satisfy
- negotation where the server could otherwise not return a single
+ negotiation where the server could otherwise not return a single
matching document.</p>
<p><code>ForceLanguagePriority Prefer</code> uses
(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
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
<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>
<usage>
<p>The <directive>LanguagePriority</directive> sets the precedence
of language variants for the case where the client does not
- express a preference, when handling a MultiViews request. The list
+ 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
<p>Note that this directive only has an effect if a 'best'
language cannot be determined by any other means or the <directive
module="mod_negotiation">ForceLanguagePriority</directive> directive
- is not <code>None</code>. Correctly implemented HTTP/1.1 requests
- will mean this directive has no effect.</p>
+ is not <code>None</code>. In general, the client determines the
+ language preference, not the server.</p>
</usage>
<seealso><directive module="mod_mime">AddLanguage</directive></seealso>
</directivesynopsis>
projects / apache / blobdiff