FluidPivotsPlugin (v.1.8)

This plugin create a table (pivot, datapilot) that show information in a usefully way. It will generate a new table from an origin table with the correlate data of two of his columns. It's work similar to DataPilot? on OpenCalc?

Syntax Rules

• The %FLUIDPIVOTS{...}% variable gets expanded to a table.

  %FLUIDPIVOTS% Parameter	Comment	Default
  name	The name of the new table created.	"pivot"
  table	Name of the source table.	None; is required for all the tables
  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
  rows	Name of the column in the source table that it will represents the rows of the new table	None; is required for all the tables
  columns	Name of the column in the source table that it will represents the columns of the new table	None; is required for all the tables
  data	Name of the column in the source table that it will represents the data of the new table	None; is required for all the tables
  operation	Define the operation to process the data. (count,sum,average,max,min,var,dev)	"count"
  visible	Define what portion of the table should be visible.(data,col,row,all)	"all"
  maxcol	Define the maximum number of columns, grouping the less significant data in an unique column.	"0"
  maxrow	Define the maximum number of rows, grouping the less significant data in an unique row.	"0"
  order	Set how will be ordered the data (max,min,off)	"max"
  cachetime	Set the time in seconds that it will reside the cache.	"0"
  ignorecache	Set a maximum time to cache, after this time the table is regenerated even if data is unchanged.	"1209600"

Test Cases

• Test cases used with FluidPivotsPlugin in action.
• Test cases used without FluidPivotsPlugin in action.
• With a coverage process we create this reports (you should note that this is my particular environment):
  • Initial run.
  • Second run. (This second report is to show the cache code working.)

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %NEWPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Create pivot and datapilot tables from TWiki tables

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG = 0

• To correctly integrate this plugin with tables and charts, you need to change the order of plugins, in configure page, change the order like this SpreadSheetPlugin,FluidPivotsPlugin,ChartPlugin.

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the TWiki server.

• Download the ZIP file from the Plugin Home (see below)
• Unzip FluidPivotsPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/FluidPivotsPlugin.txt	Plugin topic
  data/TWiki/FluidPivotsPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/FluidPivotsPlugin.pm	Plugin Perl module

• Configure the Plugin:
  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed
• Test if the installation was successful:
  • Check the test cases, you should see the tables instead of variables.

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences