/ 
Template-Plugin-Text-Greeking-1.0
River stage zero No dependents
/ Template::Plugin::Text::Greeking

NAME

Template::Plugin::Text::Greeking - Text::Greeking interface in Template

VERSION

This document describes Template::Plugin::Text::Greeking version 0.0.1

SYNOPSIS

In your template code.

[% USE Text::Greeking %]

<div id="info">
  [% Text.Greeking() %]
</div>

DESCRIPTION

This module provides Text::Greeking in your template code. Why is it useful at all ? When you're still in design phrase of a template, this is very useful to fill out your page so you can grok a overall feeling. And you will be able to generate lipsums in different length so that it can even be used for testing purpsose. (Visual testing, which requires human testers to tell if it's successful.)

INTERFACE

new()

This is the constructor. Which allows users to write

[% Text.Greeking() %]

in template code.

When doing so, you may pass the several parameters to tweak greeking class' output. Such as:

[% Text.Greeking(paragraphs => [1,5]) %]

The available options keys are "words", "sentences", and "paragraphs". The value to these 3 keys should be an array (in the notation of array ref) of 2 numbers. The first number means the minium, the second of maximum. The example above is just the same as:

my $greeing = Text::Greeking->new;
$greeking->paragraphs(1,5);

Additionally, you may use alternative greeking classes in different languages. So far the only alternative option is Chinese. In this case you would say:

[% Text.Greeking(lang => "zh_TW") %]

To use Text::Greeking::zh_TW to generate Chinese lipsums.

CONFIGURATION AND ENVIRONMENT

Template::Plugin::Text::Greeking requires no configuration files or environment variables.

DEPENDENCIES

Text::Greeking

INCOMPATIBILITIES

None reported.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-template-plugin-text-greeking@rt.cpan.org, or through the web interface at http://rt.cpan.org.

AUTHOR

Kang-min Liu <gugod@gugod.org>

LICENCE AND COPYRIGHT

Copyright (c) 2007, Kang-min Liu <gugod@gugod.org>.

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

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.