Extension: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 and version matrix; stats | |
Contents |
Purpose[edit]
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]
gchart parser function[edit]
- {{#gcharts: param1¶m2&...[|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]
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]
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]
{{#gcharts:cht=p3&chd=s:hW&chs=250x100&chl={{#gcharts_pipe:Hello,World}}}}
Documentation[edit]
The official source of information for GoogleCharts can be found here.
Dependencies[edit]
Installation[edit]
See the Mediawiki Extension table entry "download" above.[1]
LocalSettings.php[edit]
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" );
- Since this Extensions is depending on StubManager, add the line after the StubManager include, or else your Wiki won't work.
PEAR[edit]PEAR is a repository of PHP software code.
require 'MediaWiki/GoogleCharts/GoogleCharts.php';
Upgrades through PEAR[edit]Sometimes, it is necessary to clear PEAR's cache in order to perform upgrades.
or use the force method:
PEAR Web Frontend[edit]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]
To keep up-to-date with this channel, use the following RSS feed__
.
Notes[edit]
Other Extensions From the same author[edit]
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]
| Release | Notes |
|---|---|
| 1.0.0 | Initial public release |
TODO[edit]
- Implement a parser function to simplify the Extended Encoding format
See Also[edit]
- Extension:Gchart4mw: more human readable format but lacks flexible templating capabilities
- Extension:Google Chart: more simple
