]> granicus.if.org Git - apache/commitdiff
Add <glossary> tag for mime-type where appropriate.
authorJoshua Slive <slive@apache.org>
Wed, 21 Sep 2005 20:11:21 +0000 (20:11 +0000)
committerJoshua Slive <slive@apache.org>
Wed, 21 Sep 2005 20:11:21 +0000 (20:11 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@290816 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/content-negotiation.xml
docs/manual/howto/cgi.xml
docs/manual/mod/core.xml
docs/manual/mod/mod_actions.xml
docs/manual/mod/mod_include.xml
docs/manual/mod/mod_mime.xml
docs/manual/mod/mod_mime_magic.xml
docs/manual/mod/mod_negotiation.xml
docs/manual/mod/mod_rewrite.xml
docs/manual/programs/configure.xml

index 500511403dca6976aaf6f6662948a6ba420562aa..febc707a750d1a0119d516abe11d87b94897b349 100644 (file)
 
    <section id="type-map"><title>Using a type-map file</title>
 
-    <p>A type map is a document which is associated with the
-    handler named <code>type-map</code> (or, for
-    backwards-compatibility with older Apache configurations, the
-    MIME type <code>application/x-type-map</code>). Note that to
-    use this feature, you must have a handler set in the
-    configuration that defines a file suffix as
-    <code>type-map</code>; this is best done with</p>
+    <p>A type map is a document which is associated with the handler
+    named <code>type-map</code> (or, for backwards-compatibility with
+    older Apache configurations, the <glossary>MIME-type</glossary>
+    <code>application/x-type-map</code>). Note that to use this
+    feature, you must have a handler set in the configuration that
+    defines a file suffix as <code>type-map</code>; this is best done
+    with</p>
 
 <example>AddHandler type-map .var</example>
 
index b80c9e784ecf9dc16405999e51617359cbcacbb0..8ead27955337f54a3a44252176c9d7a392e31211 100644 (file)
     programming, and CGI programming.</p>
 
     <p>First, all output from your CGI program must be preceded by
-    a MIME-type header. This is HTTP header that tells the client
+    a <glossary>MIME-type</glossary> header. This is HTTP header that tells the client
     what sort of content it is receiving. Most of the time, this
     will look like:</p>
 
index 7e32546b73c4f6df2a02c1dc54ee3afce8b4cf23..4f10298cb7863e5099e2e1ee2e19293f60a1ea3c 100644 (file)
@@ -247,7 +247,7 @@ content-type is <code>text/plain</code> or <code>text/html</code></description>
 <usage>
     <p>This directive activates a particular output <a
     href="../filter.html">filter</a> for a request depending on the
-    response MIME-type.</p>
+    response <glossary>MIME-type</glossary>.</p>
 
     <p>The following example uses the <code>DEFLATE</code> filter, which
     is provided by <module>mod_deflate</module>. It will compress all
@@ -281,7 +281,7 @@ content-type is <code>text/plain</code> or <code>text/html</code></description>
     <note type="warning"><title>Note</title>
       <p>Enabling filters with <directive>AddOutputFilterByType</directive>
       may fail partially or completely in some cases. For example, no
-      filters are applied if the MIME-type could not be determined  and falls
+      filters are applied if the <glossary>MIME-type</glossary> could not be determined  and falls
       back to the <directive module="core">DefaultType</directive> setting,
       even if the <directive module="core">DefaultType</directive> is the
       same.</p>
@@ -582,8 +582,8 @@ server cannot determine a type in any other way</description>
 
 <usage>
     <p>There will be times when the server is asked to provide a
-    document whose type cannot be determined by its MIME types
-    mappings.</p>
+    document whose type cannot be determined by its <glossary
+    ref="mime-type">MIME types</glossary> mappings.</p>
 
     <p>The server must inform the client of the content-type of the
     document, so in the event of an unknown type it uses the
index 4dfb90d4860ce11b1c8634a11dfb3cb5176cf3eb..235981bf1c90e763fa8a03dc2f9365d646900015 100644 (file)
@@ -34,12 +34,12 @@ media type or request method.</description>
 <summary>
     <p>This module has two directives. The <directive
     module="mod_actions">Action</directive> directive lets you run CGI
-    scripts whenever a file of a certain MIME content type is requested. The
+    scripts whenever a file of a certain <glossary
+    ref="mime-type">MIME content type</glossary> is requested. The
     <directive module="mod_actions">Script</directive> directive lets
     you run CGI scripts whenever a particular method is used in a
     request. This makes it much easier to execute scripts that process
-    files.</p>
-</summary>
+    files.</p> </summary>
 
 <seealso><module>mod_cgi</module></seealso>
 <seealso><a href="../howto/cgi.html">Dynamic Content with CGI</a></seealso>
@@ -60,17 +60,18 @@ introduced in Apache 2.1</compatibility>
 
 <usage>
     <p>This directive adds an action, which will activate
-    <var>cgi-script</var> when <var>action-type</var> is triggered by the
-    request.  The <var>cgi-script</var> is the URL-path to a resource
-    that has been designated as a CGI script using <directive
+    <var>cgi-script</var> when <var>action-type</var> is triggered by
+    the request.  The <var>cgi-script</var> is the URL-path to a
+    resource that has been designated as a CGI script using <directive
     module="mod_alias">ScriptAlias</directive> or <directive
     module="mod_mime">AddHandler</directive>.  The
     <var>action-type</var> can be either a <a
-    href="../handler.html">handler</a> or a MIME content type. It
-    sends the URL and file path of the requested document using the
-    standard CGI <code>PATH_INFO</code> and <code>PATH_TRANSLATED</code>
-    environment variables. The handler used for the particular request is
-    passed using the <code>REDIRECT_HANDLER</code> variable.</p>
+    href="../handler.html">handler</a> or a <glossary
+    ref="mime-type">MIME content type</glossary>. It sends the URL and
+    file path of the requested document using the standard CGI
+    <code>PATH_INFO</code> and <code>PATH_TRANSLATED</code>
+    environment variables. The handler used for the particular request
+    is passed using the <code>REDIRECT_HANDLER</code> variable.</p>
 
     <example><title>Examples</title>
       # Requests for files of a particular MIME content type:<br />
index 435e2604d3b1fd9433bf8319617ca21b57a06b14..5f8355b02870a059b855d183e605680066c7c3d9 100644 (file)
 
     <section id="element.include"><title>The include Element</title>
       <p>This command inserts the text of another document or file
-      into the parsed file. Any included file is subject to the
-      usual access control. If the directory containing the
-      parsed file has <a href="core.html#options">Options</a>
-      <code>IncludesNOEXEC</code> set, then only documents with
-      a text MIME type (<code>text/plain</code>, <code>text/html</code>
-      etc.) will be included. Otherwise CGI scripts are invoked as normal
-      using the complete URL given in the command, including any query
-      string.</p>
+      into the parsed file. Any included file is subject to the usual
+      access control. If the directory containing the parsed file has
+      <a href="core.html#options">Options</a>
+      <code>IncludesNOEXEC</code> set, then only documents with a text
+      <glossary>MIME-type</glossary> (<code>text/plain</code>,
+      <code>text/html</code> etc.) will be included. Otherwise CGI
+      scripts are invoked as normal using the complete URL given in
+      the command, including any query string.</p>
 
       <p>An attribute defines the location of the document; the
       inclusion is done for each attribute given to the include
@@ -757,7 +757,7 @@ set</description>
 <usage>
     <p>The <directive>XBitHack</directive> directive controls the parsing
     of ordinary html documents. This directive only affects files associated
-    with the MIME type <code>text/html</code>. <directive
+    with the <glossary>MIME-type</glossary> <code>text/html</code>. <directive
     >XBitHack</directive> can take on the following values:</p>
 
     <dl>
index b811495375e82a04a9daa28dd2ce50634a62dcf4..1c372172e8133a8d3895554f7bcff18ce035f714 100644 (file)
@@ -49,7 +49,7 @@
     module="mod_mime">AddType</directive> are all used to map file
     extensions onto the meta-information for that file. Respectively
     they set the character set, content-encoding, content-language,
-    and MIME-type (content-type) of documents.  The directive <directive
+    and <glossary>MIME-type</glossary> (content-type) of documents.  The directive <directive
     module="mod_mime">TypesConfig</directive> is used to specify a
     file which also maps extensions onto MIME types. </p>
 
@@ -103,14 +103,15 @@ module="mod_mime_magic">MimeMagicFile</directive></seealso>
     extensions is <em>normally</em> irrelevant. For example, if the
     file <code>welcome.html.fr</code> maps onto content type
     <code>text/html</code> and language French then the file
-    <code>welcome.fr.html</code> will map onto exactly the same information.
-    If more than one extension is given which maps onto the same
-    type of meta-information, then the one to the right will be
-    used, except for languages and content encodings. For example, if
-    <code>.gif</code> maps to the MIME-type <code>image/gif</code> and
-    <code>.html</code> maps to the MIME-type <code>text/html</code>, then the
-    file <code>welcome.gif.html</code> will be associated with the MIME-type
-    <code>text/html</code>.</p>
+    <code>welcome.fr.html</code> will map onto exactly the same
+    information.  If more than one extension is given which maps onto
+    the same type of meta-information, then the one to the right will
+    be used, except for languages and content encodings. For example,
+    if <code>.gif</code> maps to the <glossary>MIME-type</glossary>
+    <code>image/gif</code> and <code>.html</code> maps to the
+    MIME-type <code>text/html</code>, then the file
+    <code>welcome.gif.html</code> will be associated with the
+    MIME-type <code>text/html</code>.</p>
 
     <p><a href="#charset-lang">Languages</a> and <a href="#contentencoding"
     >content encodings</a> are treated accumulative, because one can assign
@@ -120,7 +121,7 @@ module="mod_mime_magic">MimeMagicFile</directive></seealso>
     text/html</code>.</p>
 
     <p>Care should be taken when a file with multiple extensions
-    gets associated with both a MIME-type and a handler. This will
+    gets associated with both a <glossary>MIME-type</glossary> and a handler. This will
     usually result in the request being by the module associated
     with the handler. For example, if the <code>.imap</code>
     extension is mapped to the handler <code>imap-file</code> (from
@@ -134,7 +135,7 @@ module="mod_mime_magic">MimeMagicFile</directive></seealso>
 </section>
 
 <section id="contentencoding"><title>Content encoding</title>
-    <p>A file of a particular MIME type can additionally be encoded a
+    <p>A file of a particular <glossary>MIME-type</glossary> can additionally be encoded a
     particular way to simplify transmission over the Internet.
     While this usually will refer to compression, such as
     <code>gzip</code>, it can also refer to encryption, such a
@@ -479,13 +480,15 @@ type</description>
 <override>FileInfo</override>
 
 <usage>
-    <p>The <directive>AddType</directive> directive maps the given filename
-    extensions onto the specified content type. <var>MIME-type</var> is the
-    MIME type to use for filenames containing <var>extension</var>. This
-    mapping is added to any already in force, overriding any mappings that
-    already exist for the same <var>extension</var>. This directive can
-    be used to add mappings not listed in the MIME types file (see the
-    <directive module="mod_mime">TypesConfig</directive> directive).</p>
+    <p>The <directive>AddType</directive> directive maps the given
+    filename extensions onto the specified content
+    type. <var>MIME-type</var> is the <glossary ref="mime-type">MIME
+    type</glossary> to use for filenames containing
+    <var>extension</var>. This mapping is added to any already in
+    force, overriding any mappings that already exist for the same
+    <var>extension</var>. This directive can be used to add mappings
+    not listed in the MIME types file (see the <directive
+    module="mod_mime">TypesConfig</directive> directive).</p>
     
     <example><title>Example</title>
       AddType image/gif .gif
@@ -823,11 +826,12 @@ extensions</description>
 <override>FileInfo</override>
 
 <usage>
-    <p>The <directive>RemoveType</directive> directive removes any MIME
-    type associations for files with the given extensions. This allows
-    <code>.htaccess</code> files in subdirectories to undo any
-    associations inherited from parent directories or the server
-    config files. An example of its use might be:</p>
+    <p>The <directive>RemoveType</directive> directive removes any
+    <glossary ref="mime-type">MIME type</glossary> associations for files with
+    the given extensions. This allows <code>.htaccess</code> files in
+    subdirectories to undo any associations inherited from parent
+    directories or the server config files. An example of its use
+    might be:</p>
 
     <example><title>/foo/.htaccess:</title>
       RemoveType .cgi
@@ -858,20 +862,22 @@ extensions</description>
 <contextlist><context>server config</context></contextlist>
 
 <usage>
-    <p>The <directive>TypesConfig</directive> directive sets the location
-    of the MIME types configuration file. <var>File-path</var> is relative
-    to the <directive module="core">ServerRoot</directive>. This file sets
+    <p>The <directive>TypesConfig</directive> directive sets the
+    location of the <glossary ref="mime-type">MIME types</glossary>
+    configuration file. <var>File-path</var> is relative to the
+    <directive module="core">ServerRoot</directive>. This file sets
     the default list of mappings from filename extensions to content
-    types. Most administrators use the provided <code>mime.types</code>
-    file, which associates common filename extensions with IANA registered
-    content types. The current list is maintained at <a href=
+    types. Most administrators use the provided
+    <code>mime.types</code> file, which associates common filename
+    extensions with IANA registered content types. The current list is
+    maintained at <a href=
     "http://www.iana.org/assignments/media-types/index.html"
-    >http://www.iana.org/assignments/media-types/index.html</a>.
-    This simplifies the <code>httpd.conf</code> file by providing the
+    >http://www.iana.org/assignments/media-types/index.html</a>.  This
+    simplifies the <code>httpd.conf</code> file by providing the
     majority of media-type definitions, and may be overridden by
     <directive module="mod_mime">AddType</directive> directives as
-    needed. You should not edit the <code>mime.types</code> file, because
-    it may be replaced when you upgrade your server.</p>
+    needed. You should not edit the <code>mime.types</code> file,
+    because it may be replaced when you upgrade your server.</p>
 
     <p>The file contains lines in the format of the arguments to
     an <directive module="mod_mime">AddType</directive> directive:</p>
index 70d00681506be45ea95a695dbce6e427a6d2e450..53f88e5fc31d5c5fec61ae0ac16c107dfbbb2ccc 100644 (file)
 <identifier>mime_magic_module</identifier>
 
 <summary>
-    <p>This module determines the MIME type of files in the same
-    way the Unix <code>file(1)</code> command works: it looks at the first
-    few bytes of the file. It is intended as a "second line of defense"
+    <p>This module determines the <glossary ref="mime-type">MIME
+    type</glossary> of files in the same way the Unix
+    <code>file(1)</code> command works: it looks at the first few
+    bytes of the file. It is intended as a "second line of defense"
     for cases that <module>mod_mime</module> can't resolve.</p>
 
     <p>This module is derived from a free version of the
index 8a16763d97b2aba82b9bed59cedc6535d10a211b..4cec684c84ed55a1448646040b255f3885f93eb5 100644 (file)
@@ -88,10 +88,11 @@ Negotiation</a></seealso>
       <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>
index d08d3c1c38df3b336cbcb1db37dae2a4969796bc..42763cc0c7a82a33976258fb3b4eea481800ec47 100644 (file)
@@ -1474,7 +1474,7 @@ When using the NOT character
         <li>
         '<strong><code>type|T</code></strong>=<em>MIME-type</em>'
         (force MIME <strong>t</strong>ype)<br />
-         Force the MIME-type of the target file to be
+         Force the <glossary>MIME-type</glossary> of the target file to be
         <em>MIME-type</em>. For instance, this can be used to
         setup the content-type based on some conditions.
         For example, the following snippet allows <code>.php</code> files to
index cf59786a7a8c10e29ef4bde778b424d90c695cda..5ad7dad7ac4893ea6d3d7d046aa718a2d1a208d3 100644 (file)
           to the server without this module.</dd>
 
         <dt><code>--disable-mime</code></dt>
-        <dd><module>mod_mime</module> associates the requested filename's
-          extensions with the file's behavior and content (mime-type,
-          language, character set and encoding). Disabling the mapping of
-          file-extensions to MIME is normally not recommended.</dd>
+        <dd><module>mod_mime</module> associates the requested
+        filename's extensions with the file's behavior and content
+        (<glossary>mime-type</glossary>, language, character set and
+        encoding). Disabling this module is normally not recommended.</dd>
 
         <dt><code>--disable-negotiation</code></dt>
         <dd>Disable content negotiation provided by
         <dd>Enable memory caching provided by
           <module>mod_mem_cache</module>.</dd>
 
-        <dt><code>--enable-mime-magic</code></dt>
-        <dd>Enable automatical determining of MIME types, which is provided by
-          <module>mod_mime_magic</module>.</dd>
+        <dt><code>--enable-mime-magic</code></dt> 
+        <dd>Enable
+        automatical determining of <glossary ref="mime-type">MIME
+        types</glossary>, which is provided by
+        <module>mod_mime_magic</module>.</dd>
 
         <dt><code>--enable-isapi</code></dt>
         <dd>Enable the isapi extension support provided by