diff options
Diffstat (limited to 'doc/plugins')
-rw-r--r-- | doc/plugins/contrib/table.mdwn | 61 | ||||
-rw-r--r-- | doc/plugins/table.mdwn | 35 | ||||
-rw-r--r-- | doc/plugins/table/discussion.mdwn (renamed from doc/plugins/contrib/table/discussion.mdwn) | 0 |
3 files changed, 35 insertions, 61 deletions
diff --git a/doc/plugins/contrib/table.mdwn b/doc/plugins/contrib/table.mdwn deleted file mode 100644 index 46f7b09a7..000000000 --- a/doc/plugins/contrib/table.mdwn +++ /dev/null @@ -1,61 +0,0 @@ -[[template id=plugin name=table author="[[VictorMoral]]"]] -[[tag type/format]] - -This plugin supplies a `table` [[PreprocessorDirective]] to build html tables from data in CSV (comma-separated values) or DSV (delimiter-separated values) format. - -It needs the perl module [[cpan Text::CSV]] for the CSV data. - -## Usage - -In any source page include the following: - - The next table shows the results: - - \[[table class="myclass" format=dsv data=""" - Custom|Amount| - Fulanito|134,34| - Menganito|234,56| - """]] - - This is my last acquisition: - - [[table class="book_record" format=csv file="data/books/record1"]] - - And the record1 page should be similar to: - - "Title","Perl Best Practices" - "Author","Damian Conway" - "Publisher","O’Reilly" - -The parameters are: - -- _data_: Values for the table -- _file_: Wiki page containing the data. -- _format_ (optional): format name of the data. By default is `auto` and the options are `csv` or `dsv`. -- _delimiter_ (optional): The character used to separate fields. By default, DSV format uses a pipe (`|`), and CSV uses a comma (`,`). -- _class_ (optional): CSS class for the table html element -- _caption_ (optional): Text string for the table caption. -- _no\_header_: This switch disables the generation of table header (`<th>`) elements. By default, the `table` directive uses the first data line as column headers. - -The _data_ and _file_ parameters are mutually exclusive. - -Note: the automatic format detection mechanism is still very rudimentary. - -## Changelog - -### version 0.5 - -* Remove a call to an inexistent [[cpan Text::CSV]] method. -* Added the sep_char parameter. -* Parse CSV data in binary mode. -* Added a format detection mechanism. -* Default format now is 'auto'. - -## Links - -- Information about the formats in Wikipedia: - - [[wikipedia CSV]] - - [[wikipedia DSV]] - -- Download the tar file from <http://taquiones.net/files/misc/> -- Debian package in <http://taquiones.net/files/debian/> diff --git a/doc/plugins/table.mdwn b/doc/plugins/table.mdwn new file mode 100644 index 000000000..88b509004 --- /dev/null +++ b/doc/plugins/table.mdwn @@ -0,0 +1,35 @@ +[[template id=plugin name=table author="[[VictorMoral]]"]] +[[tag type/format]] + +This plugin can build html tables from data in CSV (comma-separated values) +or DSV (delimiter-separated values) format. + +It needs the perl module [[cpan Text::CSV]] for the CSV data. + +## examples + + \[[table data=""" + Customer|Amount| + Fulanito|134,34| + Menganito|234,56| + """]] + + \[[table class="book_record" format=csv file="data/books/record1"]] + +In this second example the `record1` page should be similar to: + + "Title","Perl Best Practices" + "Author","Damian Conway" + "Publisher","O’Reilly" + +## usage + +* `data` - Values for the table. +* `file` - A file in the wiki containing the data. +* `format` - The format of the data, either "csv", "dsv", or "auto" + (the default). +* `delimiter` - The character used to separate fields. By default, + DSV format uses a pipe (`|`), and CSV uses a comma (`,`). +* `class` - A CSS class for the table html element. +* `header` - Set to 0 to make a table without a header. By default, + the first data line is used as the table header. diff --git a/doc/plugins/contrib/table/discussion.mdwn b/doc/plugins/table/discussion.mdwn index f0ebb6d94..f0ebb6d94 100644 --- a/doc/plugins/contrib/table/discussion.mdwn +++ b/doc/plugins/table/discussion.mdwn |