::. Installation

Click Here to view important information about upgrading from a previous version.

1) Unzip all of the files to a folder on your computer named escal and be sure to Restore the Original Folders.

2) Upload the files to a single directory called escal on your server while keeping the existing directory structure.

3) Set the file permissions for the showCalendar.php and config.inc.php files to 646. This is usually done by using a FTP program or your web host's site administration interface. If in doubt, please ask your web host for assistance.

4) In your web browser, go to http://www.yourdomain.com/escal/setup. Follow the on-screen instructions to enter the license information and to set up a user name and password for the Setup Manager.

5) Log in with the name and password that was set up during step 4.

6) If there are any warnings at the top of the page, please take the recommended steps to correct them.

That's it! The Easily Simple Calendar script is ready to use!

If you have any problems please visit our forum. Post your questions there and we can help!

>> IMPORTANT >> You must read this section or the calendar will not appear correctly!

> In order for the calendar to display as intended, make sure that the DOCTYPE is set correctly (the first line in PHP or HTML files). NOTE! For advanced users, most current doc types should work, including XHTML. The example below is just a recommendation. Feel free to use the doc type that fits your particular document and/or style.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">

> There must be a link to the CSS file in the header (just before the </HEAD> tag) of any pages that use the Easily Simple Calendar script. *Replace "escal/" with the actual path to the calendar scripts relative to the directory your scripts are in.

<?php $CSS=1; require ("escal/showCalendar.php"); ?>

> If you use the overLIB option*, make sure the code below is in the BODY section of your PHP pages that will use the Easily Simple Calendar script (preferably the first line below the <body> tag.
*
Replace "escal/" with the actual path to the calendar scripts relative to the directory your scripts are in.

<?php $OL=1; require ("escal/showCalendar.php"); ?>

Set the option to use the overLIB script to Yes using the Setup and Configuration script.

> And lastly, the page displaying the calendar script must be parsed by PHP. This usually means that the file name must end with .php unless your PHP installation has different requirements. Check with your web host provider if you are unsure.

> Not following these guidelines will result in the calendar displaying incorrectly in some browsers.

-- SEE THE FILE demo.php FOR AN EXAMPLE OF A CORRECTLY FORMATTED FILE --

*See the overLIB web site for more information and additional usage instructions.

::. Calendar configuration

To configure the calendar, in a web browser, go to http://www.yourdomain.com/escal/setup. You may need to adjust the path to the directory (escal/) according to where the files were uploaded to the server.

::. How to include the calendar on web pages

*Please see the section titled ">>Important<<" above. Your pages must be correctly formatted and include the proper code before the calendar will display as intended.

Once the necessary code is in place, all that is required to do to display the calendar on a web page is to use the PHP require command by placing the code below where the calendar should appear.
*Replace "escal/" with the actual path to the calendar scripts relative to the directory the page is in.

<?php require ("escal/showCalendar.php"); ?>

*The theme can also be changed "on the fly" from the one that is set in the Setup and Configuration Manger. To do this, at the top of the web page before the insert CSS code section, add <?php $showTheme="theme";?> where theme is the exact name (and case) of the directory containing the theme to display.

Note: If the script cannot find this theme, it will default to the one set in the Setup and Configuration Manager.

::. mySQL Setup

To use the Easily Simple Calendar Script with mySQL, first you need to set up a database. These instructions assume you already have a general understanding of setting up a database connection. If you need help with this, there are numerous tutorials online and your web hosting provider could be of assistance.

1) Edit the configuration settings and set the database parameters for your specific database connection.
NOTE: Every form field must be filled in and correct or the connection will not work!

2) Set Use a mySQL database for events to Yes then save your changes.

3) If you are directed to do so, execute the file setupSQL.php by clicking the link in the Warnings section of the Setup file or by typing in it's address in a web browser. This should set up the database connection and install the database. If there are errors, please check the settings in the Setup and Configuration Manager and try again.

4) Use http://www.yourdomain.com/escal/events to administer events. You can change the user name and password to log in by using the Setup and Configuration Manager. The default user name and password is escal for both.
You should change this from the default!

NOTE: It is highly recommended that you make regular backups of the database.

::. Flat File Setup

To set up the Easily Simple Calendar Script to use a flat-file database requires a few, simple steps.

1) Set the permissions for the database directory (in the escal directory) to 777.

2) Open the Setup and Configuration Manager (http://www.yourdomain.com/escal/setup).

3) Set Use a flat-file database for events to Yes.

4) Edit the filename or leave it as the default. This is the name of the file that is used to save the events and will be automatically created in the database directory (if it does not already exist).

5) Save your changes then close the Setup and Configuration Manager.

6) Use http://www.yourdomain.com/escal/events to administer events. You can change the user name and password to log in by using the Setup and Configuration Manager. The default user name and password is escal for both.
You should change this from the default!

NOTE: It is highly recommended that you make regular backups of the events file.

::. overLIB Setup

There are many options available to you in the Setup and Configuration Manager to customize the way the overLIB pop-ups will display.

In order to use these pop-ups, you must follow the instructions in the section titled ">>Important<<" above.

Most of the options should be self-explanatory, but a few special options are detailed below:

Sticky:
This option determines if the pop-ups are stationary and must be closed (default) or if they float with the cursor when it is moved. Try both options to see the effects.

Anchor:
Setting this option to Yes will cause the pop-ups to appear anywhere on the page where a special anchor is added. You can turn this feature on and view the demo.php file to see what it does.

To use this feature, you must add the following code to your page where you want to pop-ups to appear:

<a name="escOL">&nbsp;</a>

Pop-up offset X:
This setting determines how may pixels to the right of the cursor that the pop-ups will appear. This option has no affect if the Anchor option is enabled.

Pop-up offset Y:
This setting determines how may pixels below the cursor that the pop-ups will appear. This option has no affect if the Anchor option is enabled.

Fixed Position X and Fixed Position Y:
This setting will lock the position of the pop-up at a specific location on a web page. Setting these to 1 and 1 will cause the pop-ups to appear in the upper-left corner of the web page. This option has no affect if the Anchor option is enabled.

*See the overLIB web site for more information and additional usage instructions.

::. Customizations

To customize the calendar including table sizes, colors, fonts, graphics, etc., edit the esstyle.css file for the theme that you are using. Additional themes may be available under the Themes topic at the Easily Simple Calendar Forum.

Note: If you are unfamiliar with editing CSS files, there are many free CSS editors and tutorials to be found on the web.

You can also adjust the cell spacing, cell padding, the size of pop-up windows and more in the Setup and Configuration Manager.

::. Listings Module

The listings module will allow you to display events in a list-style format. You can add, edit, modify and remove the templates in the templates directory. These are the templates the listings module will use to produce it's output.

To include the listings on your page, you need the following code inserted where you want the listings to appear:
*Replace "escal/" with the actual path to the calendar scripts relative to the directory you are in.

<?php
$LIST=1;
$DF = "D - M d";
$template="monthly.php";
require
("escal/showCalendar.php");
?>

Change the $template variable to the name of another template you have created and uploaded to the templates directory.

Change the date format that is produced by altering the $DF variable. Use the same parameters as you would if using the PHP date() function. http://www.php.net/date.

OTHER OPTIONS:

There are other options available to your while using the Listings Module.

Add any of these variables just after $LIST=1;

If none of these options are added, the list will display all of the events for the current calendar month.

$listDays = x;
Lists 'x' number of days from Today.

$listWeeks = x;
Lists 'x' number of weeks from Today.

$listMonths = x;
Lists 'x' number of months from the currently displayed Month.

$listYear = x;
List all of the events for year 'x'.

$listEvents = x;
List the next 'x' number of events. You may also want to combine this with $listWeeks = 52; which will show the next 'x' events from today no matter what month is being viewed.

$noOld = x;
Setting 'x' to 1 will not show any event older than today, no matter what settings were used above.

::. Command-line variables

* NOTE: The event start ($es) and event end ($ee) command-line variables will not work when utilizing a mySQL or flat-file database.

There are two ways to use command-line variables:

The first way is used when loading the Easily Simple Calendar script directly in a web browser or via the PHP include function. After the full URL put a ? (question mark) before the first variable and put an & (ampersand) between each of the other variables you want to set. Do not use any spaces.

NOTE: You must call the full script URL address when sending command line variables via an include or require PHP function.

The second way, if using the Easily Simple Calendar script as a function, is to send each variable or set them as global within the function.

See http://www.php.net for help with functions and the include command.

mo
MONTH TO DISPLAY
mo=mm
Default: Current month if not specified

yr
YEAR TO DISPLAY
yr=yyyy
Default: Current year if not specified

es
START DATE OF DATE MARKING
es=yyyy-mm-dd
Default: None

ee
END DATE OF DATE MARKING
ee=yyyy-mm-dd
Default: None

To send multiple start and end dates, separate each date by an "x".
An example would be "?es=2004-10-05x2004-11-1&ee=2004-10-12x2004-11-8"
This marks Oct. 5, 2004 to Oct. 12, 2004 and Nov. 1, 2004 to Nov. 8, 2004.

The date can be sent in most any format as long as the month appears before the day. For example, to mark December 19, 2004 you can use "2004-12-19", "12-19-2004","Dec 19, 2004","December 19 2004", and more. If you want to mark a date regardless of the year, just omit the year like "12-19", or "Dec 19".

Examples:

http://www.yourdomain.com/demo.php?mo=12&yr=2004&es=2004-12-18&ee=2004-12-20
or include ("http://www.yourdomain.com/demo.php?mo=12&yr=2004&es=2004-12-18&ee=2004-12-20");
Either of these will result in a calendar for December of 2004 with the dates 12-18 through 12-20 being marked.

::. Getting Help

If you've followed all of instructions here and you still need a little help, or if you just have some questions about the script... Please visit our forum for all of your support needs at http://www.EasilySimpleCalendar.com/forums/.

::. Upgrades

:: Upgrading to Version 5.7 from Versions 5.0 - Version 5.6

  • Print our and/or back up your current configuration and CSS (if changed) files for reference.
  • Perform a complete install by following the instructions at the top of this page.
  • If using the flat-file database, move your existing database file to the database directory if is it not already there.
  • Run the Setup and Configuration Manager then setup your database connections and make any other changes.

:: Upgrading to Version 5.x from Version 1.0 - Version 4.5

  • NOTE: Version 5.x databases are NOT compatible with prior versions. All of your old data will be lost.
  • Perform a complete install by following the instructions at the top of this page.
  • Once the new script is set up and running, edit your pages according to these instructions.
  • Remove all of the previous Easily Simple Calendar files from your server.
  • Change your pages that use the Easily Simple Calendar to include the new file showCalendar.php. (It was escal.php)
© 2004 Easily Simple Calendar 5.6