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:

	[GROUPNAME]
	setting_a=value_a
	setting_b=value_b

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:

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

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

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

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.

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 events], 2=add event, 3=edit events, 4=admin calendars."); "1-16", "The view presented when the calendar is opened or the user clicks on the default calendar icon ()

One of: 1=day list, 2=day grid, 3=day planner, 4=day report, 5=week list, 6=week grid, 7=week planner, 8=week report, 9=month list, [10=month grid], 11=month planner, 12=month report, 13=year list, 14=year grid, 15=year planner, 16=year report."); "1-4", "The minimum permission a user must have to edit this calendar. After all permission calculations are done the user must have at least this permission to make any changes to the calendar. Set this only in special circumstances, such as a single ADMIN only calendar in a large group of EDIT users, so as to avoid using permission-per-calendar. Note only values of 3, 4 or 5 have any effect.

One of: [0=none (means not set)], 1=view events, 2=add event, 3=edit events, 4=admin calendars."); "1-4", "If the minimum permission applies to a user this is the permission he/she will get if he fails to meet the minimum. Only applies if min_perms is set.

One of: [0=none (means not set)], 1=view events (default), 2=add event, 3=edit events, 4=admin calendars."); "0-2", "The header's alignment. Default is 2 - right align. One of: 0=left, 1=middle, 2=right."); "logo.gif", "The logo image to be displayed in the header."); homePage, "The web page linked under the 'logoimage'."); empty, "The width of the 'logoimage' (use internal width/height if not specified)."); empty, "The height of the 'logoimage'."); boolTrue, "If true a ruler is presented below the header."); empty, "The text of the header. You may not change this value until you register the software.

See also: replacement strings"); "0-2", "The footer's alignment. Default is 0 - left align. One of: 0=left, 1=middle, 2=right."); boolTrue, "If true a ruler is presented above the footer."); empty, "The text of the footer. You may not change this value until you register the software.

See also: replacement strings"); subject, category, location, status"; subject, status, priority, todo_age"; repCols, "The list of columns presented in the report views. Task list columns are: '" + taskCols + "'. See also recognized field names."); calMerge); empty, "A vertical bar (|) separated list of calendar paths merged into this calendar. Events from the calendars in this list are merged into this calendar."); "autobg", "The method by which merged events are colored. See calendar merge.

One of: [autobg], autotext, text, bg, textbg."); "0-3", "The color scheme used by the 'auto' options above. These are general color schemes wherein the software picks a reasonable set of colors.

One of: [0=medium colors], 1=dark colors, 2=light colors, 3=pastel colors"); "A vertical bar (|) separated list of text colors corresponding to the 'linked' list. Used by the 'text' and 'textbg' colorby modes only."); "A vertical bar (|) separated list of background colors corresponding to the 'linked' list. Used by the 'bg' and 'textbg' colorby modes only."); boolTrue, "If true a legend appears in the main table footer indicating the coloring of merged in events."); Note: This calendar locks out changes between certain dates."; boolFalse, "Enable or disable calendar locking feature.

If enabled and the remaining items are properly configured then non-admin users are limited in their ability to change the calendar during the lock period(s)."); "0", "For Lock I only, ignored if lock_out is false.

The number of minutes prior to the lock calculation time. Negative values mean after the lock calculation time.

Lock calculation time depends on the value 'lock_before_snap'. See calendar lock form."); boolTrue, "For Lock I only, ignored if lock_out is false.

If '0' then lock calculation time is current time. If '1' then lock calculation time is midnight of the current day (that is 12:00am the next morning)."); boolFalse, "For Lock I only, ignored if lock_out is false.

If checked then the lock period is open for addition of new events and editing of existing events under certain conditions. New events may be added during the lock out period if this option is set. Existing events may be edited if that edit would not shorten the event nor move the event into the past or outside of the lock period. Deletion of events is disallowed."); _changeday",boolFalse, "For Lock I only, ignored if lock_out is false and lock_allowed is checked.

If checked then edits of existing events must not change the date of the event."); "0", "For Lock II only, ignored if lock_out is false.

The number of minutes after midnight of the current day (that is 12:00am this morning - i.e. last night) after which to set the lock. Negative number reverse the calculation."); boolFalse, "Ignored if lock_out is false. Exclusive other the two locks this locks the calendar after 12:00am Saturday morning and before 11:59pm Sunday evening."); lockMsg, "Ignored if lock_out is false. String displayed in the footer of the main calendar body."); dynoEdit); empty, "A comma separated list of dynamic include events to include in the calendar."); boolFalse, "If true the calendar operates as a scheduler, meaning no two events may occur at the same time."); empty, "Useful only if 'scheduler' is true, this item further refines the scheduling function. For example if 'reslev' equal to 'location' means 'no two events occur at the same time in the same place'.

One of: empty, category, priority, location, status, userdrop1, userdrop2, userdrop3, userdrop4."); boolFalse, "If true users with the same permission may edit or delete items created by other users with that permission, otherwise two such users may not edit each other's events (the default)."); "super", "Permission level needed to see the 'Change owner' control on the event edit dialog.

One of: none, anyone, admins, [super]"); boolTrue, "Allow/do not allow users to review each other's events."); "FFFF", "Each of the four viewtypes (grid, list, planner and report) has a corresponding character (nibble) in this hexadecimal string.

Each bit in a particular nibble controls the periods for that viewtype (day, week, month and year). The first bit of each nibble controls day, the second bit controls week, and so on.

Turn on and off menu choices by setting each bit in each nibble."); boolTrue, "Display menus vertically, otherwise horizontally."); boolFalse, "Hide/show login related menu items. Use this to hide logging in from end users."); boolFalse, "Hide/show history command on the main menu. History command is off by default."); "bdehw", "Indicates which history event type to include if enabled: b=birthdays, d=deaths, e=events, h=holidays, w=weather. Include any combination."); "1-[12]-24", "The number of hours to show in the day grid and planner views."); "5-[60]-unlimited increments of 5", "The number of minutes in each period in day grid and planner views. Coordinate this with durations."); "0-[7]-23", "The first hour to display in day grid and planner views."); boolFalse, "If true display the week grid view as all vertical boxes."); boolFalse, "If true show weekends in minimal manner on month grid view."); boolFalse, "If true display list view in verbose mode by default."); boolTrue, "Show/hide expand icon () or collapse icon () on day grid, planner, list, report, tasks and contact list views, otherwise hide these icons so user may not see expanded hours."); empty, "If true split planner view by given resource. Please see resource planner help file."); boolTrue, "If true hide events with 'No Value' in plansplit dropdown field, otherwise show such events. Please see resource planner help file."); boolTrue, "If true show calendar dropdown on all screens where appropriate, otherwise do not show the calendar dropdown."); boolFalse, "If true present owner/editor information on event review screen and list views, otherwise do not show."); 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

	[OPTIONS]
	searchcmd=0

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

	[OPTIONS]
	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.