1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
|
package Markdent::Handler::HTMLStream::Document;
use strict;
use warnings;
use namespace::autoclean;
our $VERSION = '0.40';
use Markdent::Types;
use Moose;
use MooseX::SemiAffordanceAccessor;
with 'Markdent::Role::HTMLStream';
has title => (
is => 'ro',
isa => t('Str'),
required => 1,
);
has charset => (
is => 'ro',
isa => t('Str'),
predicate => '_has_charset',
);
has language => (
is => 'ro',
isa => t('Str'),
predicate => '_has_language',
);
my $Doctype = <<'EOF';
<!DOCTYPE html>
EOF
sub start_document {
my $self = shift;
$self->_stream_raw($Doctype);
$self->_stream_start_tag(
'html', {
$self->_has_language ? ( lang => $self->language ) : (),
},
);
$self->_stream_start_tag('head');
$self->_stream_start_tag( 'meta', { charset => $self->charset } )
if $self->_has_charset;
$self->_stream_start_tag('title');
$self->_stream_text( $self->title );
$self->_stream_end_tag('title');
$self->_stream_end_tag('head');
$self->_stream_start_tag('body');
}
sub end_document {
my $self = shift;
$self->_stream_end_tag('body');
$self->_stream_end_tag('html');
}
__PACKAGE__->meta->make_immutable;
1;
# ABSTRACT: Turns Markdent events into a complete HTML document
__END__
=pod
=encoding UTF-8
=head1 NAME
Markdent::Handler::HTMLStream::Document - Turns Markdent events into a complete HTML document
=head1 VERSION
version 0.40
=head1 DESCRIPTION
This class takes an event stream and turns it into a complete HTML document.
=head1 METHODS
This role provides the following methods:
=head2 Markdent::Handler::HTMLStream::Document->new(...)
This method creates a new handler. It accepts the following parameters:
=over 4
=item * title => $title
The title of the document. This is required.
=item * charset => $charset
If provided, a C<< <meta charset="..."> >> tag will be added to the document's
C<< <head> >>.
=item * language => $language
If provided, a "lang" attribute will be added to the document's C<< <html> >>
tag.
=item * 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 L<IO::Handle> object), then all calls to
C<print()> will be checked, and an error will be thrown.
You can pass an object of any other class, it must implement its own C<print()>
method, and error handling is left up to this method.
=back
=head1 ROLES
This class does the L<Markdent::Role::HTMLStream>,
L<Markdent::Role::EventsAsMethods>, and L<Markdent::Role::Handler> roles.
=head1 BUGS
See L<Markdent> for bug reporting details.
Bugs may be submitted at L<https://github.com/houseabsolute/Markdent/issues>.
I am also usually active on IRC as 'autarch' on C<irc://irc.perl.org>.
=head1 SOURCE
The source code repository for Markdent can be found at L<https://github.com/houseabsolute/Markdent>.
=head1 AUTHOR
Dave Rolsky <autarch@urth.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021 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
F<LICENSE> file included with this distribution.
=cut
|