.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
.\" ========================================================================
.\"
.IX Title "Text::MediawikiFormat::Blocks 3pm"
.TH Text::MediawikiFormat::Blocks 3pm "2022-06-28" "perl v5.34.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::MediawikiFormat::Blocks \- blocktypes for Text::MediawikiFormat
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
None.  Use Text::MediawikiFormat as the public interface, unless you want to
create your own block type.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module merely creates subclasses of Text::MediawikiFormat::Block, which is
the interesting code.  A block is a collection of related lines, such as a code
block (text to display verbatim in a monospaced font), a header, an unordered
list, an ordered list, and a paragraph (text to display in a proportional
font).
.PP
Every block extends \f(CW\*(C`Text::MediawikiFormat::Block\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
The following methods exist:
.IP "\(bu" 4
\&\f(CW\*(C`new( %args )\*(C'\fR
.Sp
Creates and returns a new block.  The valid arguments are:
.RS 4
.IP "\(bu" 4
\&\f(CW\*(C`text\*(C'\fR
.Sp
The text of the line found in the block.
.IP "\(bu" 4
\&\f(CW\*(C`args\*(C'\fR
.Sp
The arguments captured by the block-identifying regular expression.
.IP "\(bu" 4
\&\f(CW\*(C`level\*(C'\fR
.Sp
The level of indentation for the block (usually only useful for list blocks).
.IP "\(bu" 4
\&\f(CW\*(C`tags\*(C'\fR
.Sp
The tags in effect for the current type of wiki formatting.
.IP "\(bu" 4
\&\f(CW\*(C`opts\*(C'\fR
.Sp
The options in effect for the current type of wiki formatting.
.RE
.RS 4
.Sp
Use the accessors of the same names to retrieve the values of the attributes.
.RE
.IP "\(bu" 4
\&\f(CW\*(C`add_text( @lines_of_text )\*(C'\fR
.Sp
Adds a list of lines of text to the current text for the block.  This is very
useful when you encounter a block and want to merge it with the previous block
of the same type
.IP "\(bu" 4
\&\f(CW\*(C`add_args( @arguments )\*(C'\fR
.Sp
Adds further arguments to the block; useful when merging blocks.
.IP "\(bu" 4
\&\f(CW\*(C`formatted_text()\*(C'\fR
.Sp
Returns text formatted appropriately for this block.  Blocks don't have to have
formatters, but they may.
.IP "\(bu" 4
\&\f(CW\*(C`formatter( $line_of_text )\*(C'\fR
.Sp
Formats the \f(CW$line\fR using \f(CW\*(C`Text::MediawikiFormat::format_line()\*(C'\fR.  You can add
your own formatter here; this is worth overriding.
.IP "\(bu" 4
\&\f(CW\*(C`merge( $next_block )\*(C'\fR
.Sp
Merges the current block with \f(CW$next_block\fR (the next block encountered) if
they're of the same type and are at the same level.  This adds the text and
args of \f(CW$next_block\fR to the current block.  It's your responsibility to
remove \f(CW$next_block\fR from whatever your code iterates over.
.IP "\(bu" 4
\&\f(CW\*(C`nests()\*(C'\fR
.Sp
Returns true if this block should nest (as in lists and unordered lists) for
the active wiki formatting.
.IP "\(bu" 4
\&\f(CW\*(C`nest( $next_block )\*(C'\fR
.Sp
Nests \f(CW$next_block\fR under this block if the both nest and if \f(CW$next_block\fR
has a level greater than the current block.  This actually adds \f(CW$next_block\fR
as a text item within the current block.  Beware.
.SH "AUTHOR"
.IX Header "AUTHOR"
chromatic, \f(CW\*(C`chromatic at wgz dot org\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
No known bugs.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2006, chromatic.  Some rights reserved.
.PP
This module is free software; you can use, redistribute, and modify it under
the same terms as Perl 5.8.x.