File: README

NAME
	YCal - Yahoo Calendar Class

SYNOPSIS
	include ('class.ycal.php');

	// Constructors
	$ycal = new ycal("20030305");
	$ycal = new ycal("20030305", "Dinner at Mr. Biggs with Dipo");


DESCRIPTION
	The Yahoo Calendar class, is a link generating class for Yahoo Calendar
	events. It is useful for individuals who distribute schedule information
	either on the web or by email.

	You could for example, hyperlink an image with a description similar to:
	"Add Event to Yahoo Calendar". When this link is clicked on (provided 
	the user has a Yahoo account) the event can then be added to his/her 
	Yahoo Calendar.

EXAMPLES
	This example shows how the class can be used to send an email with 
	schedule information on a particular event.

	<?php

	include('class.ycal.php');

	$ycal = new ycal();
	$ycal->setDate("20030305");
	$ycal->setTitle("Staff meeting at Airport Hotel, Ikeja.");
	$link = $ycal->genLink();

	$message = "Dear Deji,\n\n";
	$message .= "Please be reminded of our staff meeting that is scheduled\n";
	$message .= "to hold on the 5th of March, 2003 ";
	$message .= "<a href='$link' alt='Add to Yahoo Calendar'>Add to Yahoo Calendar</a>";
	$message .= " at Airport Hotel, Ikeja.\n\n";
	$message .= "Thanks.\nManagement";

	$to = "[email protected]";
	$headers = "Content-Type: text/html";

	mail($to, "Staff meeting on 5th March, 2003", $message, $headers);

	?>

CONSTRUCTOR
	new ycal([DATE, [TITLE]]);
		This constructor is used to set the date and title of the event

		Both DATE and TITLE are of types "string"

METHODS
	setDate(DATE)
		Sets the date for the event. DATE is of type string and is of
		the format YYYYMMDD

	setTitle(TITLE)
		Sets the title for the event. TITLE is of type string.

	getDate()
		Returns the date for the event. Return type is string.

	getTitle()
		Returns the title for the event. Return type is string.

	genLink()
		Returns the generated url for the event. Return type is string

AUTHOR
	Tim Akinbo <[email protected]>