Brent Royal-Gordon > Template-Plugin-Lingua-Conjunction-0.02 > Template::Plugin::Lingua::Conjunction

Download:
Template-Plugin-Lingua-Conjunction-0.02.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.02   Source  

NAME ^

Template::Plugin::Lingua::Conjunction - Template Toolkit plugin for human-readable lists

SYNOPSIS ^

  [% USE Lingua.Conjunction %]
  [% Lingua.Conjunction.conjunction("Alice", "Bob", "Charlie") %] have secrets 
  from [% Lingua.Conjunction.list("Eve", "Mallory") %]
  
  Alice, Bob, and Charlie have secrets from Eve and Mallory.

DESCRIPTION ^

Lingua::Conjunction is a module to create sentence-style, human-readable lists of items from a Perl list. For example, given the list ("foo", "bar", "baz") it would return the string "foo, bar, and baz". If any of the strings in the list had a comma in them, it would switch to using a semicolon. It supports multiple languages and use of arbitrary separator characters. It handles any number of items gracefully, even two or one.

Template::Plugin::Lingua::Conjunction is a wrapper around this module so that it can be used from the Template Toolkit.

The main method of this plugin is conjunction (or list for short). It takes a list of items or arrays of items which should be converted and returns a human-readable string representation.

Template::Plugin::Lingua::Conjunction also supports Lingua::Conjunction's settings methods, namely lang, separator, separator_phrase, connector_type, and penultimate. For documentation on them, see Lingua::Conjunction.

SEE ALSO ^

Lingua::Conjunction, Template::Manual

AUTHOR ^

Brent Royal-Gordon <brentdax@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright (C) 2006 by Brent Royal-Gordon

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.7 or, at your option, any later version of Perl 5 you may have available.

syntax highlighting: