Extension:ConditionalContent

From MediaWiki.org

Jump to: navigation, search
Manual on MediaWiki Extensions
List of MediaWiki Extensions
ConditionalContent

Release status: beta

Implementation Parser extension
Description
Author(s) Jean-Lou Dupont
Version 1.0.0
MediaWiki 1.11
Download SVN
See SVN ($Id: ConditionalContent.doc.wikitext 760 2007-12-14 02:33:05Z jeanlou.dupont $)

Contents

[edit] Purpose

Provides parser functions #cc and #ccd for controlling the conditional inclusion of pages.

[edit] Features

  • Secure:
    • The user must have the read right to the target pages (i.e. page_true and page_false)
  • Dynamic
  • Flexible comparaison mechanism

[edit] Usage

[edit] #cc

  • {{#cc:page_true|condition|comparator|page_false}}
    • Where page_true corresponds the to the page to include when condition==comparator
    • Where page_false corresponds the to the page to include when condition!=comparator

[edit] #ccd

The following parser-function is really meant to be used in conjunction with Extension:ParserPhase2. The same parameters as #cc apply to #ccd. The use of ParserPhase2 enables the dynamic inclusion of page content whilst still preserving the virtues of parser-caching for both the source and target pages.

(($#ccd|page_true|condition|comparator|page_false$))

[edit] Examples

[edit] Example1

The text following the semicolon should read true : {{#cc:Extension:ConditionalContent_testpage_true|1|1|Extension:ConditionalContent_testpage_false}}

[edit] Example2

The text following the semicolon should read false : {{#cc:Extension:ConditionalContent_testpage_true|0|1|Extension:ConditionalContent_testpage_false}}

[edit] Dependancies



[edit] Installation

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

[edit] LocalSettings.php

Extension:ExtensionManager: See footnote[2]

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

[edit] PEAR

PEAR is a repository of software code.

pear channel-discover mediawiki.googlecode.com/svn
  • Install extension through PEAR:
pear install mediawiki/ConditionalContent
  • Add the following to LocalSettings.php[2][3]:
require 'MediaWiki/ConditionalContent/ConditionalContent.php';

[edit] 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/ConditionalContent

[edit] 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.

[edit] RSS feed

To keep kept up-to-date with this channel, use the following RSS feedImage:Rss2.jpg.

[edit] Notes

  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

Release Notes
1.0.0 Initial Release
Personal tools
In other languages