[% USE autoformat(options) %]

    [% autoformat(text, more_text, ..., options) %]

    [% FILTER autoformat(options) %]
       a block of text
    [% END %]

    # определяем текст для примеров
    [% text = BLOCK %]
       Be not afeard.  The isle is full of noises, sounds and sweet
       airs that give delight but hurt not.
    [% END %]

    # передаем опции конструктору...
    [% USE autoformat(case => 'upper') %]
    [% autoformat(text) %]

    # и/или передаем опции непосредственно функции autoformat
    [% USE autoformat %]
    [% autoformat(text, case => 'upper') %]

    # используем фильтр autoformat
    [% USE autoformat(left => 10, right => 30) %]
    [% FILTER autoformat %]
       Be not afeard.  The isle is full of noises, sounds and sweet
       airs that give delight but hurt not.
    [% END %]

    # другой пример фильтра с опциями конфигурации
    [% USE autoformat %]
    [% FILTER autoformat(left => 20) %]
       Be not afeard.  The isle is full of noises, sounds and sweet
       airs that give delight but hurt not.
    [% END %]

    # другой пример использования FILTER с определением алиаса фильтра 'poetry'
    [% USE autoformat %]
    [% text FILTER poetry = autoformat(left => 20, right => 40) %]

    # повторное использование алиаса 'poetry'
    [% text FILTER poetry %]

    # короткая форма записи ('|' - алиас для 'FILTER')
    [% text | autoformat %]

    # использование формы вывода
    [% USE autoformat(form => '>>>>.<<<', numeric => 'AllPlaces') %]
    [% autoformat(10, 20.32, 11.35) %]

Плагин autoformat - интерфейс к perl-модулю Дамиана Конвея (Damian Conway) Text::Autoformat, который предоставляет расширенные возможности по форматированию и оформлению текста.

Опции конфигурации можно передавать конструктору плагина через директиву USE.

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

Затем можно вызывать функцию autoformat, передавая ей текстовые аргументы, которые будут оформлены и отформатированы согласно установкам текущей конфигурации.

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

Дополнительные параметры конфигурации можно передавать функции autoformat и они будут включены в существующую конфигурацию, определенную через конструктор.

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

Опции конфигурации передаются непосредственно плагину Text::Autoformat. В момент написания, были доступны следующие основные опции конфигурации:

    left	левое поле (по умолчанию: 1)
    right	правое поле (по умолчанию: 72)
    justify 	выравнивание - одно из 'left', 'right', 'full'
                или 'centre' (по умолчанию: left)
    case        преобразование регистра - одно из 'lower', 'upper',
                'sentence', 'title' или 'highlight' (по умолчанию: none)
    squeeze 	чистка пустот (по умолчанию: включено)

Плагин также принимает опцию конфигурации 'form', которую можно использовать для определения форматирующей строки. Если опция form определена, плагин вместо функции autoformat() вызовет лежащую в ее основе функцию form().

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

Можно определить дополнительные опции конфигурации, относящиеся к форматирующим строкам.

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

Их также можно передать напрямую в функцию autoformat.

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

Более подробное описание смотри в документации к Text::Autoformat.

Оригинальный код плагина написан Робертом МакАртуром (Robert McArthur <mcarthur@dstc.edu.au>) с небольшими изменениями и дополнениями от Энди Уардли (Andy Wardley <abw@wardley.org>).

Дамиан Конвей (Damian Conway <damian@conway.org>) написал модуль Text::Autoformat (в свободное время :-), который выполняет всю основную работу.

2.65, поставляется в составе Template Toolkit версии 2.14, дата релиза - 4 октября 2004.

Copyright (C) 2000 Robert McArthur & Andy Wardley. All Rights Reserved.

Этот модуль является свободно-распространяемым программным обеспечением; вы можете распространять и/или модифицировать его на тех же условиях, что и Perl.

Template::Plugin, Text::Autoformat