Download Now!
Documentation

Contents
1. Quick Setup Instructions
2. Before You Begin
2.1. Important Questions
2.2. Requirements
3. Installation and Setup
   3.1. Quick Setup
   3.2. Download
   3.3. Uncompress the Archive
   3.4. Modify Perl Scripts
   3.5. Transfer files to the web server
   3.6. Modify File Permissions
   3.7. Run the Admin Application
4. Troubleshooting Installation
5. Getting Started
   5.1. Basic Concepts
   5.2. Calendar Display Basics
   5.3. Calendar Admin Basics
6. Administrative Application
   6.1. Login Screens
   6.2. Events
   6.3. User Admin
   6.4. Calendar Options
   6.5. Global Options
7. Customization
   7.1. Display Templates
     7.1.1. Template Introduction
     7.1.2. Template Procecssing Flow
     7.1.3. Template Example
     7.1.4. Tag Syntax
     7.1.5. Special Calendar Tags
     7.1.6. Defined Variables
     7.1.7. Include Files
     7.1.8. Retrieving Events
     7.1.9. Template Debugging
     7.1.10. Advanced Notes
   7.2. Template Reference
   7.3. Customizing Admin Templates
   7.4. Language Translation
8. Plugins
   8.1. Concept
   8.2. What Plugins Can Do
   8.3. The Basics
   8.4. Adding Permissions
   8.5. Adding Admin Menu Options
   8.6. Adding and Overriding Templates
   8.7. Adding Custom Functionality
9. Advanced Usage
   9.1. SSIs
   9.2. Command-line
10. Security Considerations
   10.1. Changing File Locations
   10.2. Encrypted Passwords
   10.3. File Locking

Printer-friendly Documentation

Before You Begin


Important Questions
Before you begin setup, you must know the correct answers to several questions about your web server environment. If you cannot get the script to run, or you need support in debugging why errors occur, you must find the answers to all these questions. Debugging problems without know the answers to these questions is nearly impossible.

Most users will not need to make any changes to their web server, nor will they need to modify or edit the scripts themselves in any way. However, not every web server and setup is the same, so some people may need to rely on some of this information to get the script functioning in their environment.

Q: Does your web server support CGI scripts?
If the answer is no, you cannot use this program.

Q:In which specific directory, if any, does a CGI script have to be located?
The typical answer is the cgi-bin directory, although some web hosts use a different name and some have no requirement at all for where CGI scripts must be located.

Q: Does your web server support Perl 5?
If the answer is no, you cannot use this program.

Q: What is the full path to Perl5 on the server?
Typically this is /usr/bin/perl, and if you don't know the answer to this you can try it first to see if the default works. If anything fails, you will need to find out the exact answer to this question.

Q: Do perl CGI scripts need an extension of .pl or .cgi?
On most systems, the .pl extension works best. For some, the filenames must be changed to .cgi.

Q: What is the local filesystem path to the directory where the CGI scripts will be located?
This is different than the web path. For example, your scripts might be in /cgi-bin/ on your web server, but on the local hard disk, they might be located in /home/username/web/cgi-bin/ for example. Some web hosts have "virtual" paths for users when they FTP into the web server, so it may be difficult to determine the actual full path to the directory. If this is the case for you, you will need to contact your web host for more information. For most users, this will not need to be known ahead of time. If you encounter a specific error during setup, you will need to know the answer to this question.

Requirements
  • Perl5
  • A web server with CGI execution enabled
  • Cookies and Javascript enabled in your browser in order to run the Admin application
Home | Features | Demo | Pricing | Download | Documentation | Support
CalendarScript 3.21 ©Copyright 2003-07