Darren Kulp > Text-MultiMarkdown-1.0.3 > Text::MultiMarkdown

Download:
Text-MultiMarkdown-1.0.3.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.0.3   Source   Latest Release: Text-MultiMarkdown-1.000035

NAME ^

Text::MultiMarkdown - Convert MultiMarkdown syntax to (X)HTML

SYNOPSIS ^

    use Text::MultiMarkdown 'markdown';
    my $html = markdown($text);

    use Text::MultiMarkdown 'markdown';
    my $html = markdown( $text, {
        empty_element_suffix => '>',
        tab_width => 2
    } );

    use Text::MultiMarkdown;
    my $m = Text::MultiMarkdown->new;
    my $html = $m->markdown($text);

    use Text::MultiMarkdown;
    my $m = Text::MultiMarkdown->new;
    my $html = $m->markdown( $text, {
        empty_element_suffix => '>',
        tab_width => 2
    } );

DESCRIPTION ^

Markdown is a text-to-HTML filter; it translates an easy-to-read / easy-to-write structured text format into HTML. Markdown's text format is most similar to that of plain text email, and supports features such as headers, *emphasis*, code blocks, blockquotes, and links.

Markdown's syntax is designed not as a generic markup language, but specifically to serve as a front-end to (X)HTML. You can use span-level HTML tags anywhere in a Markdown document, and you can use block level HTML tags (like <div> and <table> as well).

For more information about Markdown's syntax, see:

    http://daringfireball.net/projects/markdown/

METHODS ^

new

A very simple constructor. Takes no arguments.

markdown

The main function as far as the outside world is concerned. See the SYNOPSIS for details on use.

Markdown

The main function (internal use only).

Header2Label

Internal use only.

xhtmlMetaData

Internal use only.

textMetaData

Internal use only.

NOTICE ^

Warning: this code is messy and does not adhere to any consistent set of code guidelines; this is not because of the original quality of the code, which is far above what I can pretend to be capable of creating, but because of the various patching and diffing steps in between and the incomplete translation of the original code into a module. I hope to fix many of the issues you may find soon, but I would rather release too early than too late, especially since I find the code quite usable at this point.

BUGS ^

To file bug reports or feature requests (other than topics listed in the Caveats section above) please send email to:

    support@daringfireball.net (for Markdown issues)

    fletcher@freeshell.org (for MultiMarkdown issues)

    kulp@cpan.org (for Text::MultiMarkdown issues)

Please include with your report: (1) the example input; (2) the output you expected; (3) the output Markdown actually produced.

VERSION HISTORY ^

See the Changes file for detailed release notes for this version.

AUTHOR ^

    John Gruber
    http://daringfireball.net/

    PHP port and other contributions by Michel Fortin
    http://michelf.com/

    MultiMarkdown changes by Fletcher Penney
    http://fletcher.freeshell.org/

    CPAN Module Text::MultiMarkdown (based on Text::Markdown by Sebastian
    Riedel) by Darren Kulp
    http://kulp.ch/

COPYRIGHT AND LICENSE ^

Original Code Copyright (c) 2003-2004 John Gruber <http://daringfireball.net/> All rights reserved.

MultiMarkdown changes Copyright (c) 2005-2006 Fletcher T. Penney <http://fletcher.freeshell.org/> All rights reserved.

Text::MultiMarkdown changes Copyright (c) 2006 Darren Kulp <http://kulp.ch>

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name "Markdown" nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright owner or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage.

syntax highlighting: