r50414 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r50413‎ | r50414 | r50415 >
Date:04:09, 10 May 2009
Author:laner
Status:deferred
Tags:
Comment:
Adding a readme.
Modified paths:
  • /trunk/extensions/Plotter/README (added) (history)

Diff [purge]

Index: trunk/extensions/Plotter/README
@@ -0,0 +1,24 @@
 2+This extension allows users to create client side graphs (like pie, bar, etc) from data using javascript. The javascript is created by sysops in the MediaWiki namespace. Adding new scripts works like the Gadgets extension (as this extension borrows heavily from Gadgets).
 3+
 4+Preprocessing scripts, and plotting scripts are available, and the javascript function for each should be defined as follows:
 5+
 6+/* For preprocessing scripts */
 7+function plotter_<functionname>_process( $data, $arg1, $arg2, ... ) {
 8+ ...
 9+}
 10+
 11+/* For plotting scripts */
 12+function plotter_<functionname>_draw( $data, $arg1, $arg2, ... ) {
 13+ ...
 14+}
 15+
 16+You can use these in a parser function like so:
 17+
 18+{{#plot:
 19+|script=<functionname>
 20+|data=1,2
 21+3,4}}
 22+
 23+Currently, only PlotKit is supported; but other javascript plotting libraries will be supported in the future.
 24+
 25+This code is very alpha quality right now; many features may not work.

Status & tagging log