Quick Calendar Plugin

Generates a monthly calendar and creates link anchors from each day and week to somewhere else. A user can then place anchors further down in the page and the calendar date will link to them. The generated anchors correspond to ISO 8601 standard.

This plugin is one of the building blocks for a time management plugin I've written. But it might be useful by itself.

This plugin is kind of the "reverse" of the TWiki:Plugins/CalendarPlugin (which may also be of interest) which generates a custom calendar from wiki text. This TWiki:Plugins/QuickCalendarPlugin generates a fixed calendar which links to wiki text.

New version: v1.300. For recent changes, see TWiki:Plugins/QuickCalendarPluginDev.

Syntax Rules

  • Use the variable %CAL% or with arguments, %CAL{settings}% where settings are listed below.
    • Without settings, a linkified calendar of the current or specified month is displayed.
  • Additional Settings (all are optional):
    • month="sep" or month="september" or month="9"
    • year="yyyy" (must be a four digit year! "01" would be 01 C.E. )
    • URL specification: href="some url here"
      • Dates in calendar will link to some url hereYYYYMMDD or some url hereYYYYWW
        • Default URL link in anchor mode will be the current web.topic with #CalDateYYYYMMDD or #CalDateYYYYWW anchors
        • Default URL link in non anchor mode will be the wiki username with YYYYMMMDD or YYYYWW appended.
    • doy="on" will display dates in day-of-the-year format (see example below). Default: off
  • Relative Arguments (all are optional):
    • month="+4" or month="-6"
    • year="+2" or year="-1"
  • See examples below.

Examples

Example 1: Current Month

By default the plugin displays the current month:
You Type: %CAL%

Example 2: Specific Month and/or Year

You Type: %CAL{month="sep" year="2003"}%
You Get (note "today" is highlighted):

September 2003 (9/2003)
Week Sun Mon Tue Wed Thu Fri Sat
2003.35 1 2 3 4 5 6
2003.36 7 8 9 10 11 12 13
2003.37 14 15 16 17 18 19 20
2003.38 21 22 23 24 25 26 27
2003.39 28 29 30

Example 3: Day-of-Year mode

If you like, you can specify doy="on" as an argument, and get a calendar which uses days of the year. This is handy for some things, like astronomy. Type %CAL{doy="on"}% to see:

October 2003 (10/2003)
Week Sun Mon Tue Wed Thu Fri Sat
2003w40 274 275 276 277
2003w41 278 279 280 281 282 283 284
2003w42 285 286 287 288 289 290 291
2003w43 292 293 294 295 296 297 298
2003w44 299 300 301 302 303 304

Example 4: Anchoring

  • Each month creates both day and week anchors (for name="#anchor"), either (a) within the current topic in anchor mode, (b) a topic of the user's wiki name in non anchor mode, or (c) the user specified href.
    • The calendar days will link to the day anchors.
      • Click on the Sept 27th above to see the effect (anchor mode).
    • The week column will link to the week anchors.
      • Click on "2003.38" above to see the effect (anchor mode).
  • Specify a custom url with the syntax: href="link"

This line contains an anchor to "work week" 38 (in year 2003)
  • This is a very simple example of text following the week 38 anchor..

This line contains an anchor to the date 09/27/2003
  • This is a very simple example of text following the date anchor..

QuickCalendarPlugin Global Settings

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = An anchor linkified, internally generated, minimal calender.

  • Debug plugin:
    • Set DEBUG = 0

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

The following should display a calendar of Dec 2006 %CAL{month="dec" year="2006"}%

The following should display a small calendar of month+1 %CAL{month="+1"}%

The following should display a small calendar of month-14/year+1 (two months ago) %CAL{month="-14" year="+1"}%

The following should display a small calendar of month=12/year=2001 %CAL{month="12" year="2001"}%

Plugin Info

Plugin Author: TWiki:Main/JonathanCline
Plugin Version: 29 Sep 2003 (V1.220)
Change History: 1.100 initial
Change History: 1.210 bug fixes and specific date selection
Change History: 1.220 cosmetic upgrades & enhancements by TWiki:Main/WillNorris
Change History: 1.300 add doy, add internal enhancements, fix ww numbering
23 Aug 2003: Initial version
08 Sep 2003: v1.220
10 Oct 2003: v1.300
CPAN Dependencies: none
Other Dependencies: POSIX package in Perl (should be standard)
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/QuickCalendarPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/QuickCalendarPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/JonathanCline - 23 Aug 2003

-- TWiki:Main/JonathanCline - 10 Sep 2003

-- TWiki:Main/JonathanCline - 29 Sep 2003

-- TWiki:Main/JonathanCline - 11 Oct 2003
Topic revision: r1 - 28 Oct 2005, RainerFink
 
This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Medieninformatik-Wiki? Send feedback