1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" 4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 5 6<html xmlns="http://www.w3.org/1999/xhtml"> 7 <head> 8 <meta name="generator" content="HTML Tidy, see www.w3.org" /> 9 10 <title>Apache module mod_speling</title> 11 </head> 12 <!-- Background white, links blue (unvisited), navy (visited), red (active) --> 13 14 <body bgcolor="#FFFFFF" text="#000000" link="#0000FF" 15 vlink="#000080" alink="#FF0000"> 16 <div align="CENTER"> 17 <img src="../images/sub.gif" alt="[APACHE DOCUMENTATION]" /> 18 19 <h3>Apache HTTP Server Version 1.3</h3> 20 </div> 21 22 23 <h1 align="CENTER">Module mod_speling</h1> 24 25 <p>This module attempts to correct misspellings of URLs that 26 users might have entered, by ignoring capitalization and by 27 allowing up to one misspelling.</p> 28 29 <p><a href="module-dict.html#Status" 30 rel="Help"><strong>Status:</strong></a> Extension<br /> 31 <a href="module-dict.html#SourceFile" 32 rel="Help"><strong>Source File:</strong></a> 33 mod_speling.c<br /> 34 <a href="module-dict.html#ModuleIdentifier" 35 rel="Help"><strong>Module Identifier:</strong></a> 36 speling_module<br /> 37 <a href="module-dict.html#Compatibility" 38 rel="Help"><strong>Compatibility:</strong></a> Available in 39 Apache 1.3 and later. Available as an External module in Apache 40 1.1 and later.</p> 41 42 <h2>Summary</h2> 43 44 <p>Requests to documents sometimes cannot be served by the core 45 apache server because the request was misspelled or 46 miscapitalized. This module addresses this problem by trying to 47 find a matching document, even after all other modules gave up. 48 It does its work by comparing each document name in the 49 requested directory against the requested document name 50 <strong>without regard to case</strong>, and allowing 51 <strong>up to one misspelling</strong> (character insertion / 52 omission / transposition or wrong character). A list is built 53 with all document names which were matched using this 54 strategy.</p> 55 56 <p>If, after scanning the directory,</p> 57 58 <ul> 59 <li>no matching document was found, Apache will proceed as 60 usual and return a "document not found" error.</li> 61 62 <li>only one document is found that "almost" matches the 63 request, then it is returned in the form of a redirection 64 response.</li> 65 66 <li>more than one document with a close match was found, then 67 the list of the matches is returned to the client, and the 68 client can select the correct candidate.</li> 69 </ul> 70 71 <h2>Directives</h2> 72 73 <ul> 74 <li><a href="#checkspelling">CheckSpelling</a></li> 75 </ul> 76 <hr /> 77 <!-- the HR is part of the directive description --> 78 79 <h2><a id="checkspelling" 80 name="checkspelling">CheckSpelling</a> directive</h2> 81 82 <a href="directive-dict.html#Syntax" 83 rel="Help"><strong>Syntax:</strong></a> CheckSpelling 84 on|off<br /> 85 <a href="directive-dict.html#Default" 86 rel="Help"><strong>Default:</strong></a> <code>CheckSpelling 87 Off</code><br /> 88 <a href="directive-dict.html#Context" 89 rel="Help"><strong>Context:</strong></a> server config, virtual 90 host, directory, .htaccess<br /> 91 <a href="directive-dict.html#Override" 92 rel="Help"><strong>Override:</strong></a> Options <br /> 93 <a href="directive-dict.html#Status" 94 rel="Help"><strong>Status:</strong></a> Base<br /> 95 <a href="directive-dict.html#Module" 96 rel="Help"><strong>Module:</strong></a> mod_speling<br /> 97 <a href="directive-dict.html#Compatibility" 98 rel="Help"><strong>Compatibility:</strong></a> CheckSpelling 99 was available as a separately available module for Apache 1.1, 100 but was limited to miscapitalizations. As of Apache 1.3, it is 101 part of the Apache distribution. Prior to Apache 1.3.2, the 102 <samp>CheckSpelling</samp> directive was only available in the 103 "server" and "virtual host" contexts. 104 105 <p>This directive enables or disables the spelling module. When 106 enabled, keep in mind that</p> 107 108 <ul> 109 <li>the directory scan which is necessary for the spelling 110 correction will have an impact on the server's performance 111 when many spelling corrections have to be performed at the 112 same time.</li> 113 114 <li>the document trees should not contain sensitive files 115 which could be matched inadvertently by a spelling 116 "correction".</li> 117 118 <li>the module is unable to correct misspelled user names (as 119 in <code>http://my.host/~apahce/</code>), just file names or 120 directory names.</li> 121 122 <li>spelling corrections apply strictly to existing files, so 123 a request for the <samp><Location /status></samp> may 124 get incorrectly treated as the negotiated file 125 "<samp>/stats.html</samp>".</li> 126 </ul> 127 <hr /> 128 129 <h3 align="CENTER">Apache HTTP Server Version 1.3</h3> 130 <a href="./"><img src="../images/index.gif" alt="Index" /></a> 131 <a href="../"><img src="../images/home.gif" alt="Home" /></a> 132 133 </body> 134</html> 135 136 137 138
