|
<
< |
Calendar Plugin (version 1.014)
|
>
> |
Calendar Plugin (version 1.016)
|
|
The CalendarPlugin handles the tag %CALENDAR% that inserts a monthly calendar in the page. Multiple topics can be specified as the source of the events, and these can be in any web.
|
|
A list of Events is just a bullet list like this:
- 2 Feb - Andrea's birthday
|
|
|
<
< |
- 7 Mar - Nicoletta's birthday
|
>
> |
- A 7 Mar 1966 - Nicoletta's birthday
|
|
- 29 May 1996 - Maria Teresa is born!
- 29 Sep 1998 - Davide is born!
|
|
|
|
<
< |
|
>
> |
|
|
|
|
|
|
<
< |
|
>
> |
7
Nicoletta's birthday (36) |
|
|
|
|
month="+mm" or "-mm" | relative month | Current month |
gmtoffset="+/-hh" | Timezone expressed as number of hours offset from GMT | Server timezone |
topic="TopicName" | Topic containig events | The topic containing the tag |
|
|
<
< |
topic="Web.TopicName1, TopicName2?" | Topics containig events | The topics containing the tags |
|
>
> |
topic="Web.TopicName1, Web.TopicName2" | Topics containig events | The topics containing the tags |
|
|
web="Webname" | Web containing the event topic | The current web |
lang="language" | Language: First few characters of "English", "Français", "Deutsch", "Español", "Português", "Nederlands", "Italiano", "Norsk", "Svenska", "Dansk", "suomi", "Magyar", "Polski | "English" |
daynames="Mon¦Tue¦..." | Custom day names | "Monday¦Tuesday¦Wednesday¦Thursday¦
Friday¦Saturday¦Sunday" |
header="..." | Text at the top of the calendar; use $m for current month, $y for year | Current month and year |
weekstartsonmonday="1" or "0" | Flag to start week on Monday | "0" (Sunday) |
|
|
<
< |
showdatenumbers="0" | Show day numbers 1...31 in date cells | "1" |
|
>
> |
showdatenumbers="0" | Show day numbers 1...31 in date cells. Note that showdatenumbers=1 means that HTML::CalendarMonthSimple will add the date numbers to the cells. If showdatenumbers=0, then the plugin adds the date numbers. The result of this is that a calendar will always show the date numbers. | "0" |
|
|
showweekdayheaders="1" | Show the weekday headers | "0" |
weekdayheadersbig="0" | If enabled, show weekday headers in bold cell headings | "1" |
cellalignment="left" | Horizontal cell alignment of day cells: "left", "center", "right", "justify", "char" | "center" |
|
|
| Yearly: | * dd MMM - description | 05 Jun - Every 5th of June |
| ^ | * w DDD MMM - description | 2 Tue Mar - Every 2nd Tuesday of March |
| ^ | * L DDD MMM - description | L Mon May - The last Monday of May |
|
|
>
> |
| ^ | * A dd MMM yyyy - description | A 20 Jul 1969 - First moon landing
This style will mark anniversaries of an event that occurred on the given date. The description will have " (x)" appended to it, where "x" indicates how many years since the occurence of the first date. The first date is not annotated. |
|
|
| Monthly: | * w DDD - description | 1 Fri - Every 1st Friday of the month |
| ^ | * dd - description | 14 - The 14th of every month |
| Weekly: | * E DDD - description | E Wed - Every Wednesday |
| ^ | * E DDD dd MMM yyyy - description | E Wed 27 Jan 2005 - Every Wednesday Starting 27 Jan 2005 |
| ^ | * E DDD dd MMM yyyy - dd MMM yyyy - description | E Wed 1 Jan 2005 - 27 Jan 2005 - Every Wednesday from 1 Jan 2005 through 27 Jan 2005 (inclusive) |
| Periodic: | * En dd MMM yyyy - description | E3 02 Dec 2002 - Every three days starting 02 Dec 2002 |
|
|
<
< |
| Exception: | Above syntax, followed by:
{ dd MMM yyyy, dd MMM yyyy - dd MMM yyyy } | 1 Fri X { 01 Dec 2002, 06 Dec 2002 - 14 Dec 2002 } - Every first Friday except on the 01 Dec 2002 and between 06 Dec 2002 and 14 Dec 2002 |
|
>
> |
| Exception: | Insert the following between the above syntax and the description:
X { dd MMM yyyy, dd MMM yyyy - dd MMM yyyy } | 1 Fri X { 01 Dec 2002, 06 Dec 2002 - 14 Dec 2002 } - Every first Friday except on the 01 Dec 2002 and between 06 Dec 2002 and 14 Dec 2002 |
|
|
If an event falls in the selected month then the corresponding day is (by default):
- highlighted (font size +2)
|
|
-
- Set SHORTDESCRIPTION = This plugin shows a monthly calendar with highlighted events
- How the cell content is formatted
|
|
<
< |
-
- Set FORMAT = $old
$description
|
>
> |
-
- Set FORMAT = $old
$description
|
|
|
|
<
< |
- Note: You can add settings of any of the recognized attributes (in upper case like SHOWWEEKDAYHEADERS)
|
>
> |
- Note: You can add settings of any of the recognized attributes (in upper case like SHOWWEEKDAYHEADERS). Examples are shown below:
- Set CELLALIGNMENT = center
- Set VCELLALIGNMENT = center
- #Set WIDTH = 100%
- #Set GMTOFFSET = +10
- #Set SHOWWEEKDAYHEADERS = 0
- #Set WEEKSTARTSONMONDAY = 0
|
|
Plugin Installation Instructions
|
|
- The Plugin uses the
HTML::CalendarMonthSimple and Date::Calc CPAN packages (see http://www.cpan.org)
- Install
Date::Calc
- Install
HTML::CalendarMonthSimple
|
|
<
< |
-
- Change line 197 of CalendarMonthSimple.pm as follows to avoid an annoying log message:
if ($self->year = $todayyear && $self->month = $todaymonth <font color="red">&& defined $thisday</font> && $thisday = $todaydate)=
|
>
> |
-
- To avoid an annoying log message, change line 272 of CalendarMonthSimple.pm v1.25 by adding the section marked in RED :
if ($self->year = = $todayyear && $self->month = = $todaymonth && defined $thisday && $thisday = = $todaydate)
- For earlier or later versions where the line number may be different, search for
todayyear. It currently (v1.22-v1.25) only appears twice: once to declare and set it, once to use it. On the line that uses it, add the && defined $thisday as shown above. -- TWiki:Main.AngusRogerson - 16 Aug 2004
|
|
- Unzip
CalendarPlugin.zip in your twiki installation directory. Content:
| File: | Description: |
|---|
data/TWiki/CalendarPlugin.txt | Plugin topic |
|
|
Plugin Info
|
|
<
< |
| Plugin Version: | V1.012 (15 Jan 2004) |
|
>
> |
| Plugin Version: | V1.016 (11 Mar 2005) |
|
|
| Change History: | <!-- versions below in reverse order --> |
|
|
>
> |
|
|
|
|
Related Topics: TWikiPreferences, TWikiPlugins
-- TWiki:Main/AndreaSterbini - 27 Feb 2001
|
|
<
< |
-- TWiki:Main/PeterThoeny - 15 Jan 2004
|
>
> |
-- TWiki:Main/PeterThoeny - 15 Jan 2004
-- TWiki:Main.NathanKerr - 28 Jan 2005
-- TWiki:Main/DavidBright - 11 Mar 2005
|
|
|
|
<
< |
| META FILEATTACHMENT | exclam.gif | attr="h" comment="Image of exclamation point" date="1073090410" path="exclam.gif" size="79" user="PeterThoeny" version="1.1" |
|---|
|
>
> |
| META FILEATTACHMENT | exclam.gif | attr="" comment="Image of exclamation point" date="1073090410" path="exclam.gif" size="79" user="PeterThoeny" version="1.1" |
|---|
|