summaryrefslogtreecommitdiff
path: root/lib/Template/Plugin/Autoformat.pm
diff options
context:
space:
mode:
authorAndreas Brachold <vdr07@deltab.de>2007-11-11 06:55:13 +0000
committerAndreas Brachold <vdr07@deltab.de>2007-11-11 06:55:13 +0000
commit3282be229999dc36c197b264d63063a18d136331 (patch)
tree98a42db29d955b39e7bed1b599fdcc56c3a29de9 /lib/Template/Plugin/Autoformat.pm
parentcfdd733c17cfa4f1a43b827a656e9e53cc2524ac (diff)
downloadxxv-3282be229999dc36c197b264d63063a18d136331.tar.gz
xxv-3282be229999dc36c197b264d63063a18d136331.tar.bz2
* Update installation list with required modules
* Remove unused/doubled provided external perl moduls
Diffstat (limited to 'lib/Template/Plugin/Autoformat.pm')
-rw-r--r--lib/Template/Plugin/Autoformat.pm242
1 files changed, 0 insertions, 242 deletions
diff --git a/lib/Template/Plugin/Autoformat.pm b/lib/Template/Plugin/Autoformat.pm
deleted file mode 100644
index b7153e4..0000000
--- a/lib/Template/Plugin/Autoformat.pm
+++ /dev/null
@@ -1,242 +0,0 @@
-#============================================================= -*-Perl-*-
-#
-# Template::Plugin::Autoformat
-#
-# DESCRIPTION
-# Plugin interface to Damian Conway's Text::Autoformat module.
-#
-# AUTHORS
-# Robert McArthur <mcarthur@dstc.edu.au>
-# - original plugin code
-#
-# Andy Wardley <abw@kfs.org>
-# - added FILTER registration, support for forms and some additional
-# documentation
-#
-# COPYRIGHT
-# Copyright (C) 2000 Robert McArthur & 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.
-#
-#----------------------------------------------------------------------------
-#
-# $Id: Autoformat.pm,v 2.64 2004/01/13 16:20:38 abw Exp $
-#
-#============================================================================
-
-package Template::Plugin::Autoformat;
-
-require 5.004;
-
-use strict;
-use vars qw( $VERSION );
-use base qw( Template::Plugin );
-use Template::Plugin;
-use Text::Autoformat;
-
-$VERSION = sprintf("%d.%02d", q$Revision: 2.64 $ =~ /(\d+)\.(\d+)/);
-
-sub new {
- my ($class, $context, $options) = @_;
- my $filter_factory;
- my $plugin;
-
- if ($options) {
- # create a closure to generate filters with additional options
- $filter_factory = sub {
- my $context = shift;
- my $filtopt = ref $_[-1] eq 'HASH' ? pop : { };
- @$filtopt{ keys %$options } = values %$options;
- return sub {
- tt_autoformat(@_, $filtopt);
- };
- };
-
- # and a closure to represent the plugin
- $plugin = sub {
- my $plugopt = ref $_[-1] eq 'HASH' ? pop : { };
- @$plugopt{ keys %$options } = values %$options;
- tt_autoformat(@_, $plugopt);
- };
- }
- else {
- # simple filter factory closure (no legacy options from constructor)
- $filter_factory = sub {
- my $context = shift;
- my $filtopt = ref $_[-1] eq 'HASH' ? pop : { };
- return sub {
- tt_autoformat(@_, $filtopt);
- };
- };
-
- # plugin without options can be static
- $plugin = \&tt_autoformat;
- }
-
- # now define the filter and return the plugin
- $context->define_filter('autoformat', [ $filter_factory => 1 ]);
- return $plugin;
-}
-
-sub tt_autoformat {
- my $options = ref $_[-1] eq 'HASH' ? pop : { };
- my $form = $options->{ form };
- my $out = $form ? Text::Autoformat::form($options, $form, @_)
- : Text::Autoformat::autoformat(join('', @_), $options);
- return $out;
-}
-
-__END__
-
-
-#------------------------------------------------------------------------
-# IMPORTANT NOTE
-# This documentation is generated automatically from source
-# templates. Any changes you make here may be lost.
-#
-# The 'docsrc' documentation source bundle is available for download
-# from http://www.template-toolkit.org/docs.html and contains all
-# the source templates, XML files, scripts, etc., from which the
-# documentation for the Template Toolkit is built.
-#------------------------------------------------------------------------
-
-=head1 NAME
-
-Template::Plugin::Autoformat - Interface to Text::Autoformat module
-
-=head1 SYNOPSIS
-
- [% USE autoformat(options) %]
-
- [% autoformat(text, more_text, ..., options) %]
-
- [% FILTER autoformat(options) %]
- a block of text
- [% END %]
-
-=head1 EXAMPLES
-
- # define some text for the examples
- [% text = BLOCK %]
- Be not afeard. The isle is full of noises, sounds and sweet
- airs that give delight but hurt not.
- [% END %]
-
- # pass options to constructor...
- [% USE autoformat(case => 'upper') %]
- [% autoformat(text) %]
-
- # and/or pass options to the autoformat subroutine itself
- [% USE autoformat %]
- [% autoformat(text, case => 'upper') %]
-
- # using the autoformat filter
- [% 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 %]
-
- # another filter example with configuration options
- [% 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 %]
-
- # another FILTER example, defining a 'poetry' filter alias
- [% USE autoformat %]
- [% text FILTER poetry = autoformat(left => 20, right => 40) %]
-
- # reuse the 'poetry' filter alias
- [% text FILTER poetry %]
-
- # shorthand form ('|' is an alias for 'FILTER')
- [% text | autoformat %]
-
- # using forms
- [% USE autoformat(form => '>>>>.<<<', numeric => 'AllPlaces') %]
- [% autoformat(10, 20.32, 11.35) %]
-
-=head1 DESCRIPTION
-
-The autoformat plugin 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 L<Text::Autoformat> for further details.
-
-=head1 AUTHORS
-
-Robert McArthur E<lt>mcarthur@dstc.edu.auE<gt> wrote the original plugin
-code, with some modifications and additions from Andy Wardley
-E<lt>abw@wardley.orgE<gt>.
-
-Damian Conway E<lt>damian@conway.orgE<gt> wrote the Text::Autoformat
-module (in his copious spare time :-) which does all the clever stuff.
-
-=head1 VERSION
-
-2.64, distributed as part of the
-Template Toolkit version 2.13, released on 30 January 2004.
-
-
-
-=head1 COPYRIGHT
-
-Copyright (C) 2000 Robert McArthur & 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.
-
-=head1 SEE ALSO
-
-L<Template::Plugin|Template::Plugin>, L<Text::Autoformat|Text::Autoformat>
-