Extension:ParserFunctionsHelper

MediaWiki extensions manual

ParserFunctionsHelper Release status: beta
Implementation	Parser function
Description	Provides services to parser function extensions which require inserting content after the parsing phase.
Author(s)	Jean-Lou Dupont
Latest version	1.0.0
MediaWiki	1.10, 1.11, 1.12
License	No license specified
Download	SVN See SVN ($Id: ParserFunctionsHelper.doc.wikitext 736 2007-12-10 15:30:44Z jeanlou.dupont $)
Hooks used ParserAfterTidy
Translate the ParserFunctionsHelper extension if it is available at translatewiki.net
Check usage and version matrix; code metrics

Provides services to parser function extensions which require inserting content after the parsing phase.

This extension is meant to serve other extensions i.e. it does not provide any end-user functionality by itself.

Motivation

Parser functions can insert content during the parsing phase albeit not raw content i.e. content which should end-up untouched in the output page.

This extension allows for registering raw content which will replace anchors in the parsed wikitext.

Usage

Normally used in the render functions of parser functions and tag extensions.

function tagExtensionOrParserFunction_Render() {
  $key = 'pick-a-name';
  $value = 'html output that needs protection from wikiization';
  $index = null;
  $anchor = null;
  wfRunHooks( 'ParserFunctionsHelperSet',
              array( $key, $value, &$index, &$anchor ) );
 
  if ( $anchor === null) {
    return '[http://www.mediawiki.org/wiki/Extension:ParserFunctionsHelper ' .
      'Extension:ParserFunctionHelper] missing.';
  }
  return $anchor;
}

ParserFunctionsHelperSet Parameters

• $key: normally a name that describes the content you wish to output.
• $value: HTML content that you need to protect from wikiization.
• $index: Parameter is used to return data. Passed-in data will be ignored. Parameter that gives you the index of the store that your data is store in. Useless for most people's needs.
• $anchor: Parameter is used to return data. Passed-in data will be ignored. The $anchor is what you output onto the wiki page. The anchor is a unique marker that will be replaced with your html during the ParserAfterTidy Stage

Dependencies

• StubManager extension

Installation

See the Mediawiki Extension table entry "download" above.

LocalSettings.php

Extension:ExtensionManager: See footnote

• Add the following to LocalSettings.php, if the extension was downloaded from Jean-Lou Dupont's MediaWiki SVN directory (link in the download entry of the table above):

require_once "$IP/extensions/ParserFunctionsHelper/ParserFunctionsHelper.php";

• Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.

PEAR PEAR is a repository of PHP software code. Install the channel PEAR channel ' http://mediawiki.googlecode.com/svn ' pear channel-discover mediawiki.googlecode.com/svn Install extension through PEAR: pear install mediawiki/ParserFunctionsHelper Add the following to LocalSettings.php: require 'MediaWiki/ParserFunctionsHelper/ParserFunctionsHelper.php'; Note that the required version of PEAR must be respected. Currently, the minimum version of PEAR usable with this channel is v1.6.2. Perform the following command to upgrade to the latest version of PEAR: pear upgrade pear Upgrades through PEAR Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades. pear clear-cache or use the force method: pear upgrade --force mediawiki/ParserFunctionsHelper PEAR Web Frontend For easier remote package management, PEAR Frontend WEB can be installed. Installation notes can be found here. An example of the WEB frontend is available here.

RSS feed

To keep up-to-date with this channel, use the following RSS feed__.

Notes

Other Extensions From the same author

Consult User Jldupont's page.

---

History

Release	Notes
1.0.0	Initial public release