template::plugin::wrap(3)

NAME

Template::Plugin::Wrap - Plugin interface to Text::Wrap

SYNOPSIS

[% USE wrap %]
# call wrap subroutine
[% wrap(mytext, width,  initial_tab,   subsequent_tab)
%]
# or use wrap FILTER
[%  mytext  FILTER  wrap(width,  initital_tab,  subsequent_tab) %]

DESCRIPTION

This plugin provides an interface to the Text::Wrap module
which provides simple paragraph formatting.

It defines a 'wrap' subroutine which can be called, pass
ing the input text and further optional parameters to
specify the page width (default: 72), and tab characters
for the first and subsequent lines (no defaults).

[% USE wrap %]

[% text = BLOCK %]
First, attach the transmutex multiplier to the cross

wired
quantum homogeniser.
[% END %]

[% wrap(text, 40, '* ', ' ') %]

Output:

* First, attach the transmutex

multiplier to the cross-wired quantum
homogeniser.

It also registers a 'wrap' filter which accepts the same
three optional arguments but takes the input text directly
via the filter input.

[% FILTER bullet = wrap(40, '* ', ' ') -%]
First, attach the transmutex multiplier to the cross

wired quantum
homogeniser.
[%- END %]

[% FILTER bullet -%]
Then remodulate the shield to match the harmonic fre

quency, taking
care to correct the phase difference.
[% END %]

Output:

* First, attach the transmutex

multiplier to the cross-wired quantum
homogeniser.

* Then remodulate the shield to match

the harmonic frequency, taking
care to correct the phase difference.

AUTHOR

Andy Wardley <abw@kfs.org>

The Text::Wrap module was written by David Muir Sharnoff
<muir@idiom.com> with help from Tim Pierce and many oth
ers.

VERSION

2.51, distributed as part of the Template Toolkit version
2.08, released on 30 July 2002.

COPYRIGHT

Copyright (C) 1996-2002 Andy Wardley. All Rights Re

served.
Copyright (C) 1998-2002 Canon Research Centre Europe

Ltd.

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

SEE ALSO

Template::Plugin, Text::Wrap

perl v5.8.0 2002-07-30 Template::Plugin::Wrap(3)