Template::Plugin::Wrap(3pm) - phpMan

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



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, passing 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 frequency, 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 AT wardley.org>

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

VERSION
       2.68, distributed as part of the Template Toolkit version 2.19, released on 27 April 2007.

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, Text::Wrap



perl v5.10.0                                2007-04-27                Template::Plugin::Wrap(3pm)

Generated by $Id: phpMan.php,v 4.49 2006/02/26 13:18:18 chedong Exp $ Author: Che Dong
On Apache
Under GNU General Public License
2012-05-25 02:50 @38.107.179.236 Crawled by CCBot/1.0 (+http://www.commoncrawl.org/bot.html)