ACal 2.2 Manual

  1. Quick Installation
  2. Manual Installation
  3. Upgrading
  4. Troubleshooting
  5. Embedding
  6. More Information

Quick Installation

We at the ACal Project try to make your initial experience with the ACal calendar as enjoyable as possible. Here's some step by step instructions if you need help.
  1. Expand the downloaded file. (Example: ACal-2.0.tar.gz)
  2. Inside the new folder you'll find this manual and the license. If you want to know what you're getting into read the License and if not continue.
  3. Upload or copy the calendar folder to your web server.
  4. (If you are using Windows you can skip this part) Set the permissions of the calendar folder so that anyone can write to it. You can either use the chmod command or in Mac OS X using the Info panel. All good FTP client have a chmod feature as well.
  5. Go to it in your web browser and complete the installation by running the web based installer.
If you get any errors consult the Troubleshooting section.

Manual Installation

If you just can't get the installer to work or simply want to install by hand. Here's some information on how to accomplish that.
  1. Follow Quick Installation instruction up to step 4.
  2. Make a folder named data and one named uploads.
  3. Chmod if needed so anyone can write to the new folders.
  4. In the installer>contents folder copy style.css, vault.php, and version.php to your calendar folder.
  5. Chmod if needed to anyone can write to the 3 new files.
  6. Copy prefs.php to the data folder which is inside your calendar folder. Chmod it as well.
  7. Go to the calendar in your web browser.
  8. Click on the login link at the bottom.
  9. Do not fill in anything and press the Login button.
  10. Add a new user.
You should be done now. Note that after you add a new user you will no longer be able to login with a blank user name and password.

Upgrading

Currently to upgrade your calendar you will need to download the latest version and simply replace your old  calendar with the new one, except for the data folder and the txt files inside (prefs.php should be replaced), and your header and footer if you are using them.
A better solution is being developed where the calendar will be able to self-update.

Troubleshooting

Errors when installing

Make sure you set the permissions of the calendar folder so that anyone can write to it, by using chmod or your FTP client.
If it still doesn't work check whether or not you have safe mode turned on. If it is on you have to do a manual installation.

Embedding

Embedding the ACal calendar is getting better with each release. It is very easy and does not require much skill at all. Here's how to do it.

Using PHP:

 Before you try  embedding using PHP, take a look at the example in the example folder. Then follow these instructions.

In between the <head></head> tags copy and edit this code as needed:
<?php
    $view = "day"; // Can be month or day.
    $path = "path/to/calendar/"; // Relative or absolute path to calendar folder. Must have a trailing slash.
   
    // Do not edit the rest unless you know what you're doing
    echo '<link rel="stylesheet" title="Default" type="text/css" href="' . $path . 'style.css" />';
    if ($view == 'month' || isset($_GET['view'])) {
        echo '<script src="' . $path . 'e_edit.js" type="text/javascript"></script>';
    }
?>
You must edit the bold underlined text. Where it says day you can change it to month. And you must change the path to the real path to your calendar folder.

Then anywhere in the body, copy this code but do not edit it.
<?php
// DO NOT EDIT
if (!isset($_GET['view'])) {
    include $path . 'embed/' . $view . '.php';
}
else {
    include $path . 'embed/' . $_GET['view'] . '.php';
}
?>

Using Frames:

You can also combine the calendar with your web site using frames. Here's an example.
<frameset cols="100,*">
 <frame src="yourpage.html" name="main" />
 <frame src="path/to/calendar/" name="calendar" />
</frameset>

It will create a left frame 100 pixels wide and a right frame using the remaining space containing the calendar.

More Information

For more information see the following: