Template::Plugin::Wrap.3pm

Langue: en

Autres versions - même langue

Version: 2007-05-21 (mandriva - 22/10/07)

Section: 3 (Bibliothèques de fonctions)

Sommaire

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@wardley.org>

The Text::Wrap module was written by David Muir Sharnoff <muir@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 (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