Date Field Plugin

Provides support for a new type, date, in form fields. When a form field is set to this type it will no longer be editable by normal means, but only through a date selection popup.

WARNING: TWiki-4 only. If you want to use this plugin with an earlier version of TWiki, please see here

Usage

In a form definition, enter date where you would normally put text . For example:

| Birthday | date | 0 | 1 April 2004 | A date |

This will display an uneditable text field and a date selection icon that can be clicked to use the Mishoo Javascript calendar widget to insert a date. The size field is ignored.

If you want to use Javascript to create other data types in form fields, you can use this plugin as a model of how to do it.

Settings

The default date format is taken from the JSCalendarContrib settings. You can change the date format by setting the TWiki variable 'DATEFORMAT' in your TWikiPreferences, your WebPreferences or in a topic. For example:

• Set DATEFORMAT = %c

Look up strftime in Google for a full list of the format options.

The plugin can default to todays date by setting the TWiki variable 'DATEFIELDPLUGIN_DEFAULTTOTODAY' in your TWikiPreferences, your WebPreferences or in a topic. For example:

• Set DATEFIELDPLUGIN_DEFAULTTOTODAY = 1

See JSCalendarContrib for additional settings.

Plugin Installation Instructions

• Download the archive (.zip or .tgz) from the Plugin web (see below)
• Unpack the archive in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/DateFieldPlugin.txt	Plugin topic
  lib/TWiki/Plugins/DateFieldPlugin.pm	Plugin Perl module

• Run DateFieldPlugin_installer to automatically check and install other TWiki modules that this module depends on.
  • Alternatively, manually make sure the dependencies listed in the table below are resolved.

    Name	Version	Description
    TWiki::Contrib::JSCalendarContrib	>=7071	Used to display a neat calendar popup. Available from the TWiki:Plugins/JSCalendarContrib repository.

• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Plugin Info

Author:	TWiki:Main.CrawfordCurrie http://www.c-dot.co.uk
Version:	11861
Copyright ©:	2004 Deutsche Bank AG
License:	http://www.gnu.org/copyleft/gpl.html?
Change History:
11860	Added DATEFIELDPLUGIN_DEFAULTTOTODAY to allow turning on the default to today's date
11702	Use default date format from JSCalendarContrib
11335	Item2804 default date to todays date, support DATEFORMAT as standard preference
7265	Item180 removed pointless, outdated dependency check from DateFieldPlugin
6653	Item196 removed spurious documentation. JSCalendarContrib is now used, and there is no longer any plugin-specific setup for the calendar
5958	Item180 modernised DateFieldPlugin, and made mklinks.sh link in contribs. Also added a copy option, for people like Anton who want to make local dists for upload to remote servers
5451	Initial revision
03 Jan 2005	1.001 make outputformat configurable; changed standard format to sortable dates
9 Dec 2004	1.000 initial version
Dependencies:	Name Version Description TWiki::Contrib::JSCalendarContrib >=7071 Used to display a neat calendar popup. Available from the TWiki:Plugins/JSCalendarContrib repository.
Home:	TWiki:Plugins/DateFieldPlugin
Feedback:	TWiki:Plugins/DateFieldPluginDev

Related Topics: TWikiPreferences, TWikiPlugins, TWiki::Plugins/FormFieldsPlugin

This work was commissioned by Deutsche Bank AG.

-- TWiki:Main/CrawfordCurrie - 21:31:28 31 October 2006