home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278363_mod_speling.xml < prev    next >
Extensible Markup Language  |  2004-04-17  |  4KB  |  115 lines
  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.3.2.4 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_speling.xml.meta">
  23.  
  24. <name>mod_speling</name>
  25. <description>Attempts to correct mistaken URLs that
  26. users might have entered by ignoring capitalization and by
  27. allowing up to one misspelling</description>
  28. <status>Extension</status>
  29. <sourcefile>mod_speling.c</sourcefile>
  30. <identifier>speling_module</identifier>
  31.  
  32.  
  33.  
  34. <summary>
  35.  
  36.     <p>Requests to documents sometimes cannot be served by the core
  37.     apache server because the request was misspelled or
  38.     miscapitalized. This module addresses this problem by trying to
  39.     find a matching document, even after all other modules gave up.
  40.     It does its work by comparing each document name in the
  41.     requested directory against the requested document name
  42.     <strong>without regard to case</strong>, and allowing
  43.     <strong>up to one misspelling</strong> (character insertion /
  44.     omission / transposition or wrong character). A list is built
  45.     with all document names which were matched using this
  46.     strategy.</p>
  47.  
  48.     <p>If, after scanning the directory,</p>
  49.  
  50.     <ul>
  51.       <li>no matching document was found, Apache will proceed as
  52.       usual and return a "document not found" error.</li>
  53.  
  54.       <li>only one document is found that "almost" matches the
  55.       request, then it is returned in the form of a redirection
  56.       response.</li>
  57.  
  58.       <li>more than one document with a close match was found, then
  59.       the list of the matches is returned to the client, and the
  60.       client can select the correct candidate.</li>
  61.     </ul>
  62.  
  63. </summary>
  64.  
  65.  
  66. <directivesynopsis>
  67. <name>CheckSpelling</name>
  68. <description>Enables the spelling 
  69. module</description>
  70. <syntax>CheckSpelling on|off</syntax>
  71. <default>CheckSpelling Off</default>
  72. <contextlist>
  73. <context>server config</context>
  74. <context>virtual host</context>
  75. <context>directory</context>
  76. <context>.htaccess</context>
  77. </contextlist>
  78. <override>Options</override>
  79. <compatibility>CheckSpelling was available as a separately available
  80. module for Apache 1.1, but was limited to miscapitalizations. As
  81. of Apache 1.3, it is part of the Apache distribution. Prior to Apache
  82. 1.3.2, the <code>CheckSpelling</code> directive was only available in the
  83. "server" and "virtual host" contexts.</compatibility>
  84.  
  85. <usage>
  86.  
  87.     <p>This directive enables or disables the spelling module. When
  88.     enabled, keep in mind that</p>
  89.  
  90.     <ul>
  91.       <li>the directory scan which is necessary for the spelling
  92.       correction will have an impact on the server's performance
  93.       when many spelling corrections have to be performed at the
  94.       same time.</li>
  95.  
  96.       <li>the document trees should not contain sensitive files
  97.       which could be matched inadvertently by a spelling
  98.       "correction".</li>
  99.  
  100.       <li>the module is unable to correct misspelled user names (as
  101.       in <code>http://my.host/~apahce/</code>), just file names or
  102.       directory names.</li>
  103.  
  104.       <li>spelling corrections apply strictly to existing files, so
  105.       a request for the <code><Location /status></code> may
  106.       get incorrectly treated as the negotiated file
  107.       "<code>/stats.html</code>".</li>
  108.     </ul>
  109. </usage>
  110.  
  111. </directivesynopsis>
  112.  
  113. </modulesynopsis>
  114.  
  115.