Single-line text box and a button next to it to pick a date from a popup calendar. The date can also be typed into the text box. The date format can be customized.
If the contrib is installed, you will see such a field here:
Detailed Documentation
Read the Mishoo documentation or
visit the demo page for detailed information on using the
calendar widget.
This package also includes a small Perl module to make using the calendar
easier from TWiki plugins. This module includes the functions:
renderDateForEdit
TWiki::Contrib::JSCalendarContrib::renderDateForEdit($name, $value, $format [, \%cssClass]) -> $html
This is the simplest way to use calendars from a plugin.
$name is the name of the CGI parameter for the calendar (it should be unique),
$value is the current value of the parameter (may be undef)
$format is the format to use (optional; the default is set in configure). The HTML returned will display a date field and a drop-down calendar.
\%options is an optional hash containing base options for the textfield.
Example:
use TWiki::Contrib::JSCalendarContrib;
...
my $fromDate = TWiki::Contrib::JSCalendarContrib::renderDateForEdit(
'from', '1 April 1999');
my $toDate = TWiki::Contrib::JSCalendarContrib::renderDateForEdit(
'to', undef, '%Y');
addHEAD
TWiki::Contrib::JSCalendarContrib::addHEAD($setup)
This function will automatically add the headers for the calendar to the page
being rendered. It's intended for use when you want more control over the
formatting of your calendars than renderDateForEdit affords. $setup is
the name of
the calendar setup module; it can either be omitted, in which case the method
described in the Mishoo documentation can be used to create calendars, or it
can be 'twiki', in which case a Javascript helper function called
'showCalendar' is added that simplifies using calendars to set a value in a
text field. For example, say we wanted to display the date with the calendar
icon before the text field, using the format %Y %b %e
# Add styles and javascript for the calendar
use TWiki::Contrib::JSCalendarContrib;
...
sub commonTagsHandler {
....
# Enable 'showCalendar'
TWiki::Contrib::JSCalendarContrib::addHEAD( 'twiki' );
my $cal = CGI::image_button(
-name => 'img_datefield',
-onclick =>
"return showCalendar('id_datefield','%Y %b %e')",
-src=> TWiki::Func::getPubUrlPath() . '/' .
TWiki::Func::getTwikiWebname() .
'/JSCalendarContrib/img.gif',
-alt => 'Calendar',
-align => 'middle' )
. CGI::textfield(
{ name => 'date', id => "id_datefield" });
....
}
The first parameter to showCalendar is the id of the textfield, and the second parameter is the date format. Default format is '%e %B %Y'.
All available date specifiers:
%a - abbreviated weekday name
%A - full weekday name
%b - abbreviated month name
%B - full month name
%C - century number
%d - the day of the month ( 00 .. 31 )
%e - the day of the month ( 0 .. 31 )
%H - hour ( 00 .. 23 )
%I - hour ( 01 .. 12 )
%j - day of the year ( 000 .. 366 )
%k - hour ( 0 .. 23 )
%l - hour ( 1 .. 12 )
%m - month ( 01 .. 12 )
%M - minute ( 00 .. 59 )
%n - a newline character
%p - "PM" or "AM"
%P - "pm" or "am"
%S - second ( 00 .. 59 )
%s - number of seconds since Epoch (since Jan 01 1970 00:00:00 UTC)
%t - a tab character
%U, %W, %V - the week number
The week 01 is the week that has the Thursday in the current year,
which is equivalent to the week that contains the fourth day of January.
Weeks start on Monday.
%u - the day of the week ( 1 .. 7, 1 = MON )
%w - the day of the week ( 0 .. 6, 0 = SUN )
%y - year without the century ( 00 .. 99 )
%Y - year including the century ( ex. 1979 )
%% - a literal % character
addHEAD can be called from commonTagsHandler for adding the header to all pages, or from beforeEditHandler just for edit pages etc.
Installation Instructions
Note: You do not need to install anything on the browser to use this extension. The following instructions are for the administrator who installs the extension on the TWiki server.
For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
Download the ZIP file from the extension home on twiki.org (see below).
Unzip JSCalendarContrib.zip in your twiki installation directory.
Set the ownership of the extracted directories and files to the webserver user.
Install the dependencies (if any).
An administrator can customize the appearance of the calendar by modifying {JSCalendarContrib} settings in the "JSCalendarContrib Settings" section of the configure:
TWikibug:Item6254 Adding "JSCalendarContrib Settings" section to configure; changing default to ISO date format; improved documentation (TWiki:Main/PeterThoeny)
Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins