++ed by:
ECARROLL

1 PAUSE user

Evan Carroll
and 1 contributors

NAME

Template::Jade - A port of Jade to Perl

SYNOPSIS

Parse Jade Markup http://jade-lang.com/

                use Template::Jade qw(:all);
                
                my $html = render_file(
                        'file.jade'
                        , { TEMPLATE => { pageTitle => 'foo' }
                };

                my $html = render(
                        $jade_string
                        , { TEMPLATE => { pageTitle => 'foo' }
                );

                my $compiled_sub = compile(
                        $jade_string
                );
                $compiled_sub->( { TEMPLATE => { pageTitle => 'foo' } );

Want an example of Jade Markup?

        doctype html
        html(lang="en")
                head
                        script(type='text/javascript').
                                if (foo) {
                                        bar(1 + 5)
                                }
                body
                        h1 Jade - node template engine
                        #container.col
                                if youAreUsingJade
                                        p You are amazing
                                else
                                        p Get on it!
                                p.
                                        Jade is a terse and simple
                                        templating language with a
                                        strong focus on performance
                                        and powerful features.

EXPORT

To sent a variable to the template, write to the hash $options->{TEMPLATE}

compile( $source, $options )

Compiles and returns a subroutine, called with options.

render( $source, $options )

Renders from scalar returning the markup.

render_file( $filename, $options )

Renders from file returning the markup.

DOCUMENTATION

Please view http://jade-lang.com/ for the official documentation.

Most of Jade is working: includes, blocks, conditionals, extends, inline tags, implicit divs, comments (buffered and unbuffered), etc.

SUPPORTED OPTIONS

In calls to render_file, render, and compile the following options are always valid,

compile_debug

Outputs the body of the function to be compiled, pre-compilation.

fh_output

Alternatively feed a filehandle and Template::Jade will write directly to it.

CAVEATS

There are a few things not yet implimented.

  • Native Jade looping constructs

  • Prepend/append block constructs

  • Mixins -- compiled subroutines in the context of the parent.

  • Non :markdown filters

  • Array-set attributes a(href=@classes)

  • Only supports HTML5

Also, all code constructs (starting with '-' executes Perl not JavaScript).

AUTHOR

Evan Carroll, <me at evancarroll.com>

BUGS

Please report any bugs or feature requests to bug-template-jade at rt.cpan.org, or through the web interface at https://github.com/EvanCarroll/perl-template-jade/issues. 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 Template::Jade

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2014 Evan Carroll.

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.