Module Wikitext

This module defines the Wikitext class, accessible via Mwbot.Wikitext, which provides methods for parsing and modifying wikitext.

Core Class

• WikitextStatic (instance members: Wikitext)

Usage:

import { Mwbot, MwbotInitOptions } from 'mwbot-ts';

const initOptions: MwbotInitOptions = {...};
Mwbot.init(initOptions).then((mwbot) => {
  const wikitext = new mwbot.Wikitext('your wikitext');
  // Wikitext manipulations...
});
Copy

Object Types

The Wikitext class consists of both:

• Plain objects, which store parsed structures without additional behavior.
• Classes, which encapsulate certain wiki markups as structured instances.

Plain Objects:

• Tag: Represents parsed HTML tags. This object is returned by Wikitext.parseTags.
• Parameter: Represents parsed {{{parameter}}} markups. This object is returned by Wikitext.parseParameters.
• Section: Represents parsed sections. This object is returned by Wikitext.parseSections.

Classes:

{{double-braced}} markups:

• Template: Encapsulates {{template}} markups as objects. Accessible via Mwbot.Template.
  • ParsedTemplate: A subclass of Template, whose instances are returned by Wikitext.parseTemplates. Its constructor is inaccessible.
• ParserFunction: Encapsulates {{#parserfunction:}} markups. Accessible via Mwbot.ParserFunction.
  • ParsedParserFunction: A subclass of ParserFunction, whose instances are returned by Wikitext.parseTemplates. Its constructor is inaccessible.
• RawTemplate: Encapsulates {{template}} markups with an unparsable title. Instances are returned by Wikitext.parseTemplates. Its constructor is inaccessible.

[[double-bracketed]] markups:

• Wikilink: Encapsulates [[wikilink]] markups with a non-file title. Accessible via Mwbot.Wikilink.
  • ParsedWikilink: A subclass of Wikilink, whose instances are returned by Wikitext.parseWikilinks. Its constructor is inaccessible.
• FileWikilink: Encapsulates [[File:...]] markups. Accessible via Mwbot.FileWikilink.
  • ParsedFileWikilink: A subclass of FileWikilink, whose instances are returned by Wikitext.parseWikilinks. Its constructor is inaccessible.
• RawWikilink: Encapsulates [[wikilink]] markups with an unparsable title. Accessible via Mwbot.RawWikilink.
  • ParsedRawWikilink: A subclass of RawWikilink, whose instances are returned by Wikitext.parseWikilinks. Its constructor is inaccessible.