The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
HTML-AutoTag-1.06
River stage one • 2 direct dependents • 3 total dependents
++
/ HTML::AutoTag

NAME

HTML::AutoTag - Just another HTML tag generator.

SYNOPSIS

  use HTML::AutoTag;

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

  my %attr = ( style => { color => [qw(red green)] } );
  my @data = qw( one two three four five six seven eight );

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

DESCRIPTION

Generate nested HTML (HTML4, XHTML and HTML5) tags with custom indentation, custom encoding and automatic attribute value rotation.

METHODS

  • new()

    Accepts the following arguments:

    • encode

      Encode HTML entities. Boolean. Defaults to false, which produces no encoding. If set to true without further specifying a value for encodes (see below), will encode all control chars, high bit chars and '<', '&', '>', ''' and '"'.

        encode => 1

    • encodes

      Encode HTML entities. String. Set value to those characters you wish to have encoded.

        encodes => '<=>'

    • 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.

        indent => '    '
  indent => "\t"

    • level

      Indentation level to start at. Can be used in conjunction with indent to set indentation even deeper to match any existing HTML this code may be injected into.

        level => 2

    • sorted

      Sorts the attribute names of the tag alphabetically. This is mostly useful for ensuring consistancy. The attributes (and potential sorting) happen within Tie::Hash::Attribute. You most likely will not need this feature.

        sorted => 1

  • tag()

    Accepts three arguments:

    • tag

      The name of the tag. String.

        tag => 'table'

    • cdata

      The value inbetween the tag. Types allowed are:

      • scalar - the string to be wrapped in tags

          cdata => 'hello world'

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

          cdata => { tag => 'td', attr => {}, cdata => 'value' }

      • AoH - multiple tags as hash references.

          cdata => [
      { tag => 'td', attr => {}, cdata => 'value1' }
      { tag => 'td', attr => {}, cdata => 'value2' }
  ]

    • attr

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

        attr => { border => 1 }

REQUIRES

EXAMPLES

The following will render a table with rotating attributes:

  my $auto = HTML::AutoTag->new( indent => "    " );
  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(green red)] } },
                  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)],
              },
          },
      ]
  );

The following will emulate CGI.pm's scrolling_list() output:

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

  print $auto->tag(
      tag   => 'select',
      attr  => { name => 'widgets', size => 3, multiple => 'multiple' },
      cdata => [
          { tag => 'option', cdata => 'foo', attr => { value => 1, } },
          { tag => 'option', cdata => 'bar', attr => { value => 2, selected => 'selected' } },
          { tag => 'option', cdata => 'baz', attr => { value => 3, selected => 'selected' } },
      ]
  );

Or in a more programatic way:

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

  my @selected = (2, 3);
  my @options  = (
      [ 1, 'foo' ],
      [ 2, 'bar' ],
      [ 3, 'baz' ],
  );

  my $selected = [];
  for my $o (@options) {
     push @$selected, (grep $_ eq $o->[0], @selected) ? 'selected' : undef;
  }
  my %attr = ( value => [ map $_->[0], @options ], selected => $selected );

  print $auto->tag(
      tag   => 'select',
      attr  => { name => 'widgets', size => scalar @options, multiple => 'multiple' },
      cdata => [ map { tag => 'option', attr => \%attr, cdata => $_->[1] }, @options ],
  );

See tests in t/ from the distribution or github for more examples: https://github.com/jeffa/HTML-AutoTag/tree/master/t

INSPIRATION

This module was the unintentional result of efforts to refactor DBIx::XHTML_Table into DBIx::HTML and Spreadsheet::HTML. The need to reimplement what CGI and HTML::Element (and a slew of others out there on the CPAN) do was generated from slow performance time and maintaining the rotating attributes feature (now in Tie::Hash::Attribute).

Two existing modules inspired this one: 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 distribution has a wonderful method (HTML::Element::new_from_lol) which this module draws most of its interface inspiration from.

BUGS AND LIMITATIONS

If you find a situtation in which this module cannot produce what you need please feel free to report a bug. You may 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

  • HTML::Tagset

    HTML::AutoTag takes a liberal approach to HTML creation. It does not validate the names of the tags or the names of attributes. It does not enforce rules for organization of the tags. HTML::Tagset provides "data tables useful in parsing HTML," they can also be useful here in the valid formation of HTML, if that kind of thing concerns you.

  • http://www.w3.org/TR/html5/syntax.html

AUTHOR

Jeff Anderson, <jeffa at cpan.org>

LICENSE AND COPYRIGHT

Copyright 2017 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.