Package perl-Template-Plugin-Autoformat: Information

This Template Toolkit plugin module is an interface to Damian
Conway's `Text::Autoformat' Perl module which provides advanced text wrapping
and formatting.

Configuration options may be passed to the plugin constructor via the
`USE' directive.

    [% USE autoformat(right => 30) %]

The autoformat subroutine can then be called, passing in text items which
will be wrapped and formatted according to the current configuration.

    [% autoformat('The cat sat on the mat') %]

Additional configuration items can be passed to the autoformat subroutine
and will be merged with any existing configuration specified via the
constructor.

    [% autoformat(text, left => 20) %]

Configuration options are passed directly to the `Text::Autoformat' plugin.
At the time of writing, the basic configuration items are:

    left        left margin (default: 1)
    right       right margin (default 72)
    justify     justification as one of 'left', 'right', 'full'
                or 'centre' (default: left)
    case        case conversion as one of 'lower', 'upper',
                'sentence', 'title', or 'highlight' (default: none)
    squeeze     squeeze whitespace (default: enabled)

The plugin also accepts a `form' item which can be used to define a
format string.  When a form is defined, the plugin will call the
underlying `form()' subroutine in preference to `autoformat()'.

    [% USE autoformat(form => '>>>>.<<') %]
    [% autoformat(123.45, 666, 3.14) %]

Additional configuration items relevant to forms can also be specified.

    [% USE autoformat(form => '>>>>.<<', numeric => 'AllPlaces') %]
    [% autoformat(123.45, 666, 3.14) %]

These can also be passed directly to the autoformat subroutine.

    [% USE autoformat %]
    [% autoformat( 123.45, 666, 3.14,
                   form    => '>>>>.<<',
                   numeric => 'AllPlaces' )
    %]

See the Text::Autoformat manpage for further details.

Package perl-Template-Plugin-Autoformat: Information

Last changed