| <?xml version="1.0" encoding="ISO-8859-1"?> |
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| This file is generated from xml source: DO NOT EDIT |
| XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX |
| --> |
| <title>mod_speling - Apache HTTP Server</title> |
| <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> |
| <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> |
| <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /> |
| <link href="../images/favicon.ico" rel="shortcut icon" /></head> |
| <body> |
| <div id="page-header"> |
| <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> |
| <p class="apache">Apache HTTP Server Version 2.1</p> |
| <img alt="" src="../images/feather.gif" /></div> |
| <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div> |
| <div id="path"> |
| <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Modules</a></div> |
| <div id="page-content"> |
| <div id="preamble"><h1>Apache Module mod_speling</h1> |
| <div class="toplang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" title="English"> en </a> | |
| <a href="../ja/mod/mod_speling.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | |
| <a href="../ko/mod/mod_speling.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> |
| </div> |
| <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Attempts to correct mistaken URLs that |
| users might have entered by ignoring capitalization and by |
| allowing up to one misspelling</td></tr> |
| <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>speling_module</td></tr> |
| <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_speling.c</td></tr></table> |
| <h3>Summary</h3> |
| |
| |
| <p>Requests to documents sometimes cannot be served by the core |
| apache server because the request was misspelled or |
| miscapitalized. This module addresses this problem by trying to |
| find a matching document, even after all other modules gave up. |
| It does its work by comparing each document name in the |
| requested directory against the requested document name |
| <strong>without regard to case</strong>, and allowing |
| <strong>up to one misspelling</strong> (character insertion / |
| omission / transposition or wrong character). A list is built |
| with all document names which were matched using this |
| strategy.</p> |
| |
| <p>If, after scanning the directory,</p> |
| |
| <ul> |
| <li>no matching document was found, Apache will proceed as |
| usual and return a "document not found" error.</li> |
| |
| <li>only one document is found that "almost" matches the |
| request, then it is returned in the form of a redirection |
| response.</li> |
| |
| <li>more than one document with a close match was found, then |
| the list of the matches is returned to the client, and the |
| client can select the correct candidate.</li> |
| </ul> |
| |
| </div> |
| <div id="quickview"><h3 class="directives">Directives</h3> |
| <ul id="toc"> |
| <li><img alt="" src="../images/down.gif" /> <a href="#checkspelling">CheckSpelling</a></li> |
| </ul> |
| </div> |
| |
| <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> |
| <div class="directive-section"><h2><a name="CheckSpelling" id="CheckSpelling">CheckSpelling</a> <a name="checkspelling" id="checkspelling">Directive</a></h2> |
| <table class="directive"> |
| <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the spelling |
| module</td></tr> |
| <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CheckSpelling on|off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CheckSpelling Off</code></td></tr> |
| <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr> |
| <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr> |
| <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> |
| <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_speling</td></tr> |
| <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>CheckSpelling was available as a separately available |
| module for Apache 1.1, but was limited to miscapitalizations. As |
| of Apache 1.3, it is part of the Apache distribution. Prior to Apache |
| 1.3.2, the <code>CheckSpelling</code> directive was only available in the |
| "server" and "virtual host" contexts.</td></tr> |
| </table> |
| <p>This directive enables or disables the spelling module. When |
| enabled, keep in mind that</p> |
| |
| <ul> |
| <li>the directory scan which is necessary for the spelling |
| correction will have an impact on the server's performance |
| when many spelling corrections have to be performed at the |
| same time.</li> |
| |
| <li>the document trees should not contain sensitive files |
| which could be matched inadvertently by a spelling |
| "correction".</li> |
| |
| <li>the module is unable to correct misspelled user names (as |
| in <code>http://my.host/~apahce/</code>), just file names or |
| directory names.</li> |
| |
| <li>spelling corrections apply strictly to existing files, so |
| a request for the <code><Location /status></code> may |
| get incorrectly treated as the negotiated file |
| "<code>/stats.html</code>".</li> |
| </ul> |
| |
| |
| <p>mod_speling should not be enabled in <a href="mod_dav.html">DAV</a> |
| enabled directories, because it will try to "spell fix" newly created |
| resource names against existing filenames, e.g., when trying to upload |
| a new document <code>doc43.html</code> it might redirect to an existing |
| document <code>doc34.html</code>, which is not what was intended. |
| </p> |
| |
| </div> |
| </div> |
| <div class="bottomlang"> |
| <p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" title="English"> en </a> | |
| <a href="../ja/mod/mod_speling.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> | |
| <a href="../ko/mod/mod_speling.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p> |
| </div><div id="footer"> |
| <p class="apache">Copyright 1999-2004 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p> |
| <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> |
| </body></html> |