Text-Markup
view release on metacpan or search on metacpan
lib/Text/Markup/Creole.pm view on Meta::CPAN
package Text::Markup::Creole;
use 5.8.1;
use strict;
use warnings;
use Text::Markup;
use File::BOM qw(open_bom);
use Text::WikiCreole;
our $VERSION = '0.41';
sub import {
# Replace the regex if passed one.
Text::Markup->register( creole => $_[1] ) if $_[1];
}
sub parser {
my ($file, $encoding, $opts) = @_;
open_bom my $fh, $file, ":encoding($encoding)";
local $/;
my $html = creole_parse(<$fh>);
return unless $html =~ /\S/;
utf8::encode($html);
return $html if { @{ $opts } }->{raw};
return qq{<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
<body>
$html
</body>
</html>
};
}
1;
__END__
=head1 Name
Text::Markup::Creole - Creole parser for Text::Markup
=head1 Synopsis
my $html = Text::Markup->new->parse(file => 'file.creole');
my $raw = Text::Markup->new->parse(
file => 'file.creole',
options => [ raw => 1 ],
);
=head1 Description
This is the L<Creole|https://www.wikicreole.org/> parser for L<Text::Markup>.
It reads in the file (relying on a
L<BOM|https://www.unicode.org/unicode/faq/utf_bom.html#BOM>), hands it off to
L<Text::WikiCreole> for parsing, and then returns the generated HTML as an
encoded UTF-8 string with an C<http-equiv="Content-Type"> element identifying
the encoding as UTF-8.
It recognizes files with the following extensions as Creole:
=over
=item F<.creole>
=back
To change it the files it recognizes, load this module directly and pass a
regular expression matching the desired extension(s), like so:
use Text::Markup::Creole qr{cre+ole+};
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<raw> option to C<parse>.
=head1 Author
Lucas Kanashiro <kanashiro.duarte@gmail.com>
=head1 Copyright and License
Copyright (c) 2011-2023 Lucas Kanashiro. Some Rights Reserved.
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
=cut
( run in 2.661 seconds using v1.01-cache-2.11-cpan-98e64b0badf )