Mediawiki title normalization, that conforms to the normalization rules used in MediaWiki Core. In general, the page title is converted to the mediawiki DB key format by trimming spaces, replacing whitespace symbols to underscores and applying wiki-specific capitalization rules. The namespace name is converted to a localized canonical name.
Kind: global class
Represents a wiki namespace
Param | Type | Description |
---|---|---|
id | number | The namespace identifier |
siteInfo | SiteInfo | The site metadata information. |
Returns the numeric namespace identifier
Kind: instance method of Namespace
Checks whether namespace is Media
Kind: instance method of Namespace
Checks whether namespace is Special
Kind: instance method of Namespace
Checks whether namespace is Main
Kind: instance method of Namespace
Checks whether namespace is Talk
Kind: instance method of Namespace
Checks whether namespace is UserTalk
Kind: instance method of Namespace
Get the canonical name string for this namespace.
Kind: instance method of Namespace
Determines whether this namespace is equal to the given ns, based on the numeric namespace identifier.
Kind: instance method of Namespace
Creates a namespace instance from namespace text or a namespace alias
Kind: static method of Namespace Returns: Namespace | undefined - a namespace or undefined if it wasn't found.
Param | Type | Description |
---|---|---|
text | string | Namespace name text. |
siteInfo | SiteInfo | the site information. |
Creates a namespace object for a Main
namespace.
Kind: static method of Namespace
Param | Type | Description |
---|---|---|
siteInfo | SiteInfo | the site information. |
Kind: global class
Creates a new title object with article the dbKey and namespace
Param | Type | Description |
---|---|---|
key | string | The article title in a form of the dbKey. |
namespace | Namespace | number | The article namespace. |
siteInfo | SiteInfo | The site metadata. |
[fragment] | string | The fragment of the title. |
Returns the normalized article title and namespace.
Kind: instance method of Title
Returns the normalized fragment part of the original title
Kind: instance method of Title
Returns the namespace of an article.
Kind: instance method of Title
Determines whether this title is equals to the given title2, based on comparing namespace and key.
Kind: instance method of Title
Normalize a title according to the rules of siteInfo
Kind: static method of Title Returns: Title - The resulting title object.
Param | Type | Description |
---|---|---|
title | string | The page title to normalize. |
siteInfo | SiteInfo | The site information. |
Kind: global exception class
TitleError should be considered an opaque exception class, which is thrown by the various methods in this library. It is exported so that it can be identified if caught by the caller.
Information about a wikimedia site required to make correct normalization. This information matches the format used by the PHP API response, however not all of the fields are required for library operation.
The list of required properties is documented here, others can be removed.
Kind: global typedef Properties
Name | Type | Description |
---|---|---|
general | Object | General information about the site |
general.lang | string | Site language code. |
general.legaltitlechars | string | A perl-like regex for characters allowed in the page title. |
general.case | string | Whether to capitalize the first letter of the title. Could be obtained from the general section of the siteInfo php API response. |
namespaces | Object | Site namespaces info in the same format as returned by PHP api. |
namespacealiases | Object | Site namespace aliases in the same format as returned by PHP api. |
specialpagealiases | Object | Site special page aliases in the same format as returned by PHP api. |
The library synchronously returns a normalized title. Wiki-specific rules should be fetched from the MediaWiki API, and cached outside of the library. The description of the required properties is available in the SiteInfo object docs.
var result = Title.newFromText('some_title', {
general: {
lang: 'en',
legaltitlechars: " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+",
case: 'first-letter'
},
namespaces: {
"0": {
id: 0,
case: "first-letter",
content: "",
"*": ""
},
}
});
console.log(result.getPrefixedDBKey());
For bug reporting please use Phabricator
and mark the bugs with Services
label or contact directly in IRC in the #wikimedia-services channel.