manual/mod/mod_speling.html

	mod_speling.html revision 2eaf662cbc81e823e8d9aeb8d54e69e63032493e
0N/A<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2362N/A    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
0N/A
0N/A<html xmlns="http://www.w3.org/1999/xhtml">
0N/A  <head>
0N/A    <meta name="generator" content="HTML Tidy, see www.w3.org" />
2362N/A
0N/A    <title>Apache module mod_speling</title>
2362N/A  </head>
0N/A  <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
0N/A
0N/A  <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
0N/A  vlink="#000080" alink="#FF0000">
0N/A    <!--#include virtual="header.html" -->
0N/A
0N/A    <h1 align="CENTER">Module mod_speling</h1>
0N/A
0N/A    <p>This module attempts to correct misspellings of URLs that
0N/A    users might have entered, by ignoring capitalization and by
0N/A    allowing up to one misspelling.</p>
2362N/A
2362N/A    <p><a href="module-dict.html#Status"
2362N/A    rel="Help"><strong>Status:</strong></a> Extension<br />
0N/A     <a href="module-dict.html#SourceFile"
0N/A    rel="Help"><strong>Source File:</strong></a>
0N/A    mod_speling.c<br />
0N/A     <a href="module-dict.html#ModuleIdentifier"
0N/A    rel="Help"><strong>Module Identifier:</strong></a>
0N/A    speling_module<br />
0N/A     <a href="module-dict.html#Compatibility"
0N/A    rel="Help"><strong>Compatibility:</strong></a> Available in
0N/A    Apache 1.3 and later. Available as an External module in Apache
0N/A    1.1 and later.</p>
0N/A
0N/A    <h2>Summary</h2>
0N/A
0N/A    <p>Requests to documents sometimes cannot be served by the core
0N/A    apache server because the request was misspelled or
0N/A    miscapitalized. This module addresses this problem by trying to
0N/A    find a matching document, even after all other modules gave up.
0N/A    It does its work by comparing each document name in the
0N/A    requested directory against the requested document name
0N/A    <strong>without regard to case</strong>, and allowing
0N/A    <strong>up to one misspelling</strong> (character insertion /
0N/A    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>
    <br />
     <br />


    <h2>Directives</h2>

    <ul>
      <li><a href="#checkspelling">CheckSpelling</a></li>
    </ul>
    <hr />
    <!-- the HR is part of the directive description -->

    <h2><a id="checkspelling"
    name="checkspelling">CheckSpelling</a> directive</h2>
    <!--%plaintext &lt;?INDEX {\tt CheckSpelling} directive&gt; -->
    <a href="directive-dict.html#Syntax"
    rel="Help"><strong>Syntax:</strong></a> CheckSpelling
    on|off<br />
     <a href="directive-dict.html#Default"
    rel="Help"><strong>Default:</strong></a> <code>CheckSpelling
    Off</code><br />
     <a href="directive-dict.html#Context"
    rel="Help"><strong>Context:</strong></a> server config, virtual
    host, directory, .htaccess<br />
     <a href="directive-dict.html#Override"
    rel="Help"><strong>Override:</strong></a> Options <br />
     <a href="directive-dict.html#Status"
    rel="Help"><strong>Status:</strong></a> Base<br />
     <a href="directive-dict.html#Module"
    rel="Help"><strong>Module:</strong></a> mod_speling<br />
     <a href="directive-dict.html#Compatibility"
    rel="Help"><strong>Compatibility:</strong></a> 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
    <samp>CheckSpelling</samp> directive was only available in the
    "server" and "virtual host" contexts.

    <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 <samp>&lt;Location /status&gt;</samp> may
      get incorrectly treated as the negotiated file
      "<samp>/stats.html</samp>".</li>
    </ul>
    <!--#include virtual="footer.html" -->
  </body>
</html>