Template::Plugin::HTML (3)

Leading comments

Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/Template::Plugin::HTML.3pm".)

NAME

Template::Plugin::HTML - Plugin to create HTML elements

SYNOPSIS

    [% USE HTML %]
    
    [% HTML.escape("if (a < b && c > d) ..." %]
    
    [% HTML.element(table => { border => 1, cellpadding => 2 }) %]
    
    [% HTML.attributes(border => 1, cellpadding => 2) %]

DESCRIPTION

The "HTML" plugin is a very basic plugin, implementing a few useful methods for generating

METHODS

escape(text)

Returns the source text with any reserved characters such as "<", ">", etc., correctly esacped to their entity equivalents.

attributes(hash)

Returns the elements of the hash array passed by reference correctly formatted (e.g. values quoted and correctly escaped) as attributes for an element.

element(type, attributes)

Generates an element of the specified type and with the attributes provided as an optional hash array reference as the second argument or as named arguments.

    [% HTML.element(table => { border => 1, cellpadding => 2 }) %]
    [% HTML.element('table', border=1, cellpadding=2) %]
    [% HTML.element(table => attribs) %]

DEBUGGING

The plugin accepts a "sorted" option as a constructor argument which, when set to any true value, causes the attributes generated by the "attributes()" method (either directly or via "element()") to be returned in sorted order. Order of attributes isn't important in but this is provided mainly for the purposes of debugging where it is useful to have attributes generated in a deterministic order rather than whatever order the hash happened to feel like returning the keys in.

    [% USE HTML(sorted=1) %]
    [% HTML.element( foo => { charlie => 1, bravo => 2, alpha => 3 } ) %]

generates:

    <foo alpha="3" bravo="2" charlie="1">

AUTHOR

Andy Wardley <abw@wardley.org> <wardley.org>

COPYRIGHT

Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO

Template::Plugin