home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / tsw / TSW_3.4.0.exe / Apache2 / perl / Format.pm < prev    next >
Encoding:
Perl POD Document  |  2004-01-30  |  2.8 KB  |  125 lines
  1. #============================================================= -*-Perl-*-
  2. #
  3. # Template::Plugin::Format
  4. #
  5. # DESCRIPTION
  6. #
  7. #   Simple Template Toolkit Plugin which creates formatting functions.
  8. #
  9. # AUTHOR
  10. #   Andy Wardley   <abw@kfs.org>
  11. #
  12. # COPYRIGHT
  13. #   Copyright (C) 1996-2000 Andy Wardley.  All Rights Reserved.
  14. #   Copyright (C) 1998-2000 Canon Research Centre Europe Ltd.
  15. #
  16. #   This module is free software; you can redistribute it and/or
  17. #   modify it under the same terms as Perl itself.
  18. #
  19. #----------------------------------------------------------------------------
  20. #
  21. # $Id: Format.pm,v 2.64 2004/01/13 16:20:38 abw Exp $
  22. #
  23. #============================================================================
  24.  
  25. package Template::Plugin::Format;
  26.  
  27. require 5.004;
  28.  
  29. use strict;
  30. use vars qw( @ISA $VERSION );
  31. use base qw( Template::Plugin );
  32. use Template::Plugin;
  33.  
  34. $VERSION = sprintf("%d.%02d", q$Revision: 2.64 $ =~ /(\d+)\.(\d+)/);
  35.  
  36.  
  37. sub new {
  38.     my ($class, $context, $format) = @_;;
  39.     return defined $format
  40.     ? make_formatter($format)
  41.     : \&make_formatter;
  42. }
  43.  
  44.  
  45. sub make_formatter {
  46.     my $format = shift;
  47.     $format = '%s' unless defined $format;
  48.     return sub { 
  49.     my @args = @_;
  50.     push(@args, '') unless @args;
  51.     return sprintf($format, @args); 
  52.     }
  53. }
  54.  
  55.  
  56. 1;
  57.  
  58. __END__
  59.  
  60.  
  61. #------------------------------------------------------------------------
  62. # IMPORTANT NOTE
  63. #   This documentation is generated automatically from source
  64. #   templates.  Any changes you make here may be lost.
  65. # 
  66. #   The 'docsrc' documentation source bundle is available for download
  67. #   from http://www.template-toolkit.org/docs.html and contains all
  68. #   the source templates, XML files, scripts, etc., from which the
  69. #   documentation for the Template Toolkit is built.
  70. #------------------------------------------------------------------------
  71.  
  72. =head1 NAME
  73.  
  74. Template::Plugin::Format - Plugin to create formatting functions
  75.  
  76. =head1 SYNOPSIS
  77.  
  78.     [% USE format %]
  79.     [% commented = format('# %s') %]
  80.     [% commented('The cat sat on the mat') %]
  81.     
  82.     [% USE bold = format('<b>%s</b>') %]
  83.     [% bold('Hello') %]
  84.  
  85. =head1 DESCRIPTION
  86.  
  87. The format plugin constructs sub-routines which format text according to
  88. a printf()-like format string.
  89.  
  90. =head1 AUTHOR
  91.  
  92. Andy Wardley E<lt>abw@andywardley.comE<gt>
  93.  
  94. L<http://www.andywardley.com/|http://www.andywardley.com/>
  95.  
  96.  
  97.  
  98.  
  99. =head1 VERSION
  100.  
  101. 2.64, distributed as part of the
  102. Template Toolkit version 2.13, released on 30 January 2004.
  103.  
  104. =head1 COPYRIGHT
  105.  
  106.   Copyright (C) 1996-2004 Andy Wardley.  All Rights Reserved.
  107.   Copyright (C) 1998-2002 Canon Research Centre Europe Ltd.
  108.  
  109. This module is free software; you can redistribute it and/or
  110. modify it under the same terms as Perl itself.
  111.  
  112. =head1 SEE ALSO
  113.  
  114. L<Template::Plugin|Template::Plugin>
  115.  
  116. =cut
  117.  
  118. # Local Variables:
  119. # mode: perl
  120. # perl-indent-level: 4
  121. # indent-tabs-mode: nil
  122. # End:
  123. #
  124. # vim: expandtab shiftwidth=4:
  125.