17 Feb 2022 00:05:40 UTC
- Distribution: Text-Table-Org
- Module version: 0.031
- Source (raw)
- Browse (raw)
- How to Contribute
- Testers (861 / 0 / 0)
- KwaliteeBus factor: 1
- % Coverage
- License: perl_5
- Activity24 month
- Download (16.68KB)
- MetaCPAN Explorer
- Subscribe to distribution
- This version
- Latest versionPERLANCAR perlancar
- SEE ALSO
- COPYRIGHT AND LICENSE
Text::Table::Org - Generate Org tables
This document describes version 0.031 of Text::Table::Org (from Perl distribution Text-Table-Org), released on 2022-01-23.
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.
The example shown in the SYNOPSIS generates the following table:
| Name | Rank | Serial | |-------+----------+----------| | alice | pvt | 123456 | | bob | cpl | 98765321 | | carol | brig gen | 8745 |
tablefunction understands these arguments, which are passed as a hash.
Takes an array reference which should contain one or more rows of data, where each row is an array reference.
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.
If set to true, will add separator line between data rows.
Optional. String. If set, will add this line to the beginning of output (
table captionwill be the actual caption string that you provide):
#+CAPTION: table caption
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.
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
See also Bencher::Scenario::TextTableModules.
To contribute, you can send patches by email/via RT, or send pull requests on GitHub.
Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via:
% prove -l
If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla plugin and/or Pod::Weaver::Plugin. Any additional steps required beyond that are considered a bug and can be reported to me.
This software is copyright (c) 2022, 2015 by perlancar <email@example.com>.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
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.
Module Install Instructions
To install Text::Table::Org, copy and paste the appropriate command in to your terminal.
perl -MCPAN -e shell install Text::Table::Org
For more information on module installation, please visit the detailed CPAN module installation guide.