Extension:PageFunctions

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

PageFunctions Release status: beta
Implementation	Parser extension
Description
Author(s)	Jean-Lou Dupont
Last Version	1.2.0
MediaWiki	1.10, 1.11
License	No license specified
Download	SVN See SVN ($Id: PageFunctions.doc.wikitext 724 2007-12-07 20:17:12Z jeanlou.dupont $)
check usage (experimental)

[edit] Purpose

Provides a 'magic word' interface to retrieve useful page level information.

[edit] Features

• Page Title change '#pagetitle'
• Page Sub-title change '#pagesubtitle'
• Page existence check '#pageexists'
• Page scope variable set '#varset'
• Page scope variable get '#varget'
• Page scope variable set & capture '#varcapset'
• Wikitext conditional 'show'
• Hook based variable get and set
• Client side page caching control
• Return the url required to view an image imgviewurl

[edit] Usage

• {{#pagetitle: new title name}}
• {{#pagesubtitle: text to be added to the page's subtitle }}
• {{#pageexists: 'article title' }}
• {{#varset:variable name|value }}
• {{#varget:variable name}}
• {{#varaset:variable name|array key|array value}}
• {{#varaget:variable name|array key}}
• {{#varcapset:variable name|value}}
• {{#cshow:group|text}}
• {{#imgviewurl:image page name}} (no dot add the prefix Image:)
  • Where 'group' is the user's group membership check to perform

(($disable$)) Of course, the same magic words can be used in the context of 'ParserCache2' i.e.

• (($#pagetitle: new title name$))
• (($#pagesubtitle: text to be added to the page's subtitle $))
• (($#pageexists: 'article title' $))
• (($#varset:variable name|value $))
• (($#varget:variable name $))
• (($#varaset:variable name|array key|array value$))
• (($#varaget:variable name|array key$))
• (($#varcapset:variable name|value$))
• (($#cshow:group|text$))
• (($noclientcaching$))

[edit] DEPENDENCIES

• Extension:StubManager extension
• Extension:ParserPhase2 extension (optional)

[edit] Installation

See the Mediawiki Extension table entry "download" above.^[1]

[edit] LocalSettings.php

Extension:ExtensionManager: See footnote^[2]

• 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)^[2]:

require_once( "$IP/extensions/ParserExt/ParserExt.php" );

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

pear channel-discover mediawiki.googlecode.com/svn

pear install mediawiki/ParserExt

require 'MediaWiki/ParserExt/ParserExt.php';

pear upgrade pear

pear clear-cache

pear upgrade --force mediawiki/ParserExt

[edit] RSS feed

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

[edit] Notes

[edit] Other Extensions From the same author

Consult User Jldupont's page.

1. ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
2. ↑ ^{2.0 2.1 2.2} Extension:ExtensionManager does not require any modification to LocalSettings.php because ExtensionManager includes the extension.
   Note that if PHP code caching is in place (e.g. APC, eAccelerator), then to successfully complete the installation a cache flush might be needed.
3. ↑ Modifications to LocalSettings.php is only necessary if not using Extension:ExtensionManager

[edit] HISTORY

• Adjusted singleton invocation to accomodate more PHP versions
• Added hook 'PageVarGet'
• Added hook 'PageVarSet'
• Added 'noclientcaching' magic word
• Added 'noext' magic word

[edit] 1.1.0

• Added functionality to enable proper page title clearing

[edit] 1.2.0

• Added 'imgviewurl' parser function