oracular (3) Text::Markup::Bbcode.3pm.gz

Name

       Text::Markup::Bbcode - BBcode parser for Text::Markup

Synopsis

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

Description

       This is the BBcode <https://www.bbcode.org/> 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::Markdown 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 extensions as Markdown:

       .bb
       .bbcode

       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::Bbcode qr{beebee};

       Normally this module returns the output wrapped in a minimal HTML document skeleton. If you would like
       the raw output with the raw skeleton, you can pass the "raw" option to "parse".

       In addition Text::Markup::Bbcode supports all of the Parse::BBCode options, including:

       "tags"
       "escapes"
       "url_finder"
       "smileys"
       "linebreaks"
       "text_processor"
       "close_open_tags"
       "strict_attributes"
       "direct_attributes"
       "attribute_quote"
       "attribute_parser"
       "strip_linebreaks"

Author

       Lucas Kanashiro <kanashiro.duarte@gmail.com>

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.