1 [Mishoo JSCalendar](http://dynarch.com/mishoo/calendar.epl), packaged for use by plugins, skins and add-ons.
3 # <a name="Summary of Contents"></a> Summary of Contents
5 This module packages the [Mishoo JSCalendar](http://dynarch.com/mishoo/calendar.epl) Javascript in a form suitable for use with TWiki.
7 # <a name="Detailed Documentation"></a> Detailed Documentation
9 Read [the Mishoo documentation](http://www.dementia.org/twiki//view/doc/html/reference.html) or [visit the demo page](http://www.dementia.org/twiki//view).
11 This package also includes a small Perl module to make using the calendar easier from TWiki plugins. This module includes the function:
15 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,
17 # Add styles and javascript for the calendar
18 require TWiki::Contrib::JSCalendarContrib;
19 if( $@ || !$TWiki::Contrib::JSCalendarContrib::VERSION ||
20 $TWiki::Contrib::JSCalendarContrib::VERSION < 0.961 ) {
21 TWiki::Func::writeWarning('JSCalendarContrib >=0.961 not found '.$@);
23 TWiki::Contrib::JSCalendarContrib::addHEAD( 'twiki' );
26 $html .= CGI::textfield(
27 { name => 'datefield',
28 id => "id_datefield" });
31 -name => 'datefield_calendar',
33 "return showCalendar('id_datefield','%e %B %Y')",
34 -src=> TWiki::Func::getPubUrlPath() . '/' .
35 TWiki::Func::getTwikiWebname() .
36 '/JSCalendarContrib/img.gif',
42 The first parameter to showCalendar is the id of the textfield. See the Mishoo documentation for details of the '$e %B %Y' parameter.
44 Note that the header will only be added once, regardless of the number of times that addHEAD is called.
46 `addHEAD` can be called from `commonTagsHandler` for adding the header to all pages, or to `beforeEditHandler` just for edit pages etc.
48 ## <a name="Settings"></a> Settings
50 - Name of the perl package
51 - Set STUB = TWiki::Contrib::JSCalendarContrib
53 ## <a name="Installation Instructions"></a> Installation Instructions
55 - Download the ZIP file from the Plugin web (see below)
56 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
58 <th bgcolor="#99CCCC"><strong> File: </strong></th>
59 <th bgcolor="#99CCCC"><strong> Description: </strong></th>
62 <td><code><b>data/TWiki/JSCalendarContrib.txt</b></code></td>
66 <td><code><b>lib/TWiki/Contrib/JSCalendarContrib/build.pl</b></code></td>
70 <td><code><b>lib/TWiki/Contrib/JSCalendarContrib.pm</b></code></td>
74 <td><code><b>pub/TWiki/JSCalendarContrib/twiki.js</b></code></td>
78 <td><code><b>pub/TWiki/JSCalendarContrib/bugtest-hidden-selects.html</b></code></td>
82 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-blue2.css</b></code></td>
86 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-blue.css</b></code></td>
90 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-brown.css</b></code></td>
94 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-green.css</b></code></td>
98 <td><code><b>pub/TWiki/JSCalendarContrib/calendar.js</b></code></td>
102 <td><code><b>pub/TWiki/JSCalendarContrib/calendar.php</b></code></td>
106 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-setup.js</b></code></td>
110 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-setup_stripped.js</b></code></td>
114 <td><code><b>pub/TWiki/JSCalendarContrib/calendar_stripped.js</b></code></td>
118 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-system.css</b></code></td>
122 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-tas.css</b></code></td>
126 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-win2k-1.css</b></code></td>
130 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-win2k-2.css</b></code></td>
134 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-win2k-cold-1.css</b></code></td>
138 <td><code><b>pub/TWiki/JSCalendarContrib/calendar-win2k-cold-2.css</b></code></td>
142 <td><code><b>pub/TWiki/JSCalendarContrib/ChangeLog</b></code></td>
146 <td><code><b>pub/TWiki/JSCalendarContrib/dayinfo.html</b></code></td>
150 <td><code><b>pub/TWiki/JSCalendarContrib/doc/html/field-button.jpg</b></code></td>
154 <td><code><b>pub/TWiki/JSCalendarContrib/doc/html/reference.css</b></code></td>
158 <td><code><b>pub/TWiki/JSCalendarContrib/doc/html/reference.html</b></code></td>
162 <td><code><b>pub/TWiki/JSCalendarContrib/doc/html/reference-Z-S.css</b></code></td>
166 <td><code><b>pub/TWiki/JSCalendarContrib/doc/reference.pdf</b></code></td>
170 <td><code><b>pub/TWiki/JSCalendarContrib/img.gif</b></code></td>
174 <td><code><b>pub/TWiki/JSCalendarContrib/index.html</b></code></td>
178 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-af.js</b></code></td>
182 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-al.js</b></code></td>
186 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-bg.js</b></code></td>
190 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-big5.js</b></code></td>
194 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-big5-utf8.js</b></code></td>
198 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-br.js</b></code></td>
202 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ca.js</b></code></td>
206 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-cs-utf8.js</b></code></td>
210 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-cs-win.js</b></code></td>
214 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-da.js</b></code></td>
218 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-de.js</b></code></td>
222 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-du.js</b></code></td>
226 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-el.js</b></code></td>
230 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-en.js</b></code></td>
234 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-es.js</b></code></td>
238 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-fi.js</b></code></td>
242 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-fr.js</b></code></td>
246 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-he-utf8.js</b></code></td>
250 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-hr.js</b></code></td>
254 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-hr-utf8.js</b></code></td>
258 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-hu.js</b></code></td>
262 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-it.js</b></code></td>
266 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-jp.js</b></code></td>
270 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ko.js</b></code></td>
274 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ko-utf8.js</b></code></td>
278 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-lt.js</b></code></td>
282 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-lt-utf8.js</b></code></td>
286 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-lv.js</b></code></td>
290 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-nl.js</b></code></td>
294 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-no.js</b></code></td>
298 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-pl.js</b></code></td>
302 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-pl-utf8.js</b></code></td>
306 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-pt.js</b></code></td>
310 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ro.js</b></code></td>
314 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ru_win_.js</b></code></td>
318 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-ru.js</b></code></td>
322 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-si.js</b></code></td>
326 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-sk.js</b></code></td>
330 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-sp.js</b></code></td>
334 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-sv.js</b></code></td>
338 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-tr.js</b></code></td>
342 <td><code><b>pub/TWiki/JSCalendarContrib/lang/calendar-zh.js</b></code></td>
346 <td><code><b>pub/TWiki/JSCalendarContrib/lang/cn_utf8.js</b></code></td>
350 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/active-bg.gif</b></code></td>
354 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/dark-bg.gif</b></code></td>
358 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/hover-bg.gif</b></code></td>
362 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/menuarrow.gif</b></code></td>
366 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/normal-bg.gif</b></code></td>
370 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/rowhover-bg.gif</b></code></td>
374 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/status-bg.gif</b></code></td>
378 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/theme.css</b></code></td>
382 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/title-bg.gif</b></code></td>
386 <td><code><b>pub/TWiki/JSCalendarContrib/skins/aqua/today-bg.gif</b></code></td>
390 <td><code><b>pub/TWiki/JSCalendarContrib/menuarrow.gif</b></code></td>
394 <td><code><b>pub/TWiki/JSCalendarContrib/menuarrow2.gif</b></code></td>
398 <td><code><b>pub/TWiki/JSCalendarContrib/multiple-dates.html</b></code></td>
402 <td><code><b>pub/TWiki/JSCalendarContrib/README</b></code></td>
406 <td><code><b>pub/TWiki/JSCalendarContrib/release-notes.html</b></code></td>
410 <td><code><b>pub/TWiki/JSCalendarContrib/simple-1.html</b></code></td>
414 <td><code><b>pub/TWiki/JSCalendarContrib/simple-2.html</b></code></td>
418 <td><code><b>pub/TWiki/JSCalendarContrib/simple-3.html</b></code></td>
422 <td><code><b>pub/TWiki/JSCalendarContrib/test.php</b></code></td>
426 <td><code><b>pub/TWiki/JSCalendarContrib/test-position.html</b></code></td>
431 - Make sure that all files are readable by the web server user
433 ## <a name="Contrib Info"></a> Contrib Info
435 <table border="1" cellpadding="0" cellspacing="0">
437 <td align="right"> Author: </td>
438 <td> TWiki:Main/CrawfordCurrie <a href="http://www.c-dot.co.uk" target="_top">http://www.c-dot.co.uk</a></td>
441 <td align="right"> Version: </td>
442 <td> 9105 of the Mishoo calendar </td>
445 <td align="right"> Copyright ©: </td>
446 <td> See <a href="http://www.dementia.org/twiki//view/doc/html/reference.html" target="_top">the Mishoo documentation</a></td>
449 <td align="right"> License: </td>
453 <td align="right"> Dependencies: </td>
457 <td> Change History: </td>
462 <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item453" rel="nofollow">Item453</a> removed [[Main/EditTablePlugins]] private copy of the Mishoo JS calendar, and made sure it works with [[Main/JSCalendarContrib]]. Improved the documentation of the JSCalendar while I was there. </td>
466 <td><a href="http://develop.twiki.org/~develop/cgi-bin/view/Bugs/Item468" rel="nofollow">Item468</a> updated docs for Dakar release </td>
470 <td> Cairo readiness </td>
474 <td> Split from [[Main/SharedCode]]</td>
477 <td align="right"> 27 Dec 2005 </td>
478 <td> updated to calendar version 1.0; set style for Safari to win2k-1 </td>
481 <td align="right"> 14 Aug 2004 </td>
482 <td> Separated out from [[Main/SharedCode]] module </td>
485 <td align="right"> Home: </td>
486 <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
489 <td align="right"> Feedback: </td>
490 <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
494 **_Related Topics:_** [[TWikiPreferences]]
496 -- TWiki:Main/CrawfordCurrie - 21:44:48 31 March 2006