Information in this help file pertains to: calweb.ini

Calendar configuration files

The primary way to change a calendar's configuration is through the browser interface using the edit calendar, merge calendar and lock calendar dialogs. Use these interfaces whenever possible because this method provides a lot of error checking. The settings you may edit through the browser interface are presented in the first table below.

In some cases you may wish to change a setting that is not available through a browser dialog. You may do this by opening the configuration file using a text editor such as notepad, pico or emacs. Items that may not be modified through the browser interface are detailed in the second table below.

The format of the configuration file

Each calendar stores its own calweb.ini file. Like old fashioned Windows config files it is broken up into sections by a bracketed '[SECTION_HEADER]'. Under each section header the various settings for that group are stored. A typical group might look something like this:


Important: For each setting; do not insert spaces between the end of the setting's name, the equals sign (=) and the beginning of the setting's value. Settings must reside on a single line. The program stops reading a setting as soon as it encounters a new line. Lines starting with a semi-colon ';' are commented and are ignored.

In the tables below:

  1. Boolean items (bool) may be set to '0' for false or non-zero (preferably '1') for true.

  2. Number items (number) may take on values in the range specified. Values outside the range are clamped.

  3. String items (string) may take on any value but must remain on a single line.

  4. Image items (image) may be a url to an image anywhere on the Internet or just a filename (such as file.gif). If it is just a filename the value of the 'image_base' setting is pre-pended to the filename.

  5. Values presented in the table [inBrackets] are the default value for the setting.

Values edited by a browser dialog

The settings presented in this first table are all edited using a browser dialog. Please use that interface to make changes to these values as there is extensive error checking done on those values.

Hand edit values

The settings in the following table are not available through any browser dialog. To change these items you must hand edit the calweb.ini file in each calendar folder.

Customizing images

You may wish to change the icons and images used in the program. You may do this most easily by switching the icon set on the edit calendar dialog. The icon set control switches the 'imagebase' setting to one of five alternative folders on the server.

You may create your own alternative icon set folder. Into this folder you may copy as many or as few of the following images as you wish. If the program finds a file by the same name in the alternative folder it uses that folder. If the file is not found the program looks into the $DOCUMENT_ROOT/cw_images folder. In this way you may modify only those files you wish to modify. Note that you may use a different imagebase for each calendar if you wish. You may, if you wish, customize particular images by settings its value explicitly, however this method is discouraged.

Customizing Menus

Any menu item may be customized by adding a setting under the [OPTIONS] section of the calweb.ini file. To do this simply add an item with the menu's name followed by either the text 'cmd' or 'prompt'. The 'cmd' setting is a Boolean value that, if false, means do not show that menu. The prompt item allows one to change the prompt for a menu. For example to hide the search menu enter


in the calweb.ini file. To change the menu's prompt to 'Find it' enter this value in the calweb.ini data:

	searchprompt=Find it

There are 27 menu items as follows:

Other considerations

A good way to edit these options is to open the calweb.ini file in an editor (such as notepad). Make and save changes without closing the editor. In a separate window open the browser to the calendar program. After each change hit the reload button on the browser to view the effect of your changes. Experiment with the options to learn what they do.