Difference: JSCalendarContrib (4 vs. 5)

Revision 52008-01-22 - TWikiContributor

 

JSCalendarContrib

Added:
>
>
 
Changed:
<
<
Mishoo JSCalendar, packaged for use by plugins, skins and add-ons.
>
>
Mishoo JSCalendar, packaged for use by plugins, skins and add-ons.
 
<--

PLEASE DO NOT EDIT THIS TOPIC

It is automatically generated from the subversion repository, and any changes you make will simply be overwritten the next time a release is generated.

Instead, you could check your fix in, raise a bug in the Bugs web, or mail thge author. -->

Summary of Contents

This module packages the Mishoo JSCalendar Javascript in a form suitable for use with TWiki.

Detailed Documentation

Deleted:
<
<
Read the Mishoo documentation or visit the demo page.
 
Changed:
<
<
This package provides a renderFormFieldForEditHandler that could be invoked by a plugin to ensure that forms use the Mishoo JSCalendar for editing.
>
>
Read the Mishoo documentation or
Added:
>
>
visit the demo page for detailed information on using the calendar widget.
 
Changed:
<
<
This package also includes a small Perl module to make using the calendar easier from TWiki plugins. This module includes the function:
>
>
This package also includes a small Perl module to make using the calendar
Added:
>
>
easier from TWiki plugins. This module includes the functions:

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:
 
Changed:
<
<
addHEAD( $setup )
>
>
use TWiki::Contrib::JSCalendarContrib;
Added:
>
>
... my $fromDate = TWiki::Contrib::JSCalendarContrib::renderDateForEdit( 'from', '1 April 1999'); my $toDate = TWiki::Contrib::JSCalendarContrib::renderDateForEdit( 'to', undef, '%Y');
 
Changed:
<
<
that can automatically add the required headers to the page being rendered. $setup is the name of the calendar setup module; it can either be ommitted, 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 helper function is added that simplifies using calendars to set a value in a text field. For example,
>
>
Added:
>
>

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

 
Changed:
<
<
# Add styles and javascript for the calendar require TWiki::Contrib::JSCalendarContrib; if( $@ || !$TWiki::Contrib::JSCalendarContrib::VERSION ||
>
>
# Add styles and javascript for the calendar use TWiki::Contrib::JSCalendarContrib; ...
Deleted:
<
<
$TWiki::Contrib::JSCalendarContrib::VERSION < 0.961 ) { TWiki::Func::writeWarning('JSCalendarContrib >=0.961 not found '.$@); } else { TWiki::Contrib::JSCalendarContrib::addHEAD( 'twiki' ); }
 
Changed:
<
<
$html .= CGI::textfield( { name => 'datefield', id => "id_datefield" }); $html .= CGI::image_button( -name => 'datefield_calendar', -onclick => "return showCalendar('id_datefield','%e %B %Y')", -src=> TWiki::Func::getPubUrlPath() . '/' . TWiki::Func::getTwikiWebname() . '/JSCalendarContrib/img.gif', -alt => 'Calendar', -align => 'MIDDLE' ); } }
>
>
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(

Added:
>
>
{ name => 'date', id => "id_datefield" }); .... }
 
Changed:
<
<
The first parameter to showCalendar is the id of the textfield. See the Mishoo documentation for details of the '$e %B %Y' parameter.
>
>
The first parameter to showCalendar is the id of the textfield, and the second parameter is the . See the Mishoo documentation for details of the '$e %B %Y' parameter.
 
Changed:
<
<
Note that the header will only be added once, regardless of the number of times that addHEAD is called.
>
>
addHEAD can be called from commonTagsHandler for adding the header to all pages, or from beforeEditHandler just for edit pages etc.
 
Deleted:
<
<
addHEAD can be called from commonTagsHandler for adding the header to all pages, or to beforeEditHandler just for edit pages etc.
 
Deleted:
<
<

Settings

  • Name of the perl package
    • Set STUB = TWiki::Contrib::JSCalendarContrib
  • What do I do
    • Set SHORTDESCRIPTION = Mishoo JSCalendar, packaged for use by plugins, skins and add-ons.
 
Added:
>
>

Using the Calendar in user forms

You can also use the calendar directly in your own hand-built forms, without having to write any code. Just add this inline in the topic text:
%INCLUDE{"%SYSTEMWEB%/JSCalendarContribInline"}%
Then, to display a calendar icon next to a text input field:
<input type="text" id="cal_val_here" />
<input type="image" src="%PUBURL%/%SYSTEMWEB%/JSCalendarContrib/img.gif" onclick="javascript: return showCalendar('cal_val_here','%e %B %Y')" />
If the contrib is installed, you will see such a field here:

<-- 
  • Set SHORTDESCRIPTION = Mishoo JSCalendar, packaged for use by plugins, skins and add-ons.
-->
 

Installation Instructions

Added:
>
>
You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.
 
Changed:
<
<
  • Download the archive from the Plugins web (see below)
  • Unpack it in your twiki installation directory. Content:
    File: Description:
    data/TWiki/JSCalendarContrib.txt  
    lib/TWiki/Contrib/JSCalendarContrib.pm  
    pub/TWiki/JSCalendarContrib/twiki.js  
    pub/TWiki/JSCalendarContrib/bugtest-hidden-selects.html  
    pub/TWiki/JSCalendarContrib/calendar-blue2.css  
    pub/TWiki/JSCalendarContrib/calendar-blue.css  
    pub/TWiki/JSCalendarContrib/calendar-brown.css  
    pub/TWiki/JSCalendarContrib/calendar-green.css  
    pub/TWiki/JSCalendarContrib/calendar.js  
    pub/TWiki/JSCalendarContrib/calendar.php  
    pub/TWiki/JSCalendarContrib/calendar-setup.js  
>
>
Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.
  • If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • If you have any problems, then you can still install manually from the command-line:
    1. Download one of the .zip or .tgz archives
    2. Unpack the archive in the root directory of your TWiki installation.
    3. Run the installer script ( perl <module>_installer )
    4. Run configure and enable the module, if it is a plugin.
    5. Repeat for any missing dependencies.
  • If you are still having problems, then instead of running the installer script:
    1. Make sure that the file permissions allow the webserver user to access all files.
    2. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
    3. Manually edit LocalSite.cfg to set any configuration variables.
Deleted:
<
<
pub/TWiki/JSCalendarContrib/calendar-setup_stripped.js  
pub/TWiki/JSCalendarContrib/calendar_stripped.js  
pub/TWiki/JSCalendarContrib/calendar-system.css  
pub/TWiki/JSCalendarContrib/calendar-tas.css  
pub/TWiki/JSCalendarContrib/calendar-win2k-1.css  
pub/TWiki/JSCalendarContrib/calendar-win2k-2.css  
pub/TWiki/JSCalendarContrib/calendar-win2k-cold-1.css  
pub/TWiki/JSCalendarContrib/calendar-win2k-cold-2.css  
pub/TWiki/JSCalendarContrib/ChangeLog  
pub/TWiki/JSCalendarContrib/dayinfo.html  
pub/TWiki/JSCalendarContrib/doc/html/field-button.jpg  
pub/TWiki/JSCalendarContrib/doc/html/reference.css  
pub/TWiki/JSCalendarContrib/doc/html/reference.html  
pub/TWiki/JSCalendarContrib/doc/html/reference-Z-S.css  
pub/TWiki/JSCalendarContrib/doc/reference.pdf  
pub/TWiki/JSCalendarContrib/img.gif  
pub/TWiki/JSCalendarContrib/index.html  
pub/TWiki/JSCalendarContrib/lang/calendar-af.js  
pub/TWiki/JSCalendarContrib/lang/calendar-al.js  
pub/TWiki/JSCalendarContrib/lang/calendar-bg.js  
pub/TWiki/JSCalendarContrib/lang/calendar-big5.js  
pub/TWiki/JSCalendarContrib/lang/calendar-big5-utf8.js  
pub/TWiki/JSCalendarContrib/lang/calendar-br.js  
pub/TWiki/JSCalendarContrib/lang/calendar-ca.js  
pub/TWiki/JSCalendarContrib/lang/calendar-cs-utf8.js  
pub/TWiki/JSCalendarContrib/lang/calendar-cs-win.js  
pub/TWiki/JSCalendarContrib/lang/calendar-da.js  
pub/TWiki/JSCalendarContrib/lang/calendar-de.js  
pub/TWiki/JSCalendarContrib/lang/calendar-du.js  
pub/TWiki/JSCalendarContrib/lang/calendar-el.js  
pub/TWiki/JSCalendarContrib/lang/calendar-en.js  
pub/TWiki/JSCalendarContrib/lang/calendar-es.js  
pub/TWiki/JSCalendarContrib/lang/calendar-fi.js  
pub/TWiki/JSCalendarContrib/lang/calendar-fr.js  
pub/TWiki/JSCalendarContrib/lang/calendar-he-utf8.js  
pub/TWiki/JSCalendarContrib/lang/calendar-hr.js  
pub/TWiki/JSCalendarContrib/lang/calendar-hr-utf8.js  
pub/TWiki/JSCalendarContrib/lang/calendar-hu.js  
pub/TWiki/JSCalendarContrib/lang/calendar-it.js  
pub/TWiki/JSCalendarContrib/lang/calendar-jp.js  
pub/TWiki/JSCalendarContrib/lang/calendar-ko.js  
pub/TWiki/JSCalendarContrib/lang/calendar-ko-utf8.js  
pub/TWiki/JSCalendarContrib/lang/calendar-lt.js  
pub/TWiki/JSCalendarContrib/lang/calendar-lt-utf8.js  
pub/TWiki/JSCalendarContrib/lang/calendar-lv.js  
pub/TWiki/JSCalendarContrib/lang/calendar-nl.js  
pub/TWiki/JSCalendarContrib/lang/calendar-no.js  
pub/TWiki/JSCalendarContrib/lang/calendar-pl.js  
pub/TWiki/JSCalendarContrib/lang/calendar-pl-utf8.js  
pub/TWiki/JSCalendarContrib/lang/calendar-pt.js  
pub/TWiki/JSCalendarContrib/lang/calendar-ro.js  
pub/TWiki/JSCalendarContrib/lang/calendar-ru_win_.js  
pub/TWiki/JSCalendarContrib/lang/calendar-ru.js  
pub/TWiki/JSCalendarContrib/lang/calendar-si.js  
pub/TWiki/JSCalendarContrib/lang/calendar-sk.js  
pub/TWiki/JSCalendarContrib/lang/calendar-sp.js  
pub/TWiki/JSCalendarContrib/lang/calendar-sv.js  
pub/TWiki/JSCalendarContrib/lang/calendar-tr.js  
pub/TWiki/JSCalendarContrib/lang/calendar-zh.js  
pub/TWiki/JSCalendarContrib/lang/cn_utf8.js  
pub/TWiki/JSCalendarContrib/skins/aqua/active-bg.gif  
pub/TWiki/JSCalendarContrib/skins/aqua/dark-bg.gif  
pub/TWiki/JSCalendarContrib/skins/aqua/hover-bg.gif  
pub/TWiki/JSCalendarContrib/skins/aqua/menuarrow.gif  
pub/TWiki/JSCalendarContrib/skins/aqua/normal-bg.gif  
pub/TWiki/JSCalendarContrib/skins/aqua/rowhover-bg.gif  
pub/TWiki/JSCalendarContrib/skins/aqua/status-bg.gif  
pub/TWiki/JSCalendarContrib/skins/aqua/theme.css  
pub/TWiki/JSCalendarContrib/skins/aqua/title-bg.gif  
pub/TWiki/JSCalendarContrib/skins/aqua/today-bg.gif  
pub/TWiki/JSCalendarContrib/skins/aqua/transparent-bg.png  
pub/TWiki/JSCalendarContrib/menuarrow.gif  
pub/TWiki/JSCalendarContrib/menuarrow2.gif  
pub/TWiki/JSCalendarContrib/multiple-dates.html  
pub/TWiki/JSCalendarContrib/README  
pub/TWiki/JSCalendarContrib/release-notes.html  
pub/TWiki/JSCalendarContrib/simple-1.html  
pub/TWiki/JSCalendarContrib/simple-2.html  
pub/TWiki/JSCalendarContrib/simple-3.html  
pub/TWiki/JSCalendarContrib/test.php  
pub/TWiki/JSCalendarContrib/test-position.html  
 
Changed:
<
<
  • Make sure that all files are readable by the web server user
>
>
Added:
>
>
 
  • An administrator can customize the appearance of the calendar by setting the following in LocalSite.cfg
    Setting Default
    $TWiki::cfg{JSCalendarContrib}{style} 'blue'
    $TWiki::cfg{JSCalendarContrib}{lang} 'en'
    $TWiki::cfg{JSCalendarContrib}{format} '%e %b %Y'

Contrib Info

Changed:
<
<
Author: TWiki:Main/CrawfordCurrie http://www.c-dot.co.uk
Version: 11704 of the Mishoo calendar
>
>
Another great TWiki extension from the WikiRing - working together to improve your wiki experience!
Added:
>
>
Author: TWiki:Main/CrawfordCurrie http://c-dot.co.uk
Version: 16236 (22 Jan 2008) of the Mishoo calendar
 
Copyright ©: See the Mishoo documentation
License: GPL (GNU General Public License)
Dependencies: None
Change History:  
Changed:
<
<
11594 Allow format to be configured.
11415 Add a renderFormFieldForEditHandler so other plugins can forward to this handler to add the date field to the TWikiForms. (TWiki:Main.ThomasWeigert)
10247 Item2054 put the calendar at z-index 2000, way above pattern skin divs.
6634 Item453 removed EditTablePlugins private copy of the Mishoo JS calendar, and made sure it works with JSCalendarContrib. Improved the documentation of the JSCalendar while I was there.
6626 Item468 updated docs for Dakar release
5048 Cairo readiness
5039 Split from SharedCode?
>
>
6 Sep 2007 Bugs:Item4030 Added doc for using the calendar in user forms
13603 Bugs:Item2982 cleaned up the interface to the contrib, re-added a date rendering function with a more generic interface
11594 Allow format to be configured.
11415 Add a renderFormFieldForEditHandler so other plugins can forward to this handler to add the date field to the TWikiForms. (TWiki:Main.ThomasWeigert)
10247 Bugs:Item2054 put the calendar at z-index 2000, way above pattern skin divs.
6634 Bugs:Item453 removed EditTablePlugins private copy of the Mishoo JS calendar, and made sure it works with JSCalendarContrib. Improved the documentation of the JSCalendar while I was there.
6626 Bugs:Item468 updated docs for Dakar release
Added:
>
>
5048 Cairo readiness
5039 Split from SharedCode?
 
27 Dec 2005 updated to calendar version 1.0; set style for Safari to win2k-1
14 Aug 2004 Separated out from SharedCode? module
Home: http://TWiki.org/cgi-bin/view/Plugins/JSCalendarContrib
Feedback: http://TWiki.org/cgi-bin/view/Plugins/JSCalendarContribDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/JSCalendarContribAppraisal
Changed:
<
<
Related Topics: TWikiPreferences
>
>
Related Topics: TWikiPreferences
 
Added:
>
>
META FILEATTACHMENT attr="h" comment="" name="screenshot.gif" version="1"
META FILEATTACHMENT attr="h" comment="" name="wikiringlogo20x20.png" version="1"
 
 
This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.JSCalendarContrib