mod_speling.html revision e0b181d3bfa99dfb992df3024b397660cb7afbe9
1176124297af5c56e932c0863c6637ff21d8a0efTimo Sirainen<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
1176124297af5c56e932c0863c6637ff21d8a0efTimo Sirainen XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
1176124297af5c56e932c0863c6637ff21d8a0efTimo Sirainen This file is generated from xml source: DO NOT EDIT
c4b376dd6e0c423006d7ac83a39253bcaf8e7c47Timo Sirainen XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen --><title>mod_speling- Apache HTTP Server</title><link rel="stylesheet" type="text/css" href="/style/manual.css"/></head><body><blockquote><div align="center"><img src="/images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_speling</h1><table bgcolor="#cccccc" cellpadding="0" cellspacing="1"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Attempts to correct mistaken URLs that
c4b376dd6e0c423006d7ac83a39253bcaf8e7c47Timo Sirainenusers might have entered by ignoring capitalization and by
1176124297af5c56e932c0863c6637ff21d8a0efTimo Sirainenallowing up to one misspelling</td></tr><tr><td><a class="help" href="module-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="module-dict.html#ModuleIdentifier">Module Identifier:</a></td><td>speling_module</td></tr></table></td></tr></table><h2>Summary</h2>
20b2d47ed762ca2c009aa37e360af6f223ac71bdTimo Sirainen <p>Requests to documents sometimes cannot be served by the core
20b2d47ed762ca2c009aa37e360af6f223ac71bdTimo Sirainen apache server because the request was misspelled or
20b2d47ed762ca2c009aa37e360af6f223ac71bdTimo Sirainen miscapitalized. This module addresses this problem by trying to
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen find a matching document, even after all other modules gave up.
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen It does its work by comparing each document name in the
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen requested directory against the requested document name
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen <strong>without regard to case</strong>, and allowing
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen <strong>up to one misspelling</strong> (character insertion /
20b2d47ed762ca2c009aa37e360af6f223ac71bdTimo Sirainen omission / transposition or wrong character). A list is built
20b2d47ed762ca2c009aa37e360af6f223ac71bdTimo Sirainen with all document names which were matched using this
7327394e30c1020b9a2a49c72a7e3d0f7803e680Timo Sirainen strategy.</p>
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen <li>no matching document was found, Apache will proceed as
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen usual and return a "document not found" error.</li>
1176124297af5c56e932c0863c6637ff21d8a0efTimo Sirainen <li>only one document is found that "almost" matches the
55058d5f50f7e53bb22df4fa6ae951c8001416abTimo Sirainen request, then it is returned in the form of a redirection
55058d5f50f7e53bb22df4fa6ae951c8001416abTimo Sirainen response.</li>
55058d5f50f7e53bb22df4fa6ae951c8001416abTimo Sirainen <li>more than one document with a close match was found, then
7327394e30c1020b9a2a49c72a7e3d0f7803e680Timo Sirainen the list of the matches is returned to the client, and the
c4b376dd6e0c423006d7ac83a39253bcaf8e7c47Timo Sirainen client can select the correct candidate.</li>
c4b376dd6e0c423006d7ac83a39253bcaf8e7c47Timo Sirainen<h2>Directives</h2><ul><li><a href="#checkspelling">CheckSpelling</a></li></ul><hr/><h2><a name="CheckSpelling">CheckSpelling</a> <a name="checkspelling">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enables the spelling
1176124297af5c56e932c0863c6637ff21d8a0efTimo Sirainenmodule</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>CheckSpelling on|off</td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code>CheckSpelling Off</code></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>Options</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_speling</td></tr><tr><td valign="top" align="left"><a class="help" href="directive-dict.html#Compatibility">Compatibility:</a></td><td>CheckSpelling was available as a separately available
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenmodule for Apache 1.1, but was limited to miscapitalizations. As
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainenof Apache 1.3, it is part of the Apache distribution. Prior to Apache
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen1.3.2, the CheckSpelling directive was only available in the
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen"server" and "virtual host" contexts.</td></tr></table></td></tr></table>
4fc52b7b25c3d3f42348903e0154840f8761f306Timo Sirainen <p>This directive enables or disables the spelling module. When
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen enabled, keep in mind that</p>
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen <li>the directory scan which is necessary for the spelling
20b2d47ed762ca2c009aa37e360af6f223ac71bdTimo Sirainen correction will have an impact on the server's performance
1176124297af5c56e932c0863c6637ff21d8a0efTimo Sirainen when many spelling corrections have to be performed at the
