Text::Table::Org - Generate Org tables
This document describes version 0.02 of Text::Table::Org (from Perl distribution Text-Table-Org), released on 2015-12-17.
use Text::Table::Org; my $rows = [ # header row ['Name', 'Rank', 'Serial'], # rows ['alice', 'pvt', '123456'], ['bob', 'cpl', '98765321'], ['carol', 'brig gen', '8745'], ]; print Text::Table::Org::table(rows => $rows, header_row => 1);
This module provides a single function, table, which formats a two-dimensional array of data as an Org text table.
table
The example shown in the SYNOPSIS generates the following table:
| Name | Rank | Serial | |-------+----------+----------| | alice | pvt | 123456 | | bob | cpl | 98765321 | | carol | brig gen | 8745 |
The table function understands these arguments, which are passed as a hash.
rows (aoaos)
Takes an array reference which should contain one or more rows of data, where each row is an array reference.
header_row (bool)
If given a true value, the first row in the data will be interpreted as a header row, and separated from the rest of the table with a ruled line.
This module is currently basically Text::Table::Tiny 0.03 modified to output Org tables instead of its original variant table format.
The output of this module is very similar to that of Text::MarkdownTable. In fact, Org recognizes its output as a valid Org table (the only difference is that corner marker is | instead of the Org standard of +).
|
+
Some other text table modules: Text::ANSITable, Text::ASCIITable, Text::FormatTable, Text::Table, Text::TabularDisplay.
See also Bencher::Scenario::TextTableModules.
Please visit the project's homepage at https://metacpan.org/release/Text-Table-Org.
Source repository is at https://github.com/perlancar/perl-Text-Table-Org.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Text-Table-Org
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Text::Table::Org, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Text::Table::Org
CPAN shell
perl -MCPAN -e shell install Text::Table::Org
For more information on module installation, please visit the detailed CPAN module installation guide.