mediawiki-title

mediawiki-title

Mediawiki title normalizetion, 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 capitalizetion rules. The namespace name is converted to a localized canonical name.

API

• Normalizer
  • new Normalizer(options)
  • .normalize(title, domain) ⇒ P.<string>

new Normalizer(options)

Creates an instance of title normalizer.

Param	Type	Description
options	Object	the normalizer options
options.apiURI	function	a function that takes a domain string and returns back an API URI that needs to be contacted to get the site information used for normalization.

normalizer.normalize(title, domain) ⇒ P.<string>

Normalize a title according to the rules of

Kind: instance method of Normalizer
Returns: P.<string> - normalized version of a title.
Access: public

Param	Type	Description
title	string	the page title to normalize.
domain	string	the domain page belongs to.

Usage

The library returns a Bluebird promise of a normalized title. Wiki-specific rules are fetched from the api, and cached within the Normalizer instance, so reusing the instance is highly recommended.

var normalizer = new Normalizer({
  apiURI: function(domain) { return 'https://' + domain + '/w/api.php'; }
});

normalizer.normalize(title, 'en.wikipedia.org')
.then(function(normalizedTitle) {
  console.log(normalizedTitle);
})
.catch(function(e) {
  console.log('The title is ivalid! ' + e.message);
});

Bug reporting

For bug reporting please use Phabricator ] and mark the bugs with Servises label or contuct directly in IRC in the #wikimedia-services channel.