.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Text::MarkdownTable 3pm"
.TH Text::MarkdownTable 3pm "2023-02-05" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Text::MarkdownTable \- Write Markdown syntax tables from data
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&  my $table = Text::MarkdownTable\->new;
\&  $table\->add({one=>"a",two=>"table"});
\&  $table\->add({one=>"is",two=>"nice"});
\&  $table\->done;
\&
\&  | one | two   |
\&  |\-\-\-\-\-|\-\-\-\-\-\-\-|
\&  | a   | table |
\&  | is  | nice  |
\&
\&  Text::MarkdownTable\->new( columns => [\*(AqX\*(Aq,\*(AqY\*(Aq,\*(AqZ\*(Aq], edges => 0 )
\&    \->add({a=>1,b=>2,c=>3})\->done;
\&
\&  X | Y | Z
\&  \-\-|\-\-\-|\-\-
\&  1 | 2 | 3
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module can be used to write data in tabular form, formatted in
MultiMarkdown syntax. The resulting format can be used for instance to display
\&\s-1CSV\s0 data or to include data tables in Markdown files. Newlines and vertical
bars in table cells are replaced by a space character and cell values can be
truncated.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
.IP "file" 4
.IX Item "file"
Filename, \s-1GLOB,\s0 scalar reference or IO::Handle to write to (default \s-1STDOUT\s0).
.IP "fields" 4
.IX Item "fields"
Array, hash reference, or comma-separated list of fields/columns.
.IP "columns" 4
.IX Item "columns"
Column names. By default field names are used.
.IP "widths" 4
.IX Item "widths"
Column widths. By default column widths are calculated automatically to the
width of the widest value. With given widths, the table is directly be written
without buffering and large table cell values are truncated.
.IP "header" 4
.IX Item "header"
Include header lines. Enabled by default.
.IP "edges" 4
.IX Item "edges"
Include border before first column and after last column. Enabled by default.
Note that single-column tables don't not look like tables if edges are
disabled.
.IP "condense" 4
.IX Item "condense"
Write table unbuffered in condense format:
.Sp
.Vb 4
\&  one|two
\&  \-\-\-|\-\-\-
\&  a|table
\&  is|nice
.Ve
.Sp
Note that single-column tables are don't look like tables on condense format.
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "add( $row )" 4
.el .IP "add( \f(CW$row\fR )" 4
.IX Item "add( $row )"
Add a row as hash reference. Returns the table instance.
.IP "streaming" 4
.IX Item "streaming"
Returns whether rows are directly written or buffered until \f(CW\*(C`done\*(C'\fR is called.
.IP "done" 4
.IX Item "done"
Finish and write the table unless it has already been written in \f(CW\*(C`streaming\*(C'\fR
mode.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
See Catmandu::Exporter::Table for an application of this module that can be
used to easily convert data to Markdown tables.
.PP
Similar table-generating modules include:
.IP "Text::Table::Tiny" 4
.IX Item "Text::Table::Tiny"
.PD 0
.IP "Text::TabularDisplay" 4
.IX Item "Text::TabularDisplay"
.IP "Text::SimpleTable" 4
.IX Item "Text::SimpleTable"
.IP "Text::Table" 4
.IX Item "Text::Table"
.IP "Text::ANSITable" 4
.IX Item "Text::ANSITable"
.IP "Text::ASCIITable" 4
.IX Item "Text::ASCIITable"
.IP "Text::UnicodeBox::Table" 4
.IX Item "Text::UnicodeBox::Table"
.IP "Table::Simple" 4
.IX Item "Table::Simple"
.IP "Text::SimpleTable" 4
.IX Item "Text::SimpleTable"
.IP "Text::SimpleTable::AutoWidth" 4
.IX Item "Text::SimpleTable::AutoWidth"
.PD
.SH "AUTHOR"
.IX Header "AUTHOR"
Jakob Vo\*8 <jakob.voss@gbv.de>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2014\- Jakob Vo\*8
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.