The "codepage" Module (v4)

Description

This module allows the server administrator to define what characters are allowed in nicknames and how characters should be compared in a case insensitive way.

Configuration

To load this module use the following <module> tag:

<module name="codepage">

<codepage>

The <codepage> tag defines settings about how the codepage module should behave. This tag can only be defined once.

Name	Type	Default Value	Description
name	Text	None	Required! The name of the codepage; sent to users in the CASEMAPPING 005 token.
charset	Text	None	If defined then the character set that the casemapping exists within; sent to users in the CASEMAPPING 005 token.

Example Usage

<codepage name="iso-8859-1"
          charset="iso-8859-1">

<cpcase>

The <cpcase> tag defines a mapping from lower case to upper case for two characters. This tag can be defined as many times as required.

Name	Type	Default Value	Description
lower	Number	None	A lower case character.
upper	Number	None	The upper case equivalent of the character in the lower field.

Example Usage

Marks "À" as the upper case equivalent of "à" in the ISO 8859-1 codepage.

<cpcase lower="192"
        upper="224">

<cpchars>

The <cpchars> tag defines a single character or inclusive range of characters that are allowed in nicknames. This tag can be defined as many times as required.

Name	Type	Default Value	Description
begin	Number	None	The start of an inclusive range of characters to allow in nicknames.
end	Number	None	The end of an inclusive range of characters to allow in nicknames.
front	Boolean	No	Whether the characters specified in this tag can exist at the start of a nickname.
index	Number	None	A character to allow in nicknames.

Example Usage

Allows the character with the numeric code point 45 in a nickname except as the first character.

<cpchars index="45"
         front="no">

Allows characters with the numeric code points in the inclusive range 123 to 125 at any point in a nickname:

<cpchars begin="123"
         end="125"
         front="yes">

Special Notes

The following code pages for use with this module are present in the config examples directory.

Code page	Include Tag
ascii	<include file="examples/codepages/ascii.example.conf">
iso-8859-1	<include file="examples/codepages/iso-8859-1.example.conf">
iso-8859-2	<include file="examples/codepages/iso-8859-2.example.conf">
rfc1459	<include file="examples/codepages/rfc1459.example.conf">
strict-rfc1459	<include file="examples/codepages/strict-rfc1459.example.conf">