Item368: Rebranding ChartPlugin

Author: KennethLavrsen

ChartPlugin/data/TWiki/ChartPlugin.txt renamed to ChartPlugin/data/System/ChartPlugin.txt

@@ -1,12 +1,12 @@
 %META:TOPICINFO{author="ProjectContributor" date="1100674597" format="1.0" version="1.0"}%
 <!--
-    * Set SHORTDESCRIPTION = Create PNG or GIF charts to visualize TWiki tables
+    * Set SHORTDESCRIPTION = Create PNG or GIF charts to visualize Foswiki tables
 -->
 
 ---+!! Chart Plugin
 %SHORTDESCRIPTION%
 
-This plugin helps you visualize data in TWiki tables as charts,
+This plugin helps you visualize data in Foswiki tables as charts,
 using a default linear scale or an optional semilogarithmic scale.
 
 %TOC%
@@ -85,9 +85,9 @@ The =%<nop>CHART{...}%= variable gets expanded to an image representing the char
 |^| You can use a comma delimited list of values to set a specific subtype for each data set. For example ="area, area, point, line"= would say that the first two data sets are areas, the third is point and the last one is a line | |
 | =scale= | The scale to use when creating the chart.  ="linear"= or ="semilog"= | Global =SCALE= setting |
 | =name= | Name to uniquely identify the chart file that is auto-created. | None; is required for all charts |
-| =web= | The web in which to find =topic= (specified below) in which to find the TWiki tables | The current web |
-| =topic= | The topic in which to find the TWiki tables | The current topic |
-| =table= | TWiki table used to build the chart. A numerical value refers to the table number, where "1" is the first table seen in a topic. Any other non-numeric string refers to a named table defined by the =TABLE= variable with a =name= parameter. For example, table="trends" refers to the table that is preceded by =%<nop>TABLE{ name="trends" }%=. | ="1"= |
+| =web= | The web in which to find =topic= (specified below) in which to find the Foswiki tables | The current web |
+| =topic= | The topic in which to find the Foswiki tables | The current topic |
+| =table= | Foswiki table used to build the chart. A numerical value refers to the table number, where "1" is the first table seen in a topic. Any other non-numeric string refers to a named table defined by the =TABLE= variable with a =name= parameter. For example, table="trends" refers to the table that is preceded by =%<nop>TABLE{ name="trends" }%=. | ="1"= |
 | =title= | The title placed at the top of the chart | None |
 | =xlabel= | The label placed under the X axis describing the X values | None |
 | =ylabel= | The label placed to the left of the Y axis describing the Y values | None |
@@ -119,7 +119,7 @@ __Note:__ To support legacy syntax, =datatype= maps to =subtype=, =arealine= map
 
 ---++ Examples
 
-Assuming the following three TWiki tables.  The first shows the data oriented in columns while the seconds shows the data oriented in rows
+Assuming the following three Foswiki tables.  The first shows the data oriented in columns while the seconds shows the data oriented in rows
 
 <table><tr><td valign="top">
 *Table 1:*
@@ -182,7 +182,7 @@ If the required parameters are not defined, then an error message is returned or
 |  Plugin Author: | TWiki:Main.PeterThoeny, TWiki:Main.TaitCyrus |
 |  Plugin Version: | %$VERSION% |
 |  Change History: | <!-- specify latest version first -->&nbsp; |
-|   18 May 2007: | Added discontinuous ranges - TWiki:Main.CrawfordCurrie |
+|   18 May 2007: | Added discontinuous ranges - Foswiki:Main.CrawfordCurrie |
 |	16 Nov 2004: | V1.401 - Added benchmarks (no code changes) |
 |	30 Aug 2004: | V1.400 - Added support for =subtype="bar"= (includes various global bar settings), updated =gridcolor= to not only define the grid color but allowing the user to define the line style (for drawing user defined dotted lines), add a global for how wide lines are drawn instead of a hard coded value, change the order of how things are drawn so now the order is: areas, grid lines and X/Y axis labels, bars, lines/points/plines, rectangle around chart, data point labels, chart title/X/Y labels, and finally the legends. |
 |	13 May 2004: | V1.300 - Added support for =type="scatter"=; renamed =type="arealine"= to ="combo"= (arealine is undocumented); renamed =datatype= to =subtype= (datatype is undocumented); added =subtype= options ="point"= and ="pline"=, added new settings =GRIDCOLOR=, =DEFAULTDATA=, =POINTSIZE=; fixed bug with how the number of grids were drawn |
@@ -201,8 +201,6 @@ If the required parameters are not defined, then an error message is returned or
 
 __Related Topics:__ %SYSTEMWEB%.DefaultPreferences, %USERSWEB%.SitePreferences, [[%SYSTEMWEB%.Plugins][Plugins]]
 
--- TWiki:Main.TaitCyrus - 3 June 2004 <br />
--- TWiki:Main.PeterThoeny - 16 Nov 2004
 
 %META:FILEATTACHMENT{name="line1.png" attr="h" comment="" date="1093917753" path="line1.png" size="1220" user="PeterThoeny" version="1.4"}%
 %META:FILEATTACHMENT{name="line2.png" attr="h" comment="" date="1093917765" path="line2.png" size="1993" user="PeterThoeny" version="1.4"}%

ChartPlugin/data/TWiki/ChartPluginTests.txt renamed to ChartPlugin/data/System/ChartPluginTests.txt

@@ -215,8 +215,8 @@ This table is used for various legend placement tests as well as logarithmic dat
 | no parameters passed to CHART <p /> =%<nop>CHART{}%= | ChartPlugin error: parameter *name* must be specified </ p> | %CHART{}% |
 | Define =type= but =name= not specified <p /> =%<nop>CHART{type="bar"}%= | ChartPlugin error: parameter *name* must be specified </ p> | %CHART{type="bar"}% |
 | Invalid =type= of =badtype= <p /> =%<nop>CHART{type="badtype"}%= | ChartPlugin error: Invalid value of *badtype* for parameter *type* </ p> | %CHART{type="badtype"}% |
-| Missing topic page <p /> =%<nop>CHART{name="err1" topic="DoesNotExist" type="line"}%= | ChartPlugin error: Error retrieving TWiki topic %SYSTEMWEB%.DoesNotExist </ p> | %CHART{name="err1" topic="DoesNotExist" type="line"}% |
-| Missing web  <p /> =%<nop>CHART{name="err1" type="line" web="DoesNotExist"}%= | ChartPlugin error: Error retrieving TWiki topic DoesNotExist.ChartPluginTests </ p> | %CHART{name="err1" type="line" web="DoesNotExist"}% |
+| Missing topic page <p /> =%<nop>CHART{name="err1" topic="DoesNotExist" type="line"}%= | ChartPlugin error: Error retrieving Foswiki topic %SYSTEMWEB%.DoesNotExist </ p> | %CHART{name="err1" topic="DoesNotExist" type="line"}% |
+| Missing web  <p /> =%<nop>CHART{name="err1" type="line" web="DoesNotExist"}%= | ChartPlugin error: Error retrieving Foswiki topic DoesNotExist.ChartPluginTests </ p> | %CHART{name="err1" type="line" web="DoesNotExist"}% |
 | Invalid table number <p /> =%<nop>CHART{name="err1" table="999" type="line"}%= | ChartPlugin error: parameter *table* is not valid table; the specified table '999' does not exist. </ p> | %CHART{name="err1" table="999" type="line"}% |
 | No data specified <p /> =%<nop>CHART{name="err1" type="line"}%= | ChartPlugin error: parameter *data* must be specified </ p> | %CHART{name="err1" type="line"}% |
 | invalid =xaxis= value <p /> =%<nop>CHART{data="R2:C4..R7:C7" name="err1" type="line" xaxis="R2:C4..R7:C7"}%= | ChartPlugin error: parameter *xaxis* specifies multiple rows and columns. </ p> | %CHART{data="R2:C4..R7:C7" name="err1" type="line" xaxis="R2:C4..R7:C7"}% |
@@ -227,7 +227,3 @@ This table is used for various legend placement tests as well as logarithmic dat
 | Use an invalid =data= range <p /> =%<nop>CHART{data="R2:C4" name="err1"}%= | ChartPlugin error: parameter *data* value of 'R2:C4' is not valid </ p> | %CHART{data="R2:C4" name="err1"}% |
 | Use an invalid =legend= range <p /> =%<nop>CHART{data="R2:C4..R7:C7" legend="R1:C4" name="err1"}%= | ChartPlugin error: parameter *legend* contains an invalid value 'R1:C4'. </ p> | %CHART{data="R2:C4..R7:C7" legend="R1:C4" name="err1"}% |
 | =scale=semilog= and data &lt;= 0 <p /> =%<nop>CHART{data="R2:C3..R7:C7" name="err1" scale="semilog"}%= | ChartPlugin error: data (0) &lt;= 0 not valid when scale=semilog </ p> | %CHART{data="R2:C3..R7:C7" name="err1" scale="semilog"}% |
-
--- TWiki:Main.TaitCyrus - 3 June 2004 <br />
--- TWiki:Main.PeterThoeny - 14 Sept 2002
-

ChartPlugin/data/TWiki/ChartPluginTestsRemote.txt renamed to ChartPlugin/data/System/ChartPluginTestsRemote.txt

@@ -21,7 +21,3 @@ This topic just contains two tables which are referenced from the ChartPluginTes
 | *Remote:Actual Value* | 39.52 | 55.52 | 36.52 | 62.52 | 72.52 | 68.52 |
 | *Test:Averages* | %CALC{"$EVAL($SUM(xR3:C2..R7:C2)/5)"}% | %CALC{"$AVERAGE(R3:C3..R7:C3)"}%| %CALC{"$AVERAGE(R3:C4..R7:C4)"}%| %CALC{"$AVERAGE(R3:C5..R7:C5)"}%| %CALC{"$AVERAGE(R3:C6..R7:C6)"}%| %CALC{"$AVERAGE(R3:C7..R7:C7)"}%|
 | *Remote:Comment* | initial measure | | | | | |
-
--- TWiki:Main.TaitCyrus - 3 June 2004 <br />
--- TWiki:Main.PeterThoeny - 20 Jun 2002
-

ChartPlugin/lib/TWiki/Plugins/ChartPlugin.pm renamed to ChartPlugin/lib/Foswiki/Plugins/ChartPlugin.pm

@@ -2,8 +2,9 @@
 #
 # Copyright (C) 2004-2006 Peter Thoeny, [email protected]
 # Plugin written by http://TWiki.org/cgi-bin/view/Main/TaitCyrus
+# Copyright (C) 2008 Foswiki Contributors
 #
-# For licensing info read LICENSE file in the TWiki root.
+# For licensing info read LICENSE file in the Foswiki root.
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
 # as published by the Free Software Foundation; either version 2
@@ -33,7 +34,7 @@
 # In addition to having it's own getter/setters.
 
 # =========================
-package TWiki::Plugins::ChartPlugin;
+package Foswiki::Plugins::ChartPlugin;
 
 use strict;
 
@@ -60,15 +61,15 @@ sub initPlugin {
     ( my $topic, my $web, my $user, $installWeb ) = @_;
 
     # check for Plugins.pm versions
-    if( $TWiki::Plugins::VERSION < 1 ) {
-        &TWiki::Func::writeWarning( "Version mismatch between ChartPlugin and Plugins.pm" );
+    if( $Foswiki::Plugins::VERSION < 1 ) {
+        &Foswiki::Func::writeWarning( "Version mismatch between ChartPlugin and Plugins.pm" );
         return 0;
     }
 
     # Get plugin debug flag
-    $debug = &TWiki::Func::getPreferencesFlag( "CHARTPLUGIN_DEBUG" ) || 0;
+    $debug = &Foswiki::Func::getPreferencesFlag( "CHARTPLUGIN_DEBUG" ) || 0;
 
-    &TWiki::Func::writeDebug( "- TWiki::Plugins::ChartPlugin::initPlugin($web.$topic) is OK" ) if $debug;
+    &Foswiki::Func::writeDebug( "- Foswiki::Plugins::ChartPlugin::initPlugin($web.$topic) is OK" ) if $debug;
 
     # Mark that we are not fully initialized yet.  Only get the default
     # values from the plugin topic page iff a CHART is found in a topic
@@ -84,9 +85,9 @@ sub _init_defaults {
     $pluginInitialized = 1;
     require Exporter;
     foreach my $module qw( GD POSIX
-                           TWiki::Plugins::ChartPlugin::Chart
-                           TWiki::Plugins::ChartPlugin::Parameters
-                           TWiki::Plugins::ChartPlugin::Table) {
+                           Foswiki::Plugins::ChartPlugin::Chart
+                           Foswiki::Plugins::ChartPlugin::Parameters
+                           Foswiki::Plugins::ChartPlugin::Table) {
         eval "require $module";
         if ($@) {
             $initError = "Required Perl module '$module' not found: $@";
@@ -95,36 +96,36 @@ sub _init_defaults {
     }
 
     # Get default chart type
-    $defaultType = TWiki::Func::getPreferencesValue( "CHARTPLUGIN_TYPE" ) || 'line';
+    $defaultType = Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_TYPE" ) || 'line';
     # Get default chart values
-    $defaultWidth = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_WIDTH" ) || 60;
-    $defaultHeight = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_HEIGHT" ) || 16;
-    my $defaultAreaColors = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_AREA_COLORS" )
+    $defaultWidth = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_WIDTH" ) || 60;
+    $defaultHeight = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_HEIGHT" ) || 16;
+    my $defaultAreaColors = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_AREA_COLORS" )
       || "#FF0000 #FFFF00 #00FF00";
     @defaultAreaColors = split(/[\s,]+/, $defaultAreaColors);
-    my $defaultLineColors = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_LINE_COLORS" )
+    my $defaultLineColors = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_LINE_COLORS" )
       || "#FFFF00 #FF00FF #00FFFF";
     @defaultLineColors = split(/[\s,]+/, $defaultLineColors);
     # Get default chart bgcolor
-    $defaultBGcolor = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_BGCOLOR" ) || '#FFFFFF #FFFFFF';
+    $defaultBGcolor = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_BGCOLOR" ) || '#FFFFFF #FFFFFF';
     # Get default number of Y axis grids
-    $defaultNumYGrids = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_NUMYGRIDS" ) || 10;
+    $defaultNumYGrids = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_NUMYGRIDS" ) || 10;
     # Get default value to use if there is no data seen in the table
-    $defaultDataValue = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_DEFAULTDATA" );
+    $defaultDataValue = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_DEFAULTDATA" );
     # Get default value for the scale (linear/semilog)
-    $defaultScale = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_SCALE" );
+    $defaultScale = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_SCALE" );
     # Get default grid color.
-    $defaultGridColor = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_GRIDCOLOR" ) || '#000000';
+    $defaultGridColor = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_GRIDCOLOR" ) || '#000000';
     # Get default value for the size, in pixels, of drawn data points
-    $defaultPointSize = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_POINTSIZE" ) || 2;
+    $defaultPointSize = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_POINTSIZE" ) || 2;
     # Get default value for the width, in pixels, of drawn lines
-    $defaultLineWidth = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_LINEWIDTH" ) || 3;
+    $defaultLineWidth = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_LINEWIDTH" ) || 3;
     # Get default value for the leading space before the first bar.
-    $defaultBarLeadingSpace = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_BARLEADINGSPACE" ) || 0;
+    $defaultBarLeadingSpace = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_BARLEADINGSPACE" ) || 0;
     # Get default value for the trailing space after the last bar.
-    $defaultBarTrailingSpace = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_BARTRAILINGSPACE" ) || 0;
+    $defaultBarTrailingSpace = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_BARTRAILINGSPACE" ) || 0;
     # Get default value for the space between bars.
-    $defaultBarSpace = &TWiki::Func::getPreferencesValue( "CHARTPLUGIN_BARSPACE" ) || 0;
+    $defaultBarSpace = &Foswiki::Func::getPreferencesValue( "CHARTPLUGIN_BARSPACE" ) || 0;
 }
 
 # Object constructor for creating a ChartPlugin Perl object.  The object is
@@ -147,7 +148,7 @@ sub _tables { my ($this) = @_; return $this->{TABLES}; }
 # Setter for storing the Parameters object
 sub _setParameters {
     my ($this, $args) = @_;
-    $this->{PARAMETERS} = TWiki::Plugins::ChartPlugin::Parameters->new($args);
+    $this->{PARAMETERS} = Foswiki::Plugins::ChartPlugin::Parameters->new($args);
 }
 
 # Getter for Parameters object
@@ -171,15 +172,15 @@ sub _setTopicContents {
         $topicContents = $this->{CURRENT_TOPICONTENTS};
     } else {
         # A difference, so read in the topic.
-        (my $meta, $topicContents) = TWiki::Func::readTopic( $inWeb, $inTopic );
+        (my $meta, $topicContents) = Foswiki::Func::readTopic( $inWeb, $inTopic );
         # Check to make sure the web.topic actually exists.  If not, return
         # undef so the caller can catch the error.
         return undef if ($topicContents eq "");
-        $topicContents = TWiki::Func::expandCommonVariables($topicContents, $inTopic, $inWeb);
+        $topicContents = Foswiki::Func::expandCommonVariables($topicContents, $inTopic, $inWeb);
     }
 
     # Lets parse the specified topic contents looking for tables.
-    $this->_setTables(TWiki::Plugins::ChartPlugin::Table->new($topicContents));
+    $this->_setTables(Foswiki::Plugins::ChartPlugin::Table->new($topicContents));
     return 1;
 }
 
@@ -213,7 +214,7 @@ sub _make_filename {
 
     # before save, create directories if they don't exist.
     # If the top level "pub/$web" directory doesn't exist, create it.
-    my $dir = TWiki::Func::getPubDir() . "/$web";
+    my $dir = Foswiki::Func::getPubDir() . "/$web";
     if( ! -e "$dir" ) {
         umask( 002 );
         mkdir( $dir, 0775 );
@@ -252,7 +253,7 @@ sub _makeChart {
     $this->_setParameters ($args);
 
     # Make a chart object in which we will place user specified parameters
-    my $chart = TWiki::Plugins::ChartPlugin::Chart->new();
+    my $chart = Foswiki::Plugins::ChartPlugin::Chart->new();
 
     # See if the parameter 'type' is available.  This is a required
     # parameter.  If it is missing, then generate an error message.
@@ -326,7 +327,7 @@ sub _makeChart {
     # Before we parse any further parameters, lets get the contents of the
     # specified web/topic.
     if (! $this->_setTopicContents($inWeb, $inTopic)) {
-        return _make_error("Error retrieving TWiki topic $inWeb<nop>.$inTopic");
+        return _make_error("Error retrieving Foswiki topic $inWeb<nop>.$inTopic");
     }
 
     # Determine which table the user wants to chart
@@ -448,7 +449,7 @@ sub _makeChart {
     if ($legend) {
         my $cnt = my @d = $this->_tables->getData($tableName, $legend);
         if ($cnt > 1) {
-            @d = TWiki::Plugins::ChartPlugin::Table::transpose( @d );
+            @d = Foswiki::Plugins::ChartPlugin::Table::transpose( @d );
             $cnt = scalar(@d);
         }
         if ($cnt > 1) {

ChartPlugin/lib/TWiki/Plugins/ChartPlugin/Chart.pm renamed to ChartPlugin/lib/Foswiki/Plugins/ChartPlugin/Chart.pm

@@ -2,8 +2,9 @@
 #
 # Copyright (C) 2004-2006 Peter Thoeny, [email protected]
 # Plugin written by http://TWiki.org/cgi-bin/view/Main/TaitCyrus
+# Copyright (C) 2008 Foswiki Contributors
 #
-# For licensing info read LICENSE file in the TWiki root.
+# For licensing info read LICENSE file in the Foswiki root.
 # This program is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License
 # as published by the Free Software Foundation; either version 2
@@ -164,7 +165,7 @@
 #    			- Get the space between bar graphs
 
 # =========================
-package TWiki::Plugins::ChartPlugin::Chart;
+package Foswiki::Plugins::ChartPlugin::Chart;
 
 use Exporter;
 use GD;

ChartPlugin/lib/TWiki/Plugins/ChartPlugin/DEPENDENCIES renamed to ChartPlugin/lib/Foswiki/Plugins/ChartPlugin/DEPENDENCIES

@@ -0,0 +1,22 @@
+data/System/ChartPlugin.txt NEW
+data/System/ChartPluginTests.txt NEW
+data/System/ChartPluginTestsRemote.txt NEW
+lib/Foswiki/Plugins/ChartPlugin.pm NEW
+lib/Foswiki/Plugins/ChartPlugin/Chart.pm NEW
+lib/Foswiki/Plugins/ChartPlugin/Parameters.pm NEW
+lib/Foswiki/Plugins/ChartPlugin/Table.pm NEW
+pub/System/ChartPlugin/area1.png NEW
+pub/System/ChartPlugin/area3.png  NEW
+pub/System/ChartPlugin/areaexample.png  NEW
+pub/System/ChartPlugin/arealine4.png  NEW
+pub/System/ChartPlugin/arealineexample.png  NEW
+pub/System/ChartPlugin/bar1.png NEW
+pub/System/ChartPlugin/barexample.png NEW
+pub/System/ChartPlugin/combo1.png NEW
+pub/System/ChartPlugin/combo2.png NEW
+pub/System/ChartPlugin/comboexample.png NEW
+pub/System/ChartPlugin/line1.png  NEW
+pub/System/ChartPlugin/line2.png  NEW
+pub/System/ChartPlugin/lineexample.png  NEW
+pub/System/ChartPlugin/scatter1.png NEW
+pub/System/ChartPlugin/scatterexample.png NEW