• View
• Edit
• History
• Attach
• Print
• Backlinks

PmCalendar

Description

A web based calendar which uses PmWiki markup for display.

Overview:

Demo:

Click here to see a live example at PmCal.

Installation:

Place pmcal.php (this file) into your cookbook directory (e.g. /srv/www/htdocs/pmwiki/cookbook)

Include the cookbook in your local/config.php

 include_once("cookbook/pmcal.php"); 

Create a new Group called, for example, PmCal. You will need something on the default page of the group, let's say just

 ! This is My Calendar 

Or... you could just have comment on the page. Just as long as a default page exists. For example: (:comment placeholder:), as used on Holidays?action=source

Create a GroupFooter page in that Group with just

 (:pmcal:)

Upload the desired CSS file (see above). Rename it to match the Group where your PmCalendar resides (PmCal.css) and move it to the pub/css/ directory.

The entries on the individual days are shown on the calendar but it defaults to show the first paragraph using (:include YYYYMMDD paras=1:)

This will allow you to create a table of contents of sorts... not the (:toc:) recipe though.

Examples:

• In Pig Latin
• Red Theme
• View Recent Events (uses the PmCal-Zebra theme)
• View Recent Events w/ ISO Dates
• View Recent Events w/ Long Dates
• Blog Style View
• Short Month/Year Names
• Different Navigation Style
• In Spanish w/ Red Theme
• Show One Month Back and Six Months Out
• Show Full Week Day Names
• With Weeks Starting on Monday

Changelog:

     year=YYYY
     month=1..12
     day=1..number of days in month
     cals=Calendar1,Calendar2,....
          Where Calendar1.Calendar1 is a page with (:pmcal:) on it somehow
          (e.g. in the Calendar1.GroupFooter)

     $MaxIncludes = 500;

     caltype=[normal|text] (defaults to normal)
     monthsahead=0..60 (can show as many as 5 years more months ahead)
     monthsback=0..60 (can show as many as 5 years more months back)

     
     [[PmCal?monthsahead=1&monthsback=1&caltype=text|Event Diary]]
     (:pmcal cals=Holidays,Cjc:)
     

     
     year=              defaults to today's year (year=ACAL to add dates that can be used with acals=).
     month=             defaults to today's month.
     day=               defaults to today's day.
     acalfmt=           Formatted display of included ACAL calendar name.  Defaults to calfmt (below).
                          Substitutes the calendar name for %s (see also textacalfmt).
     acals=             anniversary date calendars to include (normal calendars with year=ACAL entries).
     alwaystoday=       defaults to false.  If true, they date is always today.  Useful for viewing
                          upcoming events when on a page containing a calendar viewing a different date.
     calfmt=            Formatted display of included calendar name.  Defaults to %s.  Substitutes
                          the calendar name for %s (see also textcalfmt).
     callinks=          defaults to true, includes links to Today and included calendars via cals=
     cals=              calendars to include: Holidays,Cjc,...
     caltype=           normal (default) or text.
     dayofweektitlefmt= default to %a (processed with strftime).
     dayofweektitle=    hardcode your own days of the week array (processed with strftime):
                          Sun,Mon,Tue,Hump,Thu,TGIF,Sat
     expire=            defaults to false, when set, do not display entries before today. Can also
                          be an integer delta number of days from today.
     includes=          Do includes, default is true.
     isodate=           YYYY-MM-DD, defaults is false (obsolete, textdatefmt=%Y-%m-%d).
     lines=             Set to an integer value for number of lines to include from a given
                        day in a display.  This overrides paras below.
     locale=            A system valid LC_TIME locale.
     monthsback=        Can display as many as 5 years of months back (60 months)
                          (might kill your browser though)
     monthsahead=       Can display as many as 5 years of months ahead (60 months)
                          (might kill your browser though)
     monthtitlefmt=     defaults to %B %Y (processed with strftime).
     monthtitle=        hardcode your own month names (processed with strftime):
                           New Year,Lovers Month,Lions Month,Showers Month,
     navnext=           defaults to » (processed with strftime)
     navprev=           defaults to « (processed with strftime)
     onedate=           defaults to false.  On caltype=text, if true, don't repeated date entry text links
                           more than once if same date.  If set to showcals, show the calendar of origin
                           for included calendar entries after the first one.
     overrides=         (in markup only) defaults to true.  If false, disallow URL variables.
     paras=             Set to an integer value for number of paragraphs to include from a given
                        day in a display.
     cssprefix=         Create css style/divs with this prefix.  Defaults to pmcal.
     reverse=           months start with the end and go backwards.
     stopafter=         days (positive or negative) from today for which no more entries will
                        be displayed in caltype=text.  If stopafter=5, show entries for the month
                        stopping with entries beyond 5 days from today (see also expire).
     styles=            (experimental) css style selections, first is preferred.
                           e.g. PmCal,PmCal-Red
     textacalfmt=        Analagous to acalfmt, except for caltype=text display.  Defaults to
                           textcalfmt.
     textcalfmt=        Analagous to calfmt, except for caltype=text display.  Defaults to
                           %s.
     textdatefmt=       for caltype=text, defaults to %x, used for dates with caltype=text
                           (processed with strftime)
     textlinks=         defaults to true, include a dated link in caltype=text before
                           included entry.  If set to nolinks, same as true, but text
                           displayed will not be links.
     weekstart=         defaults to 0.  With 0=Sunday.  Set to the day of the week in which
                           your week starts.
     

Todo:

For 1.0:

• Just bug fixes until 1.0!! Thanks to everyone for all the help with regards to features and fixes.
• This recipe was last tested on PmWiki version: pmwiki-2.0.beta.55
• This recipe requires at least PmWiki version: unknown

See Also

WikiCalendar

Contributors

Ccox

Questions & Comments

Q: How do you create each new appointment?

Q: Is there an easy way to edit/delete an item ?

Q: Is there a way to see a live demo? A screenshot is fine but obviously not enough. By the way, this is a remark common to many cookbook recipes: authors should be able to provide a sandbox where visitors could get the feel of the new feature ...

Q: Is there an easy way to specify anniversaries or repeating events ? Thanks! -rru?

Q2: Note by the questioner:
I found this solution suitable for me: For anniversaries I create calendar pages without the year in their names, e.g. pmcal.0125 for Jannuary 25th (simply by specifying their name as URL-Parm, e.g. ...?n=PmCal.0125).

Then I patched pmcal.php:

  ...
      for ($i=1; $i<=$totaldays; $i++) {
        $dayindex = $d % 7;
        $pmcalpagename=sprintf("%s.%04d%02d%02d",$group,$year,$month,$iday);
       // vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
       $anniversarypagename=sprintf("%s.%02d%02d",$group,$month,$iday);

       if ($caltype == 'normal') { ...

and

  ... 
       if ($includes != 'false' && PageExists($pmcalpagename)) {
         $MaxIncludes++;
         $out.=sprintf("\\\\\n\n(:include %s paras=1:)\n",$pmcalpagename);
       }

       // vvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvvv
       if ($includes != 'false' && PageExists($anniversarypagename)) {
         $MaxIncludes++;
         $out.=sprintf("\\\\\n\n(:include %s paras=1:)\n",$anniversarypagename);
       } ...

Now the content of this anniversary pages gets included every year. A very simple approach, but it works for me ... what do You think of it? rru?

Great, I'm looking forward to the next release - thanks! rru?

Q: After having installed the recipe pmcal I get the following message:

 Warning: Cannot modify header information - headers already sent by
 (output started at ./cookbook/pmcal.php:755)
 in /Users/pascallambrechts/Sites/pmwiki/pmwiki.php on line 709

at top of each of my wiki pages. Is this a reported bug? Thanks, pascal? October 15, 2005, at 05:45 PM

Q: I installed the calendar but it appears twice on the same page... Is there anyone that can help me ? Bye.

Q2: Thank you for your reply. I can't give you a url because it's a corporate wiki that can't be accessed from outside the company. First i created a group called Calendar. Then i created a page called Calendar.GroupFooter where i put (:pmcal:). I also created a page called Calendar.calendar where i put the same thing. Maybe i should delete one of the two pages ? If so, which one should i keep ? Thank you again. Bye.

Q: I'd like to use PmCalendar to keep track of the occupation of different offices, say Office 1 (needs its own calendar), Office 2 (also needs its own calendar), etc. But I see that when I make a modification in the calendar of Office 1 it shows also in the calendar of Office 2. In short, is there a way I could make each page have its own calendar? Thank you. Alex.

Q: Hello, how to create a calendar like CJC example? Thanks!

 ----
 %lfloat%The main [[Calendar/Calendar]] page.
 (:if false:)
 (:noleft:)
 (:ifend:)
 (:div style='float:right;width:70%;border:4px double #bbbbbb;background-color:darkslateblue':)
 !%center%Upcoming Events
 (:pmcal styles=PmCal-Mini caltype=text monthsahead=2 expire=true zebra=false textdatefmt='%A, %B %d, %Y':)
 (:divend:)
 (:pmcal styles=PmCal-Mini monthsback=1 monthsahead=2 includes=false:)

Q: After giving long names to two of my calendars, I'm having formatting problems with the names being too long when I include both of those calendars in a third. I can get calfmt=abrrevname to work for one calendar but how would I write my group footer for the third calendar so that the headers of both included calendars are abbreviated?

Q: I'm using Feral's CJC-like arrangement, but sometimes the number of appointments on the right text is too long. I'd like just 1 week of appointments to show. Is it possible to have a weeksahead or daysahead variable? Alternatively, and probably less elegant, could monthsahead=.25 for 1 week? (Thanks for "stopafter" -- it works great!) ~Steve

Q: I encounter serious problems with the ACAL feature. I think I don't really understand how to use the year= and acal= and cals= parameters together. I thought I made a good copy of the examples you gave, but it does not seem to work at all... Would you have a look to http://lossouarn.yann.free.fr/public_wiki/index.php5?n=MonCalendrier.MonCalendrier ?

Q: Is there a way to enter events that span over multiple days. For example a vacation calendar. Possible notation could be "PmCal.060820-060828". Is that feasible?

Q: I have created a Support.Calendar GroupFooter page with a link to Support.Calender. In that Support.Calender link I have a line (:pmcal styles=PmCal-Mini:) . When I click the Calender in my Group Footer I get the Calender fine, however the Calender Prev / Next month >> point to Support.HomePage (Instead of Support.Calender). I cannot see a parameter to :pmcal that allows me to change the name?

Have I done something silly? New to Wikis so quite possible!.
I took this approach as we would rather have a Calendar per Group linked from the footer.

Q: Hi, great cookbook, thx. Just a question. I'd like to use it as in the cjc example. I reused the code provided here, but anyway, whatever is the configuration, I never manage to have the dates displayed. I took a look at the .php and .css and I didn't find any "explanation". The dates are present in the html page but are not displayed. Any idea ? Thank you.

Q: How can I use simultaneously the PmCal and PmCal-Mini in 2 different pages (see previous topic) in regards of the .css renaming problem ? Thank you.

Q: Hi, we are from Germany. It's a nice program. Is it possible to get an german language-translation file. Or an example "what is do do" to translate it in an other language. Thank you.

Q: Hi, is it possible to use this as an event management calendar? So eg. I want to book a laptop out from the pool for four days. Could an 'event' be logged on the calendar that would show for four days? Also, when I tested this I found that I could only make one entry per day. It would be nice to have multiple pages per day. eg the calendar shows times 9.00 9.30 10.00 10.30 etc and clicking on a time allows you to edit a page for that time of day. Maybe I'm asking too much. Thanks

Works perfect. Yet, in the CSS file there are three unimportant errors. In each case it should read font-weight:bold instead of font-style:bold... Cheers

Q: I love this recipe and am currently trying to implement a calendar patterned after Cjc. I have a slight CSS problem, though, as it seems the calendar CSS is overridden by my standard CSS (specifically, for the <h2> tags and the <a href ...> tags), and my standard CSS is very hard to read when there is a link in a link in an <h2> headline. Is there a way to make the calendar CSS override my standard pmwiki CSS here? Or do I have to create a separate CSS for the calendar group? --Henning February 16, 2007, at 01:20 PM

Thanks for the explanation! I couldn't quite figure out the CSS requirements, and finally "solved" it by hard-coding the headline to a lower hierarchical level. (My headlines are set up somewhat unusually for historical reasons :-) --Henning March 19, 2007, at 08:47 AM

Q: Does something need to be changed in the css file paths to load the style sheets across a Wiki Farm? Francis

Ah yes, I see now that Cookbook:SharedPages#css also answers this. Thanks, Francis

Q: I get to each day page the eg "20070325" title, with really I hate it, more even beacuse I speak spanish, where/how should I change in order to get somethihg to "25-03-07"? Thanks in advance!

 
 (:title {$PmCalDName:Calendar %d-%m-%y}:)
 

Q: Regarding the same topic as above: Could you post please more of the "%d,%m,etc.-Variables".
More explicitly: I would like a title such as "Freitag, 14. April 2008", using the "monthtitle=" and "dayofweek=" I provided.
Thanx in Advance (beautiful script though!!)

Q: Is there anyway to customize this not run off the system clock, but to allow me to make a calender that contains 5 days in a week and 8 months in a year, each named as I desire to, I would also like to be able to have it run of different time. Reason is, I run a MUD and our time system contains 8 hours in each day, 5 days per week, 20 days per month, and 8 months a year.

Even a limited function calender would be fine, just so I could create dates and events, and have them displayed in the main calender page.?

Is there a way to display the Cjc calenders sideways - like 3 mini calenders side-by-side across the page? May 2008 - June 2008 - July 2008

Thanks CC