[%# # 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. -%] [% META book = 'Modules' page = 'Plugin_Date' %] [% WRAPPER toc; PROCESS tocitem title ="SYNOPSIS" subs = []; PROCESS tocitem title ="DESCRIPTION" subs = []; PROCESS tocitem title ="AUTHORS" subs = []; PROCESS tocitem title ="VERSION" subs = []; PROCESS tocitem title ="COPYRIGHT" subs = []; PROCESS tocitem title ="SEE ALSO" subs = []; END %] [% WRAPPER section title="SYNOPSIS" -%]

        [% tt_start_tag %] USE date [% tt_end_tag %]

        # use current time and default format
        [% tt_start_tag %] date.format [% tt_end_tag %]

        # specify time as seconds since epoch or 'h:m:s d-m-y' string
        [% tt_start_tag %] date.format(960973980) [% tt_end_tag %]
        [% tt_start_tag %] date.format('4:20:36 21/12/2000') [% tt_end_tag %]

        # specify format
        [% tt_start_tag %] date.format(mytime, '%H:%M:%S') [% tt_end_tag %]

        # specify locale
        [% tt_start_tag %] date.format(date.now, '%a %d %b %y', 'en_GB') [% tt_end_tag %]

        # named parameters
        [% tt_start_tag %] date.format(mytime, format = '%H:%M:%S') [% tt_end_tag %]
        [% tt_start_tag %] date.format(locale = 'en_GB') [% tt_end_tag %]
        [% tt_start_tag %] date.format(time   = date.now,
    		   format = '%H:%M:%S',
                       locale = 'en_GB) [% tt_end_tag %]

        # specify default format to plugin
        [% tt_start_tag %] USE date(format = '%H:%M:%S', locale = 'de_DE') [% tt_end_tag %]

        [% tt_start_tag %] date.format [% tt_end_tag %]
        ...

[%- END %] [% WRAPPER section title="DESCRIPTION" -%]

The Date plugin provides an easy way to generate formatted time and date strings by delegating to the POSIX strftime() routine.

The plugin can be loaded via the familiar USE directive.

        [% tt_start_tag %] USE date [% tt_end_tag %]

This creates a plugin object with the default name of 'date'. An alternate name can be specified as such:

        [% tt_start_tag %] USE myname = date [% tt_end_tag %]

The plugin provides the format() method which accepts a time value, a format string and a locale name. All of these parameters are optional with the current system time, default format ('%H:%M:%S %d-%b-%Y') and current locale being used respectively, if undefined. Default values for the time, format and/or locale may be specified as named parameters in the USE directive.

        [% tt_start_tag %] USE date(format = '%a %d-%b-%Y', locale = 'fr_FR') [% tt_end_tag %]

When called without any parameters, the format() method returns a string representing the current system time, formatted by strftime() according to the default format and for the default locale (which may not be the current one, if locale is set in the USE directive).

        [% tt_start_tag %] date.format [% tt_end_tag %]

The plugin allows a time/date to be specified as seconds since the epoch, as is returned by time().

        File last modified: [% tt_start_tag %] date.format(filemod_time) [% tt_end_tag %]

The time/date can also be specified as a string of the form 'h:m:s d/m/y'. Any of the characters : / - or space may be used to delimit fields.

        [% tt_start_tag %] USE day = date(format => '%A', locale => 'en_GB') [% tt_end_tag %]
        [% tt_start_tag %] day.format('4:20:00 9-13-2000') [% tt_end_tag %]

Output:

        Tuesday

A format string can also be passed to the format() method, and a locale specification may follow that.

        [% tt_start_tag %] date.format(filemod, '%d-%b-%Y') [% tt_end_tag %]
        [% tt_start_tag %] date.format(filemod, '%d-%b-%Y', 'en_GB') [% tt_end_tag %]

A fourth parameter allows you to force output in GMT, in the case of seconds-since-the-epoch input:

        [% tt_start_tag %] date.format(filemod, '%d-%b-%Y', 'en_GB', 1) [% tt_end_tag %]

Note that in this case, if the local time is not GMT, then also specifying '%Z' (time zone) in the format parameter will lead to an extremely misleading result.

Any or all of these parameters may be named. Positional parameters should always be in the order ($time, $format, $locale).

        [% tt_start_tag %] date.format(format => '%H:%M:%S') [% tt_end_tag %]
        [% tt_start_tag %] date.format(time => filemod, format => '%H:%M:%S') [% tt_end_tag %]
        [% tt_start_tag %] date.format(mytime, format => '%H:%M:%S') [% tt_end_tag %]
        [% tt_start_tag %] date.format(mytime, format => '%H:%M:%S', locale => 'fr_FR') [% tt_end_tag %]
        [% tt_start_tag %] date.format(mytime, format => '%H:%M:%S', gmt => 1) [% tt_end_tag %]
        ...etc...

The now() method returns the current system time in seconds since the epoch.

        [% tt_start_tag %] date.format(date.now, '%A') [% tt_end_tag %]

The calc() method can be used to create an interface to the Date::Calc module (if installed on your system).

        [% tt_start_tag %] calc = date.calc [% tt_end_tag %]
        [% tt_start_tag %] calc.Monday_of_Week(22, 2001).join('/') [% tt_end_tag %]

The manip() method can be used to create an interface to the Date::Manip module (if installed on your system).

        [% tt_start_tag %] manip = date.manip [% tt_end_tag %]
        [% tt_start_tag %] manip.UnixDate("Noon Yesterday","%Y %b %d %H:%M") [% tt_end_tag %]

[%- END %] [% WRAPPER section title="AUTHORS" -%]

Thierry-Michel Barral <kktos@electron-libre.com> wrote the original plugin.

Andy Wardley <abw@cre.canon.co.uk> provided some minor fixups/enhancements, a test script and documentation.

Mark D. Mills <mark@hostile.org> cloned Date::Manip from the cute Date::Calc sub-plugin.

[%- END %] [% WRAPPER section title="VERSION" -%]

2.77, distributed as part of the Template Toolkit version 2.19, released on 27 April 2007.

[%- END %] [% WRAPPER section title="COPYRIGHT" -%]

Copyright (C) 2000 Thierry-Michel Barral, Andy Wardley.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

[%- END %] [% WRAPPER section title="SEE ALSO" -%]

[% ttlink('Template::Plugin', 'Template::Plugin') -%], [% ttlink('POSIX', 'POSIX') -%]

[%- END %]