- publishing free software manuals
The Apache HTTP Server Reference Manual
by Apache Software Foundation
Paperback (6"x9"), 862 pages
ISBN 9781906966034
RRP £19.95 ($29.95)

Get a printed copy>>>

3.69  Apache Module mod_speling



Description:

Attempts to correct mistaken URLs that users might have entered by ignoring capitalization and by allowing up to one misspelling

Status:

Extension

Module Identifier:

speling_module

Source File:

mod_speling.c



Summary

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 without regard to case, and allowing up to one misspelling (character insertion / omission / transposition or wrong character). A list is built with all document names which were matched using this strategy.

If, after scanning the directory,

Directives:

CheckCaseOnly

CheckSpelling

CheckCaseOnly Directive

Description:

Limits the action of the speling module to case corrections

Syntax:

CheckCaseOnly on|off

Default:

CheckCaseOnly Off

Context:

server config, virtual host, directory, .htaccess

Override:

Options

Status:

Extension

Module:

mod_speling

When set, this directive limits the action of the spelling correction to lower/upper case changes. Other potential corrections are not performed.

CheckSpelling Directive

Description:

Enables the spelling module

Syntax:

CheckSpelling on|off

Default:

CheckSpelling Off

Context:

server config, virtual host, directory, .htaccess

Override:

Options

Status:

Extension

Module:

mod_speling

Compatibility:

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 CheckSpelling directive was only available in the "server" and "virtual host" contexts.

This directive enables or disables the spelling module. When enabled, keep in mind that

mod_speling should not be enabled in DAV (p. 462) 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 doc43.html it might redirect to an existing document doc34.html, which is not what was intended.

ISBN 9781906966034The Apache HTTP Server Reference ManualSee the print edition