%META:TOPICINFO{author="TWikiContributor" date="1295255149" format="1.1" version="$Rev$"}%
---+!! <nop>%TOPIC%
<!--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/FluidPivotsPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/FluidPivotsPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->
<sticky><div style="float:right; background-color:#EBEEF0; margin:0 0 20px 20px; padding: 0 10px 0 10px;">
%TOC{title="Page contents"}%
</div></sticky>
%SHORTDESCRIPTION%

---++ Introduction

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 =%<nop>FLUIDPIVOTS{...}%= variable gets expanded to a table.
   | *%<nop>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"=|

---++ Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>FORMPIVOTSPLUGIN_SHORTDESCRIPTION%==

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

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

---++ 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. 

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully
automatic installer script written using the Build<nop>Contrib.
   * If you have TWiki 4.2 or later, you can install from the =configure= interface (Go to Plugins->Find More Extensions)
      * See the [[http://twiki.org/cgi-bin/view/Plugins/BuildContribInstallationSupplement][installation supplement]] on TWiki.org for more information.
   * If you have any problems, then you can still install manually from the command-line:
      1 Download one of the =.zip= or =.tgz= archives
      1 Unpack the archive in the root directory of your TWiki installation.
      1 Run the installer script ( =perl &lt;module&gt;_installer= )
      1 Run =configure= and enable the module, if it is a plugin.
      1 Repeat for any missing dependencies.
   * If you are *still* having problems, then instead of running the installer script:
      1 Make sure that the file permissions allow the webserver user to access all files.
      1 Check in any installed files that have existing =,v= files in your existing install (take care *not* to lock the files when you check in)
      1 Manually edit !LocalSite.cfg to set any configuration variables.

%IF{"defined 'SYSTEMWEB'" else="<div class='twikiAlert'>%X% WARNING: SYSTEMWEB is not defined in this TWiki. Please add these definitions to your %MAINWEB%.TWikiPreferences, if they are not already there:<br><pre>   * <nop>Set SYSTEMWEB = %<nop>TWIKIWEB%<br>   * <nop>Set USERSWEB = %<nop>MAINWEB%</pre></div>"}%


   * To correctly integrate this plugin with tables and charts, you need to change the order of plugins. In configure, change the order like this: =SpreadSheetPlugin,FluidPivotsPlugin,ChartPlugin=.

   * Test if the installation was successful:
      * Check the FluidPivotsPluginTestCases, you should see the tables instead of variables.

---++ Plugin Info

|  Plugin Author: | TWiki:Main.MariaDelCarmenHuertas |
|  Copyright: | &copy; 2007, [[http://www.fluidsignal.com][Fluidsignal Group S.A.]] <br /> &copy; 2007-2011 TWiki:TWiki.TWikiContributor |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Version: | 2011-01-17 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  2011-01-17: | TWikibug:Item6636: Fixing plugin for TWiki-5.0; fixing warnings; doc improvements; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny |
|  10 Apr 2008: | Fixed reference to Table.pm and Parameters.pm |
|  16 Oct 2007: | Initial version |
|  TWiki Dependency: | $TWiki::Plugins::VERSION 1.1 |
|  CPAN Dependencies: | libstring-crc32-perl library (CPAN:String::CRC32) and CPAN:Math::Round |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 |
|  [[TWiki:Plugins/Benchmark][Benchmarks]]: | %SYSTEMWEB%.GoodStyle nn%, %SYSTEMWEB%.FormattedSearch nn%, %TOPIC% nn% |
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |

__Related Topics:__ FluidPivotsPluginExtern, FluidPivotsPluginTestCasesOff, FluidPivotsPluginTestCases,  %SYSTEMWEB%.TWikiPlugins, %SYSTEMWEB%.DeveloperDocumentationCategory, %SYSTEMWEB%.AdminDocumentationCategory, %SYSTEMWEB%.TWikiPreferences
