From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png

Release status: beta

Implementation Parser function
Author(s) Jean-Lou Dupont
Latest version 1.0.0
MediaWiki 1.10, 1.11
License No license specified
Download SVN
See SVN ($Id: GoogleCharts.doc.wikitext 731 2007-12-10 01:20:52Z jeanlou.dupont $)

Translate the GoogleCharts extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

Purpose[edit | edit source]

Provides a simple interface for embedding GoogleCharts.

One notable feature of this extension comes from the fact that the native GoogleCharts formatting language is almost entirely untouched and transparent; this allows for very easy forward compatibility.

Furthermore, the implementation through parser functions allows for very flexible templating capabilities.

Usage[edit | edit source]

gchart parser function[edit | edit source]

  • {{#gcharts: param1&param2&...[|alternate text]}}
    • each parameter must be separated by an &
    • alternate text is the text displayed if the chart can not be loaded

gchart_pipe parser function[edit | edit source]

Many optional parameters of the GoogleCharts must be separated with the pipe | character. This character bears syntaxical meaning in MediaWiki and thus must be accounted for in a special way. The use of the parser function gcharts_pipe solves this issue.

  • {{#gcharts_pipe: param1,param2, ...}}
    • Each parameter must be coma separated and the produced output parameter list will be pipe | separated.

gchart_senc parser function[edit | edit source]

Chart data can be encoded three ways:

  • Simple Encoding
  • Text Encoding
  • Extended Encoding

The parser function gcharts_senc implements the Simple Encoding function:

  • {{#gcharts_senc: params | maxvalue}}
    • params is a coma separated parameter list
    • maxvalue corresponds to the maximum value found in the data set

Example[edit | edit source]


Documentation[edit | edit source]

The official source of information for GoogleCharts can be found here.

Dependencies[edit | edit source]

Installation[edit source]

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

LocalSettings.php[edit source]

Extension:ExtensionManager: See footnote[2]

require_once "$IP/extensions/GoogleCharts/GoogleCharts.php";
  • Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.

PEAR[edit source]

PEAR is a repository of PHP software code.

pear channel-discover mediawiki.googlecode.com/svn
  • Install extension through PEAR:
pear install mediawiki/GoogleCharts
  • Add the following to LocalSettings.php[2][3]:
require 'MediaWiki/GoogleCharts/GoogleCharts.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[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/GoogleCharts

PEAR Web Frontend[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 source]

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

Notes[edit source]

Other Extensions From the same author[edit source]

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

History[edit | edit source]

Release Notes
1.0.0 Initial public release

TODO[edit | edit source]

  • Implement a parser function to simplify the Extended Encoding format

See Also[edit | edit source]