.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "Markdent::Role::BlockParser 3pm"
.TH Markdent::Role::BlockParser 3pm 2024-03-06 "perl v5.38.2" "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
Markdent::Role::BlockParser \- A role for block parsers
.SH VERSION
.IX Header "VERSION"
version 0.40
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This role implements behavior shared by all block parsers.
.SH "REQUIRED METHODS"
.IX Header "REQUIRED METHODS"
.IP \(bu 4
\&\f(CW$parse\fR\->parse_document(\e$text)
.Sp
This method takes a scalar reference to a markdown document and parses it for
block-level markup.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
This roles provides the following attributes:
.SS _span_parser
.IX Subsection "_span_parser"
This is a read-only attribute. It is an object which does the
Markdent::Role::SpanParser role.
.PP
This is required for all block parsers.
.SH ROLES
.IX Header "ROLES"
This role does the Markdent::Role::AnyParser and
Markdent::Role::DebugPrinter roles.
.SH BUGS
.IX Header "BUGS"
See Markdent for bug reporting details.
.PP
Bugs may be submitted at <https://github.com/houseabsolute/Markdent/issues>.
.PP
I am also usually active on IRC as 'autarch' on \f(CW\*(C`irc://irc.perl.org\*(C'\fR.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for Markdent can be found at <https://github.com/houseabsolute/Markdent>.
.SH AUTHOR
.IX Header "AUTHOR"
Dave Rolsky <autarch@urth.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2021 by Dave Rolsky.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.PP
The full text of the license can be found in the
\&\fILICENSE\fR file included with this distribution.