~kosova/+junk/tuxfamily-twiki

---+!! %TOPIC%

<img src="%ATTACHURL%/screenshot.gif" style="float:right"/>

 

%SHORTDESCRIPTION%

 

<!--

 

   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.

-->

 

%TOC%

 

---++ Summary of Contents

This module packages the [[http://dynarch.com/mishoo/calendar.epl][Mishoo JSCalendar]] Javascript in a form suitable for use with Foswiki.

 

---++ Detailed Documentation

 

Read [[%ATTACHURL%/doc/html/reference.html][the Mishoo documentation]] or

[[%ATTACHURL%][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 Foswiki plugins. This module includes the functions:

 

 

---+++ Foswiki::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:

<verbatim>

use Foswiki::Contrib::JSCalendarContrib;

...

my $fromDate = Foswiki::Contrib::JSCalendarContrib::renderDateForEdit(

   'from', '1 April 1999');

my $toDate = Foswiki::Contrib::JSCalendarContrib::renderDateForEdit(

   'to', undef, '%Y');

</verbatim>

 

 

---+++ Foswiki::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 ='foswiki'=, 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=

<verbatim>

# Add styles and javascript for the calendar

use Foswiki::Contrib::JSCalendarContrib;

...

 

sub commonTagsHandler {

  ....

  # Enable 'showCalendar'

  Foswiki::Contrib::JSCalendarContrib::addHEAD( 'foswiki' );

 

  my $cal = CGI::image_button(

      -name => 'img_datefield',

      -onclick =>

       "return showCalendar('id_datefield','%Y %b %e')",

      -src=> Foswiki::Func::getPubUrlPath() . '/' .

             $Foswiki::cfg{SystemWebName} .

             '/JSCalendarContrib/img.gif',

      -alt => 'Calendar',

      -align => 'middle' )

    . CGI::textfield(

      { name => 'date', id => "id_datefield" });

  ....

}

</verbatim>

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:

<verbatim>

%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 

</verbatim>

 

=addHEAD= can be called from =commonTagsHandler= for adding the header to all pages, or from =beforeEditHandler= just for edit pages etc.

 

An alternative to =commonTagsHandler= is =postRenderingHandler= which is more efficient since it is called less often.

 

 

 

---+++ 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:

<verbatim>

%INCLUDE{"%SYSTEMWEB%/JSCalendarContribInline"}%

</verbatim>

Then, to display a calendar icon next to a text input field:

<verbatim>

<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')" />

</verbatim>

If the contrib is installed, you will see such a field here:

%INCLUDE{"%SYSTEMWEB%/JSCalendarContribInline"}%

<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')" />

 

<!--

   * Set SHORTDESCRIPTION = [[http://dynarch.com/mishoo/calendar.epl][Mishoo JSCalendar]], packaged for use by plugins, skins and add-ons.

-->

 

---+++ Installation Instructions

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.

 

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

 

If you have any problems, or if the extension isn't available in =configure=, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

 

   * An administrator can customize the appearance of the calendar by setting the following in =<nop>LocalSite.cfg=

     | *Setting* | *Default* |

     | =$Foswiki::cfg{JSCalendarContrib}{style}= | ='blue'= |

     | =$Foswiki::cfg{JSCalendarContrib}{lang}= | ='en'= |

     | =$Foswiki::cfg{JSCalendarContrib}{format}= | ='%e %b %Y'= |

 

---+++ Contrib Info

 

Another great Foswiki extension from the <a style="text-decoration:none" href="http://wikiring.com"><img src="%ATTACHURLPATH%/wikiringlogo20x20.png" alt="" /> *WikiRing* </a> - working together to improve your wiki experience!

 

|  Author: | Foswiki:Main/CrawfordCurrie http://c-dot.co.uk |

|  Copyright &copy;: | See [[%ATTACHURL%/doc/html/reference.html][the Mishoo documentation]] |

|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |

|  Version: | 3417 (2009-04-12) |

| Change History: | |

|  16 Dec 2008 | Foswiki version |

|  10 Sep 2008 | Bugs:Item5991 Applied patch to fix rendering on IE7 .|

|  06 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 DataForms. (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 |

|  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 |

|  Dependencies: | None |

|  Home: | http://foswiki.org/Extensions/%TOPIC% |

|  Support: | http://foswiki.org/Support/%TOPIC% |

 

---

*Related Topics:* %USERSWEB%.SitePreferences

 

%META:FILEATTACHMENT{name="screenshot.gif" attr="h" comment="" version="1"}%

%META:FILEATTACHMENT{name="wikiringlogo20x20.png" attr="h" comment="" version="1"}%