Extension:GoogleCharts

From MediaWiki.org

Manual on MediaWiki Extensions
List of MediaWiki Extensions

GoogleCharts Release status: beta
Implementation	Parser function
Description
Author(s)	Jean-Lou Dupont
Last 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 $)
check usage (experimental)

[edit] Purpose

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.

[edit] Usage

[edit] gchart parser function

• {{#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

[edit] gchart_pipe parser function

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.

[edit] gchart_senc parser function

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

[edit] Example

{{#gcharts:cht=p3&chd=s:hW&chs=250x100&chl={{#gcharts_pipe:Hello,World}}}}

[edit] Documentation

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

[edit] Dependancy

• StubManager extension

[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/GoogleCharts/GoogleCharts.php" );

pear channel-discover mediawiki.googlecode.com/svn

pear install mediawiki/GoogleCharts

require 'MediaWiki/GoogleCharts/GoogleCharts.php';

pear upgrade pear

pear clear-cache

pear upgrade --force mediawiki/GoogleCharts

[edit] RSS feed

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

[edit] Notes

[edit] Sandbox

You are invited in the author's sandbox to try-out some of his extensions.

[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

[edit] TODO

• Implement a parser function to simplify the Extended Encoding format

[edit] See Also

• Extension:Gchart4mw: more human readable format but lacks flexible templating capabilities