.\" -*- 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 "Text::Markup::Creole 3pm"
.TH Text::Markup::Creole 3pm 2024-03-03 "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
.IX Header "Name"
Text::Markup::Creole \- Creole parser for Text::Markup
.SH Synopsis
.IX Header "Synopsis"
.Vb 5
\& my $html = Text::Markup\->new\->parse(file => \*(Aqfile.creole\*(Aq);
\& my $raw = Text::Markup\->new\->parse(
\& file => \*(Aqfile.creole\*(Aq,
\& options => [ raw => 1 ],
\& );
.Ve
.SH Description
.IX Header "Description"
This is the Creole parser for Text::Markup.
It reads in the file (relying on a
BOM ), hands it off to
Text::Markdown for parsing, and then returns the generated HTML as an
encoded UTF\-8 string with an \f(CW\*(C`http\-equiv="Content\-Type"\*(C'\fR element identifying
the encoding as UTF\-8.
.PP
It recognizes files with the following extensions as Markdown:
.IP \fI.creole\fR 4
.IX Item ".creole"
.PP
To change it the files it recognizes, load this module directly and pass a
regular expression matching the desired extension(s), like so:
.PP
.Vb 1
\& use Text::Markup::Creole qr{cre+ole+};
.Ve
.PP
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 \f(CW\*(C`raw\*(C'\fR option to \f(CW\*(C`parse\*(C'\fR.
.SH Author
.IX Header "Author"
Lucas Kanashiro
.SH "Copyright and License"
.IX Header "Copyright and License"
Copyright (c) 2011\-2023 Lucas Kanashiro. Some Rights Reserved.
.PP
This module is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.