.\" -*- 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::Handler::HTMLStream::Document 3pm"
.TH Markdent::Handler::HTMLStream::Document 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::Handler::HTMLStream::Document \- Turns Markdent events into a complete HTML document
.SH VERSION
.IX Header "VERSION"
version 0.40
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class takes an event stream and turns it into a complete HTML document.
.SH METHODS
.IX Header "METHODS"
This role provides the following methods:
.SS Markdent::Handler::HTMLStream::Document\->new(...)
.IX Subsection "Markdent::Handler::HTMLStream::Document->new(...)"
This method creates a new handler. It accepts the following parameters:
.IP \(bu 4
title => \f(CW$title\fR
.Sp
The title of the document. This is required.
.IP \(bu 4
charset => \f(CW$charset\fR
.Sp
If provided, a \f(CW\*(C`\*(C'\fR tag will be added to the document's
\&\f(CW\*(C`\*(C'\fR.
.IP \(bu 4
language => \f(CW$language\fR
.Sp
If provided, a "lang" attribute will be added to the document's \f(CW\*(C`\*(C'\fR
tag.
.IP \(bu 4
output => \f(CW$fh\fR
.Sp
The file handle or object to which HTML output will be streamed. If you want to
capture the output in a string, you can open a filehandle to a string:
.Sp
.Vb 2
\& my $buffer = q{};
\& open my $fh, \*(Aq>\*(Aq, \e$buffer;
.Ve
.Sp
If you pass a file handle (or IO::Handle object), then all calls to
\&\f(CWprint()\fR will be checked, and an error will be thrown.
.Sp
You can pass an object of any other class, it must implement its own \f(CWprint()\fR
method, and error handling is left up to this method.
.SH ROLES
.IX Header "ROLES"
This class does the Markdent::Role::HTMLStream,
Markdent::Role::EventsAsMethods, and Markdent::Role::Handler roles.
.SH BUGS
.IX Header "BUGS"
See Markdent for bug reporting details.
.PP
Bugs may be submitted at .
.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 .
.SH AUTHOR
.IX Header "AUTHOR"
Dave Rolsky
.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.