Tags:
create new tag
, view all tags

LocalTimePlugin

Show the current date and time of a particular city/timezone.

Introduction

This plugin is an alternative to the TWiki:Plugins.LocalCityTimePlugin and can be used for a systems diary.

Syntax Rules

Add a %LOCALTIME% tag to your text to show the current time. You can specify the location or timezone such as "Asia/Tokyo" or "GMT" with %LOCALTIME{location}%, where location is a location mentioned at http://twiki.org/cgi-bin/xtra/tzdate, or a timezone code such as "JST".

  • The unnamed, or DEFAULT parameter is the timezone to output
  • dateGMT must be a datetime string that TWiki can parse (see Time::TWiki::parseTime), but assumes GMT
    • 31 Dec 2001 - 23:59
    • 2001/12/31 23:59:59
    • 2001.12.31.23.59.59
    • 2001/12/31 23:59
    • 2001.12.31.23.59
    • 2001-12-31T23:59:59Z
    • 2001-12-31T23:59:59+01:00
    • 2001-12-31T23:59Z
    • 2001-12-31T23:59+01:00
  • format is the same as for the format specifier in http://t42p/cgi-bin/DEVELOP/bin/view/TWiki/TWikiVariables#VarGMTIME
  • fromtopic="web.topic" - the plugin tries to use the timezone set in the variable TIMEZONE on the topic selected

Examples

  you type if installed you get
Time in Tokyo now %LOCALTIME{Asia/Tokyo}% Mon, 23 Oct 2017, 06:04:31 (Asia/Tokyo)
Time in London now %LOCALTIME{Europe/London}% Sun, 22 Oct 2017, 22:04:31 (Europe/London)
Time in your TIMEZONE (if you've set the TIMEZONE VAR) now %LOCALTIME{fromtopic="$percntWIKIUSERNAME$percnt"}% Sun, 22 Oct 2017, 14:04:31 (America/Los_Angeles)
05 Apr 2006, 15:43:50 GMT in Sydney/Australia %LOCALTIME{"Australia/Sydney" dateGMT="05 Apr 2006 - 15:43:50"}% Thu, 06 Apr 2006, 01:43:00 (Australia/Sydney)
05 Apr 2006, 15:43:50 GMT in Sydney/Australia (format as iso) %LOCALTIME{"Australia/Sydney" dateGMT="05 Apr 2006 - 15:43:50" format="iso"}% 2006-04-06T01:43:00

This plugin can be used in combination with the CalendarPlugin, to get a localtime version of your appointments.

A member of your TWikiAdminGroup may need to add this plugin to the {PluginsOrder} configure setting to make sure it evaluates before the CalendarPlugin.

to add a TWikiIrcMeeting add a line like

   * %LOCALTIME{"Australia/Sydney" dateGMT="6 Mar 2006 - 15:39" format="$day $month"}% - TWikiIrcMeeting

you can even define a USER variable on your UserTopic, that sets a TimeZone variable, and replace the hard-coded Timezone with that variable.

LocalTimePlugin Global Settings

  • One line description:
    • Set SHORTDESCRIPTION = Show the current date and time of a particular city/timezone.

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

  • Defaults:
    • Set TIMEZONE = America/Los_Angeles

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.

  • Install the Date::Handler package from CPAN:
    • perl -MCPAN -e 'install Date::Handler'
  • Download the ZIP file from the repository on twiki.org (see below)
  • Unzip LocalTimePlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/LocalTimePlugin.txt Plugin topic
    lib/TWiki/Plugins/LocalTimePlugin.pm Plugin Perl module
  • Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
  • Test if the installation was successful:
    • Sun, 22 Oct 2017, 14:04:31 (America/Los_Angeles)

Plugin Info

Plugin Author: TWiki:Main.NathanOllerenshaw & TWiki:Main.SvenDowideit
Copyright: © 2003 TWiki:Main.NathanOllerenshaw
© 2006 TWiki:Main.SvenDowideit
© 2006-2010 TWiki:TWiki.TWikiContributor
Plugin Version: 2010-12-11 (V2.1)
Change History:  
2010-12-11: TWikibug:Item6530: Doc improvements, changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
2006-03-05: Updated to use TWiki04 registerHandler, added format= and dateGMT parameters -- TWiki:Main.SvenDowideit
2003-07-02: Initial version -- TWiki:Main.NathanOllerenshaw
CPAN Dependencies: Date::Handler
Other Dependencies: none
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/LocalTimePlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/LocalTimePluginDev

Related Topics: TWikiPreferences, TWikiPlugins

Physics WebpagesRHUL WebpagesCampus Connect • Royal Holloway, University of London, Egham, Surrey TW20 0EX; Tel/Fax +44 (0)1784 434455/437520

Topic revision: r3 - 18 Jul 2012 - TWikiAdminUser

 
This site is powered by the TWiki collaboration platformCopyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding RHUL Physics Department TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.LocalTimePlugin.