package Text::Markup::None;
use 5.8.1;
use strict;
use warnings;
use Text::Markup;
use HTML::Entities;
use File::BOM qw(open_bom);
our $VERSION = '0.33';
sub import {
# Set a regex if passed one.
Text::Markup->register( none => $_[1] ) if $_[1];
}
sub parser {
my ($file, $encoding, $opts) = @_;
open_bom my $fh, $file, ":encoding($encoding)";
local $/;
my $html = encode_entities(<$fh>, '<>&"');
return undef unless $html =~ /\S/;
utf8::encode($html);
return $html if { @{ $opts } }->{raw};
return qq{
$html
};
}
1;
__END__
=head1 Name
Text::Markup::None - Turn a file with no known markup into HTML
=head1 Synopsis
use Text::Markup;
my $html = Text::Markup->new->parse(file => 'README');
my $raw = Text::Markup->new->parse(
file => 'README',
options => [ raw => 1 ],
);
=head1 Description
This is the default parser used by Text::Markdown in the event that it cannot
determine the format of a text file. All it does is read the file in (relying
on a L, encodes all
entities, and then returns an HTML string with the file in a C<< >>
element. This will be handy for files that really are nothing but plain text,
like F files.
By default this parser is not associated with any file extensions. To have
Text::Markup also recognize files for this module, load it directly and pass
a regular expression matching the desired extension(s), like so:
use Text::Markup::None qr{te?xt};
Normally this module returns the output wrapped in a minimal HTML document
skeleton. If you would like the raw output without the skeleton, you can pass
the C option to C.
=head1 Author
David E. Wheeler
=head1 Copyright and License
Copyright (c) 2011-2024 David E. Wheeler. Some Rights Reserved.
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut