View on
MetaCPAN
Eric Wastl > Text-Nimble-0.002001 > Text::Nimble

Download:
Text-Nimble-0.002001.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.002001   Source  

NAME ^

Text::Nimble - Parse and render Nimble markup.

SYNOPSIS ^

    use Text::Nimble;

    my $nimble = <<END;
    @title This title will end up in $meta->{title}.

    { Nimble Example

    This *Nimble text* demonstrates a /few/ features.

    }
    END

    # just get html
    my  $html                  = Text::Nimble::render(html => $nimble);

    # or, get html, metadata, errors
    my ($html, $meta, $errors) = Text::Nimble::render(html => $nimble);

    # or, parse and render in separate steps
    my $parsetree              = Text::Nimble::parse($nimble);
    my ($html, $meta, $errors) = Text::Nimble::render(html => $parsetree);

DESCRIPTION ^

This module provides a function-oriented interface for parsing and rendering Nimble markup.

For details on Nimble syntax and the project in general, see http://was.tl/projects/nimble/.

FUNCTIONS ^

In case of error, these functions try to croak when used improperly (such as being invoked with invalid parameters) and die when something which was expected to be impossible happens (a bug, like the parser producing a token it doesn't know how to handle). Syntax errors do not die or even warn, but instead are left in the parse tree as special nodes of type error; these nodes are collected and returned by parse() or included in the output produced by render().

Text::Nimble::parse($markup)

Converts Nimble text into a parse tree. Takes a scalar containing an entire Nimble document. Returns a reference to a hash with these entries:

tree

The parse tree representing the renderable parts of the document.

meta

A reference to a hash containing the document's metadata.

macro

A reference to a hash which defined the macros declared in the document.

error

Omitted if there were no errors; otherwise, a reference to an array of references to error nodes within the parsetree. Each error node is a hash containing a type (always "error"), a context (a string describing what was going on when the error occurred), and errors, a reference to an array of error message strings.

Text::Nimble::render($format, $input)

Renders some input (either a parse tree from Text::Nimble::parse or a scalar containing an entire Nimble document) given some render format. In scalar context, returns a string containing the rendered data. In list context, returns a string containing the rendered data, a reference to a hash of the document's metadata, and either undef (if there were no errors) or a reference to an array of errors copied from the result of parse().

AUTHOR ^

Eric Wastl, <topaz at cpan.org>

BUGS ^

Please report any bugs or feature requests to bug-text-nimble at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Text-Nimble. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc Text::Nimble

You can also look for information at:

LICENSE AND COPYRIGHT ^

Copyright 2013 Eric Wastl.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

syntax highlighting: