DateTimePlugin
Introduction
This plugin is an extension of the TWiki variable GMTIME{"format"} (that only allows to show the current date date and time).DateTimePlugin lets you show any date and time before or after 'now', and it will return any part of a date such as the month name. With DateTimePlugin you can write:
In five days will be:
%DATETIME{incdays="5"}% and will have a always coherent phrase.
Syntax Rules
Use%DATETIME{}% to show the current date and time in default date format (as set in configure).
For more options use: %DATETIME{"format" <optional parameters>}%
Parameters
| Parameter | Description | Example |
|---|---|---|
"..." or format="..." |
Format of date string; see GMTIME{"format"} for formatting variables | %DATETIME{"$wday"}% |
date="..." |
Any date in one of the following formats: Default TWiki format 31 Dec 2001 - 23:59 TWiki format without time (defaults to 00:00) 31 Dec 2001 Date seperated by '/', '.' or '-', time with '.' or ':' Date and time separated by ' ', '.' and/or '-' 2001/12/31 23:59:59 2001.12.31.23.59.59 2001/12/31 23:59 2001.12.31.23.59 2001-12-31 23:59 2001-12-31 - 23:59 ISO format 2001-12-31T23:59:59 ISO dates may have a timezone specifier, either Z or a signed difference in hh:mm format. For example: 2001-12-31T23:59:59+01:00 2001-12-31T23:59Z The local timezone will be assumed. Note: will not handle dates before 1970! |
%DATETIME{date="2001/12/31"}% |
incdays="..." |
Increase the date by any number of days (may be a negative number) | %DATETIME{date="31 Dec 2001" incdays="1"}% |
inchours="..." |
Increase the date by any number of hours (may be a negative number) | %DATETIME{date="31 Dec 2001 - 07:00" format="$hours" inchours="-1"}% |
incminutes="..." |
Increase the date by any number of minutes (may be a negative number) | %DATETIME{date="31 Dec 2001" format="$minutes" incminutes="15"}% |
incseconds="..." |
Increase the date by any number of seconds (may be a negative number) | %DATETIME{date="31 Dec 2001" format="$seconds" incseconds="20"}% |
Formatting parameters
See GMTIME{"format"} for general date and time formatting parameters to pass toformat. DateTimePlugin supports the following additional paramters:
| Parameter | Description | Example |
|---|---|---|
$i_month |
The localized short name of the month. | Ago |
$lmonth |
The English long name of the month. | July |
$i_lmonth |
The localized long name of the month. | Julho |
$i_wday |
The summarized internationalized name of the day of the week. | Qua |
$lwday |
The English long name of the day of the week. | Wednesday |
$i_lwday |
The localized long name of the day of the week. | Quarta-feira |
Overview of all formatting variables
%DATETIME{format=" $seconds |
$seconds |
$minutes |
$minutes |
$hours |
$hours |
$day |
$day |
$wday |
$wday |
$i_wday |
$i_wday |
$i_lwday |
$i_lwday |
$dow |
$dow |
$week |
$week |
$month |
$month |
$mo |
$mo |
$i_month |
$i_month |
$i_lmonth |
$i_lmonth |
$year |
$year |
$ye |
$ye |
$tz |
$tz |
$iso |
$iso |
$rcs |
$rcs |
$http |
$http |
$epoch |
$epoch |
Examples
Yesterday was %DATETIME{"$day $month $year" incdays="-1"}%
results in:
Yesterday was %DATETIME{"$lwday, $day $month $year" incdays="-1"}%
One week from now is %DATETIME{"$wday, $day $month $year" incdays="7"}%
results in:
One week from now is %DATETIME{"$wday, $day $month $year" incdays="7"}%
To create time-based topics:
%DATETIME{
"Create TODO topic for tomorrow: [[ToDo$year$mo$day]] ($lwday, $day $lmonth)"
incdays="1"
}%
results in:
%DATETIME{
"Create TODO topic for tomorrow: ToDo$year$mo$day ($lwday, $day $lmonth)"
incdays="1"
}%
Limitations
Due to date handling in Perl, DateTimePlugin cannot handle dates earlier than 1970.Plugin Settings
Plugin settings are stored as preferences variables. To reference a plugin setting write%<plugin>_<setting>%, i.e. %DATETIMEPLUGIN_SHORTDESCRIPTION%
- One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Display date and time with formatting options and localized dates
Localization
Localized dates are read from configure.Debugging
Visit configure and set{DateTimePlugin}{Debug} to 1.
Plugin Installation Instructions
Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.- Download the ZIP file from the Plugin web (see below)
- Unzip
DateTimePlugin.zipin your twiki installation directory. - Enable the plugin in configure
Plugin Info
| Plugin Author: | TWiki:Main.AurelioAHeckert, TWiki:Main.ArthurClemens |
| Copyright: | © 2004 TWiki:Main.AurelioAHeckert © 2008 TWiki:Main.ArthurClemens © 2004-2011 TWiki:TWiki.TWikiContributor |
| License: | GPL (GNU General Public License) |
| Plugin Version: | 21266 (2011-05-14) |
| Change History: | |
| 2011-05-14: | TWikibug:Item6701: Small fix in Config.spec -- TWiki:Main.PeterThoeny |
| 28 Feb 2008 | 1.0 Arthur Clemens: Major rewrite to make this plugin compatible with (and use from) TWiki::Time. Localized language strings are now read from configure. |
| 27 Jul 2004 | 0.90 Aurelio A Heckert: First release |
| CPAN Dependencies: | none |
| Other Dependencies: | none |
| Perl Version: | 5.005 |
| TWiki:Plugins.Benchmark: | GoodStyle nn%, FormattedSearch nn%, DateTimePlugin nn% |
| Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/DateTimePlugin |
| Feedback: | http://TWiki.org/cgi-bin/view/Plugins/DateTimePluginDev |
| Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/DateTimePluginAppraisal |
| I | Attachment | Action | Size | Date | Who | Comment |
|---|---|---|---|---|---|---|
 md5 |
DateTimePlugin.md5 | manage | 0.2 K | 2011-05-15 - 02:29 | PeterThoeny | |
 tgz |
DateTimePlugin.tgz | manage | 6.8 K | 2011-05-15 - 02:29 | PeterThoeny | |
| zip |
DateTimePlugin.zip | manage | 8.7 K | 2011-05-15 - 02:29 | PeterThoeny | |
| EXT |
DateTimePlugin_installer | manage | 3.4 K | 2011-05-15 - 02:29 | PeterThoeny |
Topic revision: r15 - 2011-08-23 - PeterThoeny
Home 
Site map
Blog web
Index
Search
Search extensions
Search by tags
Changes
Notifications
RSS Feed
Statistics
Preferences
Community 
Readme first!
Rate extensions!
Add-Ons 
Development topics
Idea topics
Plugins 
Development topics
Idea topics
Skins 
Development topics
Idea topics
Code Contribs 
Development topics
Idea topics
Account 
Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.Copyright © 1999-2012 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.