====== table2csv Plugin ======

---- plugin ----
description: Exports a table to a csv file
author     : tom_c 
email      : tcafferty@glocalfocal.com 
type       : action
lastupdate : 2013-09-05
compatible : Angua, Adora Belle, Binky
depends    : Tools
conflicts  : 
similar    : 
tags       : csv,export,tables

downloadurl: https://github.com/TomCafferty/plugin-table2csv/zipball/master
bugtracker : https://github.com/TomCafferty/plugin-table2csv/issues
sourcerepo : https://github.com/TomCafferty/plugin-table2csv
donationurl: 
----

The table2csv plugin provides the ability to export a table on a dokuwiki page to a csv file. 

===== Installation =====

:!: **External requirements:** This plugin requires the following additional components that must be installed separately: 
  * [[plugin:tools|Tools plugin]]

Install the table2csv plugin using the Plugin Manager and the download URL above. If you install this plugin manually, make sure it is installed in lib/plugins/table2csv/

===== Examples/Usage =====

  Gas Spending
  ^ Date     ^ Cost  ^ Gallons  ^
  | 1/1/12   | 3.55  | 5        |
  | 1/12/12  | 3.49  | 10       |
  
  ~~TOOLS:both~~
  <table2csv>&startMarker=Gas Spending&</table2csv>

The file page should display the plugin Tools selection to Export To csv in the top and bottom right corners of the page. Select this to export the table into a csv file. The filename and path defaults to ''table.csv'' in the dokuwiki base install folder. The example can be seen at [[http://clean.glocalfocal.com/doku.php?id=start|Plugin Examples Site]] FIXME

===== Syntax =====

  <table2csv>&startMarker=any text&</table2csv>     

The startMarker is used to identify where to start looking from to grab the next table. The text //any text// would be replaced by your page text that is located before the table to export. Make sure the text used is not part of the table definition such as a heading or caption. No quotes are used unless they are in your start marker.

Add the following to a page to display the export to csv button in the top and bottom right corners
  ~~TOOLS:both~~

===== Configuration and Settings =====

Edit the file ''/conf/default.php'' to specify the file name and path. The path is relative to the base of the dokuwiki install folder.

=== Change Log ===

{{rss>https://github.com/TomCafferty/plugin-table2csv/commits/master.atom date}}

=== Known Bugs and Issues ===

https://github.com/TomCafferty/plugin-table2csv/issues

=== ToDo/Wish List ===

  * Export file as a download file where the user specifies a local path
     * Yes this would make the plugin much more convenient and useful indeed :)
     * Or maybe allow the output to be emailed to some default email address (i.g. admin email address).
  * It would be nice if the plugin didn't NEED to have the tools plugin installed. Having it would be a option but the plugin would also be able to generate its own button in the floating menu, for instance. The position of the button (via this plugin or via the "tools" plugin) would be configurable in the admin settings.
===== Discussion =====

https://github.com/TomCafferty/plugin-table2csv/wiki