|  | Tutorial |  |

|  | Manual |  |

|  | Modules |  |

|  | Library |  |

|  | Tools |  |

|  | FAQ |  |

|  | Release |  |

| Template Toolkit | Modules | Template::Plugin::Wrap |

## Template::Plugin::Wrap

| Template::Plugin::View

Template::Plugin::XML::DOM |

Plugin interface to Text::Wrap

### Table of Contents

- SYNOPSIS
- DESCRIPTION
- AUTHOR
- VERSION
- COPYRIGHT
- SEE ALSO

SYNOPSIS | [ Index ] [ Modules ] [ Top ]

        [% 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 | [ Index ] [ Modules ] [ Top ]

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 | [ Index ] [ Modules ] [ Top ]

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 | [ Index ] [ Modules ] [ Top ]

2.64, distributed as part of the Template Toolkit version 2.14, released on 04 October 2004.

COPYRIGHT | [ Index ] [ Modules ] [ Top ]

      Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
      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 | [ Index ] [ Modules ] [ Top ]

Template::Plugin, Text::Wrap

| Template::Plugin::View

Template::Plugin::XML::DOM |

| Tutorial |

| Manual |

| Modules |

| Library |

| Tools |

| FAQ |

| Release |

| http://www.template-toolkit.org/ |