mwstake/mediawiki-component-wikitext

Provides wikitext handling and tree parsing

Maintainers

Details

github.com/hallowelt/mwstake-mediawiki-component-wikitext

Source

Issues

Installs: 14 914

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 1

6.0.1 2023-12-18 08:18 UTC

Requires

Requires (Dev)

GPL-3.0-only f9e7928e73d05e755fbe25855db090b4e575c0e1

This package is auto-updated.

Last update: 2024-11-18 10:30:30 UTC

README

WikiText for MediaWiki

This code is meant to be executed within the MediaWiki application context. No standalone usage is intended.

Use in a MediaWiki extension

MediaWiki 1.35

  • Add "mwstake/mediawiki-component-wikitext": "~5" to the require section of your composer.json file.

MediaWiki 1.39

  • Add "mwstake/mediawiki-component-wikitext": "~6" to the require section of your composer.json file.

Since 2.0 explicit initialization is required. This can be achived by

  • either adding "callback": "mwsInitComponents" to your extension.json/skin.json
  • or calling mwsInitComponents(); within you extensions/skins custom callback method

See also mwstake/mediawiki-componentloader.

Available Services

  • MWStakeWikitextParserFactory
  • MWStakeWikitextNodeProcessorRegistryFactory

Using the MenuParser

/* @var MediaWiki\Revision\RevisionRecord */
$revision = $this->getRevision();

/* @var MWStake\MediaWiki\Component\Wikitext\ParserFactory */
$parserFactory = MediaWiki\MediaWikiServices::getInstance()->get( 'MWStakeWikitextParserFactory' );

/* @var MWStake\MediaWiki\Component\Wikitext\Parser\MenuParser */
$menuParser = $parserFactory->newMenuParser( $revision );

/* @var MWStake\MediaWiki\Component\Wikitext\INode[] */
$nodes = $parser->parse();