NAME

Markdent::Handler::HTMLStream::Document - Turns Markdent events into a complete HTML document

VERSION

version 0.35

DESCRIPTION

This class takes an event stream and turns it into a complete HTML document.

METHODS

This role provides the following methods:

Markdent::Handler::HTMLStream::Document->new(...)

This method creates a new handler. It accepts the following parameters:

  • title => $title

    The title of the document. This is required.

  • charset => $charset

    If provided, a <meta charset="..."> tag will be added to the document's <head>.

  • language => $language

    If provided, a "lang" attribute will be added to the document's <html> tag.

  • output => $fh

    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:

      my $buffer = q{};
      open my $fh, '>', \$buffer;

    If you pass a file handle (or IO::Handle object), then all calls to print() will be checked, and an error will be thrown.

    You can pass an object of any other class, it must implement its own print() method, and error handling is left up to this method.

ROLES

This class does the Markdent::Role::HTMLStream, Markdent::Role::EventsAsMethods, and Markdent::Role::Handler roles.

BUGS

See Markdent for bug reporting details.

Bugs may be submitted at https://github.com/houseabsolute/Markdent/issues.

I am also usually active on IRC as 'autarch' on irc://irc.perl.org.

SOURCE

The source code repository for Markdent can be found at https://github.com/houseabsolute/Markdent.

AUTHOR

Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2019 by Dave Rolsky.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

The full text of the license can be found in the LICENSE file included with this distribution.