granicus.if.org Git - apache/blob - docs/manual/mod/mod_speling.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
   4         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   5               This file is generated from xml source: DO NOT EDIT
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7       -->
   8 <title>mod_speling - Apache HTTP Server</title>
   9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
  12 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13 <body>
  14 <div id="page-header">
  15 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  16 <p class="apache">Apache HTTP Server Version 2.1</p>
  17 <img alt="" src="../images/feather.gif" /></div>
  18 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  19 <div id="path">
  20 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs-project/">Documentation</a> &gt; <a href="../">Version 2.1</a> &gt; <a href="./">Modules</a></div>
  21 <div id="page-content">
  22 <div id="preamble"><h1>Apache Module mod_speling</h1>
  23 <div class="toplang">
  24 <p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" hreflang="en" title="English">&nbsp;en&nbsp;</a> | <a href="../ja/mod/mod_speling.html" hreflang="ja" title="Japanese">&nbsp;ja&nbsp;</a></p>
  25 </div>
  26 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Attempts to correct mistaken URLs that
  27 users might have entered by ignoring capitalization and by
  28 allowing up to one misspelling</td></tr>
  29 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  30 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>speling_module</td></tr>
  31 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_speling.c</td></tr></table>
  32 <h3>Summary</h3>
  33
  34
  35     <p>Requests to documents sometimes cannot be served by the core
  36     apache server because the request was misspelled or
  37     miscapitalized. This module addresses this problem by trying to
  38     find a matching document, even after all other modules gave up.
  39     It does its work by comparing each document name in the
  40     requested directory against the requested document name
  41     <strong>without regard to case</strong>, and allowing
  42     <strong>up to one misspelling</strong> (character insertion /
  43     omission / transposition or wrong character). A list is built
  44     with all document names which were matched using this
  45     strategy.</p>
  46
  47     <p>If, after scanning the directory,</p>
  48
  49     <ul>
  50       <li>no matching document was found, Apache will proceed as
  51       usual and return a "document not found" error.</li>
  52
  53       <li>only one document is found that "almost" matches the
  54       request, then it is returned in the form of a redirection
  55       response.</li>
  56
  57       <li>more than one document with a close match was found, then
  58       the list of the matches is returned to the client, and the
  59       client can select the correct candidate.</li>
  60     </ul>
  61
  62 </div>
  63 <div id="quickview"><h3 class="directives">Directives</h3>
  64 <ul id="toc">
  65 <li><img alt="" src="../images/down.gif" /> <a href="#checkspelling">CheckSpelling</a></li>
  66 </ul>
  67 </div>
  68
  69 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  70 <div class="directive-section"><h2><a name="CheckSpelling" id="CheckSpelling">CheckSpelling</a> <a name="checkspelling" id="checkspelling">Directive</a></h2>
  71 <table class="directive">
  72 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the spelling
  73 module</td></tr>
  74 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CheckSpelling on|off</code></td></tr>
  75 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CheckSpelling Off</code></td></tr>
  76 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
  77 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
  78 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  79 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_speling</td></tr>
  80 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>CheckSpelling was available as a separately available
  81 module for Apache 1.1, but was limited to miscapitalizations. As
  82 of Apache 1.3, it is part of the Apache distribution. Prior to Apache
  83 1.3.2, the <code>CheckSpelling</code> directive was only available in the
  84 "server" and "virtual host" contexts.</td></tr>
  85 </table>
  86     <p>This directive enables or disables the spelling module. When
  87     enabled, keep in mind that</p>
  88
  89     <ul>
  90       <li>the directory scan which is necessary for the spelling
  91       correction will have an impact on the server's performance
  92       when many spelling corrections have to be performed at the
  93       same time.</li>
  94
  95       <li>the document trees should not contain sensitive files
  96       which could be matched inadvertently by a spelling
  97       "correction".</li>
  98
  99       <li>the module is unable to correct misspelled user names (as
 100       in <code>http://my.host/~apahce/</code>), just file names or
 101       directory names.</li>
 102
 103       <li>spelling corrections apply strictly to existing files, so
 104       a request for the <code>&lt;Location /status&gt;</code> may
 105       get incorrectly treated as the negotiated file
 106       "<code>/stats.html</code>".</li>
 107     </ul>
 108
 109
 110     <p>mod_speling should not be enabled in <a href="mod_dav.html">DAV</a>
 111     enabled directories, because it will try to "spell fix" newly created
 112     resource names against existing filenames, e.g., when trying to upload
 113     a new document <code>doc43.html</code> it might redirect to an existing
 114     document <code>doc34.html</code>, which is not what was intended.
 115     </p>
 116
 117 </div>
 118 </div>
 119 <div class="bottomlang">
 120 <p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" hreflang="en" title="English">&nbsp;en&nbsp;</a> | <a href="../ja/mod/mod_speling.html" hreflang="ja" title="Japanese">&nbsp;ja&nbsp;</a></p>
 121 </div><div id="footer">
 122 <p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</a></p>
 123 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 124 </body></html>