NAME
HTML::CalendarMonthSimple - Perl Module for Generating HTML Calendars
SYNOPSIS
use HTML::CalendarMonthSimple;
$cal = new HTML::CalendarMonthSimple('year'=>2001,'month'=>2);
$cal->width('50%');
$cal->border(10);
$cal->header('Text at the top of the Grid');
$cal->setcontent(14,"Valentine's Day");
$cal->setdatehref(14, 'http://www.lovers.com/');
$cal->addcontent(14,"<p>Don't forget to buy flowers.");
$cal->addcontent(13,"Guess what's tomorrow?");
$cal->bgcolor('pink');
print $cal->as_HTML;DESCRIPTION
HTML::CalendarMonthSimple is a Perl module for generating, manipulating, and printing a HTML calendar grid for a specified month. It is intended as a faster and easier-to-use alternative to HTML::CalendarMonth.
This module requires the Date::Calc module, which is available from CPAN if you don't already have it.
INTERFACE METHODS
new(ARGUMENTS)
Naturally, new() returns a newly constructed calendar object. Recognized arguments are 'year' and 'month', to specify which month's calendar will be used. If either is omitted, the current value is used. An important note is that the month and the year are NOT the standard C or Perl -- use a month in the range 1-12 and a real year, e.g. 2001.
# Examples:
# Create a calendar for this month.
$cal = new HTML::CalendarMonthSimple();
# One for a specific month/year
$cal = new HTML::CalendarMonthSimple('month'=>2,'year=>2000);
# One for "the current month" in 1997
$cal = new HTML::CalendarMonthSimple('year'=>1997);setcontent(DATE,STRING)
addcontent(DATE,STRING)
getcontent(DATE)
These methods are used to control the content of date cells within the calendar grid. The DATE argument may be a numeric date or it may be a string describing a certain occurrence of a weekday, e.g. "3MONDAY" to represent "the third Monday of the month being worked with", or it may be the plural of a weekday name, e.g. "wednesdays" to represent all occurrences of the given weekday. The weekdays are case-insensitive.
# Examples:
# The cell for the 15th of the month will now say something.
$cal->setcontent(15,"An Important Event!");
# Later down the program, we want the content to be boldfaced.
$foo = "<b>" . $cal->getcontent(15) . "</b>";
$cal->setcontent(15,$foo);
# Or we could get extra spiffy:
$cal->setcontent(15,"<b>" . $cal->getcontent(15) . "</b>");
# addcontent() does not clobber existing content.
# Also, if you setcontent() to '', you've deleted the content.
$cal->setcontent(16,'');
$cal->addcontent(16,"<p>Hello World</p>");
$cal->addcontent(16,"<p>Hello Again</p>");
print $cal->getcontent(16); # Prints 2 sentences
# Padded and decimal numbers may be used, as well:
$cal->setcontent(3.14159,'Third of the month');
$cal->addcontent('00003.0000','Still the third');
$cal->getcontent('3'); # Gets the 2 sentences
# The second Sunday of May is some holiday or another...
$cal->addcontent('2sunday','Some Special Day') if ($cal->month() == 5);
# So is the third wednesday of this month
$cal->setcontent('3WedNEsDaY','Third Wednesday!');
# What's scheduled for the second Friday?
$cal->getcontent('2FRIDAY');
# Every Wednesday and Friday of this month...
$cal->addcontent('wednesdays','Every Wednesday!');
$cal->getcontent('Fridays');as_HTML()
This method returns a string containing the HTML table for the month.
# Example:
print $cal->as_HTML();It's okay to continue modifying the calendar after calling as_HTML(). My guess is that you'd want to call as_HTML() again to print the further-modified calendar, but that's your business...
setdatehref(DATE,URL_STRING)
getdatehref(DATE)
These methods are used to control the content of date cells within the calendar grid.
# Example:
# The date number in the cell for the 15th of the month will
# be a link to the sourceforge website
$cal->setdatehref(15,"http://sourceforge.net/");
# Example:
# You want to add to an URL
$cal->setdatehref(15, $getdatehref(15)."projects/perl/");year()
month()
monthname()
These methods simply return the year/month of the calendar. monthname() returns the text name of the month, e.g. "December".
border([INTEGER])
This specifies the value of the border attribute to the <TABLE> declaration for the calendar. As such, this controls the thickness of the border around the calendar table. The default value is 5.
If a value is not specified, the current value is returned. If a value is specified, the border value is changed and the new value is returned.
width([INTEGER][%])
This sets the value of the width attribute to the <TABLE> declaration for the calendar. As such, this controls the horizintal width of the calendar.
The width value can be either an integer (e.g. 600) or a percentage string (e.g. "80%"). Most web browsers take an integer to be the table's width in pixels and a percentage to be the table width relative to the screen's width. The default width is "100%".
If a value is not specified, the current value is returned. If a value is specified, the border value is changed and the new value is returned.
# Examples:
$cal->width(600); # absolute pixel width
$cal->width("100%"); # percentage of screen sizeshowdatenumbers([1 or 0])
If showdatenumbers() is set to 1, then the as_HTML() method will put date labels in each cell (e.g. a 1 on the 1st, a 2 on the 2nd, etc.) If set to 0, then the date labels will not be printed. The default is 1.
If no value is specified, the current value is returned.
The date numbers are shown in boldface, normal size font. If you want to change this, consider setting showdatenumbers() to 0 and using setcontent()/addcontent() instead.
showweekdayheaders([1 or 0])
weekdayheadersbig([1 or 0])
If showweekdayheaders() is set to 1 (the default) then calendars rendered via as_HTML() will display the names of the days of the week. If set to 0, the days' names will not be displayed.
If weekdayheadersbig() is set to 1 (the default) then the weekday headers will be in <th> cells. The effect in most web browsers is that they will be boldfaced and centered. If set to 0, the weekday headers will be in <td> cells and in normal text.
For both functions, if no value is specified, the current value is returned.
cellalignment([STRING])
vcellalignment([STRING])
cellalignment() sets the value of the align attribute to the <TD> tag for each day's cell. This controls how text will be horizontally centered/aligned within the cells. vcellalignment() does the same for vertical alignment. By default, content is aligned horizontally "left" and vertically "top"
Any value can be used, if you think the web browser will find it interesting. Some useful alignments are: left, right, center, top, and bottom,
header([STRING])
By default, the current month and year are displayed at the top of the calendar grid. This is called the "header".
The header() method allows you to set the header to whatever you like. If no new header is specified, the current header is returned.
If the header is set to an empty string, then no header will be printed at all. (No, you won't be stuck with a big empty cell!)
# Example:
# Set the month/year header to something snazzy.
my($y,$m) = ( $cal->year() , $cal->monthname() );
$cal->header("<center><font size=+2 color=red>$m $y</font></center>\n\n");bgcolor([STRING])
weekdaycolor([STRING])
weekendcolor([STRING])
todaycolor([STRING])
bordercolor([STRING])
weekdaybordercolor([STRING])
weekendbordercolor([STRING])
todaybordercolor([STRING])
contentcolor([STRING])
weekdaycontentcolor([STRING])
weekendcontentcolor([STRING])
todaycontentcolor([STRING])
headercolor([STRING])
headercontentcolor([STRING])
weekdayheadercolor([STRING])
weekdayheadercontentcolor([STRING])
weekendheadercolor([STRING])
weekendheadercontentcolor([STRING])
These define the colors of the cells. If a string (which should be either a HTML color-code like '#000000' or a color-word like 'yellow') is supplied as an argument, then the color is set to that specified. Otherwise, the current value is returned. To un-set a value, try assigning the null string as a value.
The bgcolor defines the color of all cells. The weekdaycolor overrides the bgcolor for weekdays (Monday through Friday), the weekendcolor overrides the bgcolor for weekend days (Saturday and Sunday), and the todaycolor overrides the bgcolor for today's date. (Which may not mean a lot if you're looking at a calendar other than the current month.)
The weekdayheadercolor overrides the bgcolor for the weekday headers that appear at the top of the calendar if showweekdayheaders() is true, and weekendheadercolor does the same thing for the weekend headers. The headercolor overrides the bgcolor for the month/year header at the top of the calendar. The headercontentcolor(), weekdayheadercontentcolor(), and weekendheadercontentcolor() methods affect the color of the corresponding headers' contents and default to the contentcolor().
The colors of the cell borders may be set: bordercolor determines the color of the calendar grid's outside border, and is the default color of the inner border for individual cells. The inner bordercolor may be overridden for the various types of cells via weekdaybordercolor, weekendbordercolor, and todaybordercolor.
Finally, the color of the cells' contents may be set with contentcolor, weekdaycontentcolor, weekendcontentcolor, and todaycontentcolor. The contentcolor is the default color of cell content, and the other methods override this for the appropriate days' cells.
# Example:
$cal->bgcolor('white'); # Set the default cell bgcolor
$cal->bordercolor('green'); # Set the default border color
$cal->contentcolor('black'); # Set the default content color
$cal->headercolor('yellow'); # Set the bgcolor of the Month+Year header
$cal->headercontentcolor('yellow') # Set the content color of the Month+Year header
$cal->weekdayheadercolor('orange'); # Set the bgcolor of weekdays' headers
$cal->weekendheadercontentcolor('blue'); # Set the color of weekday headers' contents
$cal->weekendheadercolor('pink'); # Set the bgcolor of weekends' headers
$cal->weekdayheadercontentcolor('blue'); # Set the color of weekend headers' contents
$cal->weekendcolor('palegreen'); # Override weekends' cell bgcolor
$cal->weekendcontentcolor('blue'); # Override weekends' content color
$cal->todaycolor('red'); # Override today's cell bgcolor
$cal->todaycontentcolor('yellow'); # Override today's content color
print $cal->as_HTML; # Print a really ugly calendar!nowrap([1 or 0])
If set to 1, then calendar cells will have the NOWRAP attribute set, preventing their content from wrapping. If set to 0 (the default) then NOWRAP is not used and very long content may cause cells to become stretched out.
sharpborders([1 or 0])
If set to 1, this gives very crisp edges between the table cells. If set to 0 (the default) standard HTML cells are used. If neither value is specified, the current value is returned.
FYI: To accomplish the crisp border, the entire calendar table is wrapped inside a table cell.
cellheight([NUMBER])
This specifies the height in pixels of each cell in the calendar. By default, no height is defined and the web browser usually chooses a reasonable default.
If no value is given, the current value is returned.
To un-specify a height, try specifying a height of 0 or undef.
cellclass([STRING])
weekdaycellclass([STRING])
weekendcellclass([STRING])
todaycellclass([STRING])
headerclass([STRING])
These specify which CSS class will be attributed to the calendar's cells. By default, no classes are specified or used.
cellclass() is used for all calendar cells. weekdaycellclass(), weekendcellclass(), and todaycellclass() override the cellclass() for the corresponding types of cells. headerclass() is used for the calendar's header.
If no value is given, the current value is returned.
To un-specify a class, try specifying an empty string, e.g. cellclass('')
BUGS, TODO, CHANGES
Changes in 1.01: Added VALIGN to cells, to make alignment work with browsers better. Added showweekdayheaders(). Corrected a bug that results in the month not fitting on the grid (e.g. March 2003). Added getdatehref() and setdatehref(). Corrected a bug that causes a blank week to be printed at the beginning of some months.
Changes in 1.02: Added the color methods.
Changes in 1.03: More color methods!
Changes in 1.04: Added the "which weekday" capability to addcontent(), setcontent(), and getcontent()
Changes in 1.05: addcontent(), et al can now take strings such as '06' or decimals such as '3.14' and will handle them correctly.
Changes in 1.06: Changed the "which weekday" interface a bit; truncations such as "2Tue" no longer work, and must be spelled out entirely ("2Tuesday"). Added "plural weekdays" support (e.g. "wednesdays" for "every wednesday").
Changes in 1.07: Fixed a typo that caused an entirely empty calendar to be displayed very small.
Changes in 1.08: Re-did the bugfixes described in 1.05, handling padded and non-integer dates.
Changes in 1.09: Fixed the "2Monday", et al support; a bug was found by Dale Wellman <dwellman@bpnetworks.com> where the 7th, 14th, 21st, and 28th days weren't properly computing which Nth weekday they were so "1Monday" wouldn't work if the first Monday was the 7th of the month.
Changes in 1.10: Added the headercontentcolor(), weekendheadercontentcolor(), and weekdayheadercontentcolor() methods, and made content headers use bgcolors, etc properly.
Changes in 1.11: The module's VERSION is now properly specified, so "use" statements won't barf if they specify a minimum version. Added the vcellalignment() method so vertical content alignment is independent of horizontal alignment.
Changes in 1.12: Fixed lots of warnings that were generated if -w was used, due to many values defaulting to undef/blank. Added the sharpborders(), nowrap(), cellheight(), cellclass(), and weekdayheadersbig() methods. cellclass(), the beginning of CSS support. Thanks, Bray!
Changes in 1.13: Added more CSS methods: headerclass(), weekdaycellclass(), weekndcellclass(), todaycellclass(). Added a test to the module distribution at the urging of CPAN testers.
AUTHORS, CREDITS, COPYRIGHTS
This Perl module is freeware. It may be copied, derived, used, and distributed without limitation.
HTML::CalendarMonth was written and is copyrighted by Matthew P. Sisk <sisk@mojotoad.com> and provided inspiration for the module's interface and features. None of Matt Sisk's code appears herein.
HTML::CalendarMonthSimple was written by Gregor Mosheh <stigmata@blackangel.net> Frankly, the major inspiration was the difficulty and unnecessary complexity of HTML::CalendarMonth. (Laziness is a virtue.)
This would have been extremely difficult if not for Date::Calc. Many thanks to Steffen Beyer <sb@engelschall.com> for a very fine set of date-related functions!
Dave Fuller <dffuller@yahoo.com> added the getdatehref() and setdatehref() methods, and pointed out the bugs that were corrected in 1.01.
Danny J. Sohier <danny@gel.ulaval.ca> provided many of the color functions.
Bernie Ledwick <bl@man.fwltech.com> provided base code for the today*() functions, and for the handling of cell borders.
Justin Ainsworth <jrainswo@olemiss.edu> provided the vcellalignment() concept and code.
Jessee Porter <porterje@us.ibm.com> provided fixes for 1.12 to correct those warnings.
Todd <todd@marigoldtech.com> requested the weekdayheadersbig() method.
Bray Jones <bjones@vialogix.com> supplied the sharpborders(), nowrap(), cellheight(), cellclass() methods.
Bill Turner <b@brilliantcorners.org> supplied the headerclass() method and the rest of the methods added to 1.13