Extension:PageFunctions
From MediaWiki.org
 Release status: beta |
|
|---|---|
| Implementation | Parser extension |
| Author(s) | Jean-Lou Dupont |
| Latest 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 $) |
|
Translate the PageFunctions extension if it is available at translatewiki.net |
|
| Check usage and version matrix; code metrics | |
Contents
Purpose[edit | edit source]
Provides a 'magic word' interface to retrieve useful page level information.
Features[edit | edit source]
- 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
Usage[edit | edit source]
- {{#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}}
-
- Where 'group' is the user's group membership check to perform
- {{#imgviewurl:image page name}} (no dot add the prefix Image:)
(($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$))
DEPENDENCIES[edit | edit source]
- Extension:StubManager extension
- Extension:ParserPhase2 extension (optional)
Installation[edit | edit source]
See the Mediawiki Extension table entry "download" above.[1]
LocalSettings.php[edit | edit source]
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[edit | edit source]PEAR is a repository of PHP software code.
pear channel-discover mediawiki.googlecode.com/svn
pear install mediawiki/ParserExt require 'MediaWiki/ParserExt/ParserExt.php';
pear upgrade pear Upgrades through PEAR[edit | edit source]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/ParserExt PEAR Web Frontend[edit | edit source]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[edit | edit source]
To keep up-to-date with this channel, use the following RSS feed__
.
Notes[edit | edit source]
Other Extensions From the same author[edit | edit source]
Consult User Jldupont's page.
- ↑ The most recent release is always available through the extension's PEAR and SVN repositories. This page is not necessarily up-to-date.
- ↑ 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. - ↑ Modifications to
LocalSettings.phpis only necessary if not using Extension:ExtensionManager
HISTORY[edit | edit source]
- Adjusted singleton invocation to accomodate more PHP versions
- Added hook 'PageVarGet'
- Added hook 'PageVarSet'
- Added 'noclientcaching' magic word
- Added 'noext' magic word
1.1.0[edit | edit source]
- Added functionality to enable proper page title clearing
1.2.0[edit | edit source]
- Added 'imgviewurl' parser function
