/ 
HTML-AutoTag-0.01
River stage one • 2 direct dependents • 3 total dependents
/ HTML::AutoTag

NAME

HTML::AutoTag - Turn data into HTML.

THIS IS AN ALPHA RELEASE - the interface could change at a ++ of $VERSION.

SYNOPSIS

use HTML::AutoTag;

my %attr = ( class => [qw(odd even)] );
my @data = qw( one two three four five six seven eight );

my $auto = HTML::AutoTag->new( indent => '    ' );

print $auto->tag(
    tag   => 'ol', 
    cdata => [
        map { tag => 'li', attr => \%attr, cdata => $_ }, @data
    ]
);

DESCRIPTION

This module will make some HTML, yo.

METHODS

  • new()

    Accepts two arguments:

    • encodes

      Encode HTML entities. Defaults to empty string which produces no encoding. Set value to those characters you wish to have encoded. Set value to undef to encode all unsafe characters.

    • indent

      Pretty print results. Defaults to undef which produces no indentation. Set value to any number of spaces or tabs and newlines will also be appended.

  • tag()

    Accepts three arguments:

    • tag

      The name of the tag. String.

    • attr

      The attributes and values to write out for the tag. Hash reference.

    • cdata

      The value inbetween the tag. Types allowed are:

      • scalar - the string to be wrapped in tags

      • hash ref - another tag with its own cdata and attributes

      • AoH - multiple tags as hash references.

REQUIRES

  • Tie::Hash::Attribute

    Used to create rotating attributes.

EXAMPLE

The following should render a table with rotating attributes. Notice the need to supply the same reference for each <tr> attribute:

my %tr_attr = ( class => [qw(odd even)] );

print $auto->tag(
    tag => 'table',
    attr => { class => 'spreadsheet' },
    cdata => [
        {
            tag => 'tr',
            attr => \%tr_attr,
            cdata => {
                tag => 'td',
                attr => { style => { color => [qw(red green)] } },
                cdata => [qw(one two three four five six)],
            },
        },
        {
            tag => 'tr',
            attr => \%tr_attr,
            cdata => {
                tag => 'td',
                attr => { style => { color => [qw(red green)] } },
                cdata => [qw(seven eight nine ten eleven twelve)],
            },
        },
        {
            tag => 'tr',
            attr => \%tr_attr,
            cdata => {
                tag => 'td',
                attr => { style => { color => [qw(red green)] } },
                cdata => [qw(thirteen fourteen fifteen sixteen seventeen eighteen)],
            },
        },
    ]
);

INSPIRATION

Lincoln Stein's CGI has long been able to easily produce completely arbitrary HTML text by turning any non-defined method call into a wrapper.

Gisle Aas's HTML::Tree has a wonderful method (HTML::Element::new_from_lol) which this module draws most of its interface inspiration from. I would like to continue tweaking this code, while the named parameters make for a clean implementation they do get in the way of client.

BUGS AND LIMITATIONS

Please report any bugs or feature requests to either:

GITHUB

The Github project is https://github.com/jeffa/HTML-AutoTag

SUPPORT

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

perldoc HTML::AutoTag

You can also look for information at:

SEE ALSO

AUTHOR

Jeff Anderson, <jeffa at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2015 Jeff Anderson.

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.