Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

template::plugin::datafile(3pm) [debian man page]

Template::Plugin::Datafile(3pm) 			User Contributed Perl Documentation			   Template::Plugin::Datafile(3pm)

NAME

       Template::Plugin::Datafile - Plugin to construct records from a simple data file

SYNOPSIS

	   [% USE mydata = datafile('/path/to/datafile') %]
	   [% USE mydata = datafile('/path/to/datafile', delim = '|') %]

	   [% FOREACH record = mydata %]
	      [% record.this %]  [% record.that %]
	   [% END %]

DESCRIPTION

       This plugin provides a simple facility to construct a list of hash references, each of which represents a data record of known structure,
       from a data file.

	   [% USE datafile(filename) %]

       A absolute filename must be specified (for this initial implementation at least - in a future version it might also use the
       "INCLUDE_PATH").  An optional "delim" parameter may also be provided to specify an alternate delimiter character.

	   [% USE userlist = datafile('/path/to/file/users')	 %]
	   [% USE things   = datafile('items', delim = '|') %]

       The format of the file is intentionally simple.	The first line defines the field names, delimited by colons with optional surrounding
       whitespace.  Subsequent lines then defines records containing data items, also delimited by colons.  e.g.

	   id : name : email : tel
	   abw : Andy Wardley : abw@tt2.org : 555-1234
	   sam : Simon Matthews : sam@tt2.org : 555-9876

       Each line is read, split into composite fields, and then used to initialise a hash array containing the field names as relevant keys.  The
       plugin returns a blessed list reference containing the hash references in the order as defined in the file.

	   [% FOREACH user = userlist %]
	      [% user.id %]: [% user.name %]
	   [% END %]

       The first line of the file must contain the field definitions.  After the first line, blank lines will be ignored, along with comment line
       which start with a '"#"'.

BUGS

       Should handle file names relative to "INCLUDE_PATH".  Doesn't permit use of '":"' in a field.  Some escaping mechanism is required.

AUTHOR

       Andy Wardley <abw@wardley.org> <http://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

perl v5.14.2							    2011-12-20					   Template::Plugin::Datafile(3pm)

Check Out this Related Man Page

Template::Plugin::HTML(3)				User Contributed Perl Documentation				 Template::Plugin::HTML(3)

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

METHODS

   escape(text)
       Returns the source text with any HTML 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 HTML element.

   element(type, attributes)
       Generates an HTML 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 HTML 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
       HTML, 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> <http://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

perl v5.12.1							    2009-05-20						 Template::Plugin::HTML(3)
Man Page