Scroll to navigation

Text::Markup::Textile(3pm) User Contributed Perl Documentation Text::Markup::Textile(3pm)

Name

Text::Markup::Textile - Textile parser for Text::Markup

Synopsis

  my $html = Text::Markup->new->parse(file => 'README.textile');
  my $raw  = Text::Markup->new->parse(
      file    => 'README.textile',
      options => [ raw => 1 ],
  );

Description

This is the Textile <https://textile-lang.com> parser for Text::Markup. It reads in the file (relying on a BOM <https://www.unicode.org/unicode/faq/utf_bom.html#BOM>), hands it off to Text::Textile for parsing, and then returns the generated HTML as an encoded UTF-8 string with an "http-equiv="Content-Type"" element identifying the encoding as UTF-8.

It recognizes files with the following extension as Textile:

.textile

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::Textile qr{text(?:ile)?};

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 "raw" option to "parse".

In addition, Text::Markup::Mediawiki supports all of the Text::Textile options, including:

"disable_html"
"flavor"
"css"
"charset"
"docroot"
"trim_spaces"
"preserve_spaces"
"filter_param"
"filters"
"char_encoding"
"disable_encode_entities"
"handle_quotes"

Author

David E. Wheeler <david@justatheory.com>

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.

2024-03-03 perl v5.38.2