CX_props_calendar_text.txt CalendarX 0.5.3(dev) March 26 2005 (last modified for CalendarX 0.5.2) by +lupa+ (lupaz on sf.net, lupa at zurven dot com) Released under the GPL (see LICENSE.txt) Instructions for properties in CX_props_calendar. Significant rearranging of properties has taken place in the 0.5 branch from older 0.4 branch properties. Use the Properties tab to adjust the attributes of the property sheets for the calendar as available. === List of Attributes === title string Leave this title attribute alone. defaultView string Name of the default view to be displayed: month, weekbyday, weekbyhour, or day. dayOfWeekToStart int Value indicates what day of the week the Month and Week views begin on. Sunday = 0, Monday = 1, etc. dayViewStartHour string Hour of day for CalendarX to BEGIN display for day view and for weekbyhour view. 8 = 8am = 08:00, 20 = 6pm = 20:00. For a 24 hour calendar, set this to 0 (zero). dayViewEndHour string Hour of day for CalendarX to END display for day view and for weekbyhour view. 8 = 8am = 08:00, 20 = 6pm = 20:00. Must be later than dayViewStartHour. For a 24 hour calendar, set this to 24. hoursDisplay string Code to tell the "hoursdisplay" macro how to display the hours in your calendar views. Currently two possibilities and they only affect the left column display of hours: "12ampm" = 12 hour display, with am or pm. Ex. 6 pm "24.00" = 24 hour display, with period. Ex. 20.00 showHighlightFullEvent boolean If checked, CalendarX will show the full extent of Events on the calendar, even without rolling over with the mouse. Default is a blue color, can be changed in CSS property sheet. NOTE! If you use this, you might also want to disable the labelEventsOnlyAtStart property. Disabling labelEventsOnlyAtStart means that the events in the Month view that span several days will show labels for each of those days, instead of only on the first day of the event. labelEventsOnlyAtStart boolean Check this attribute to put labels on the month view ONLY on the first day of an event that lasts multiple days. Default is SELECTED. Unselect this attribute if you'd like the event title and datestring to appear on each calendar day that the event is on (ie., a four day event will have the label show up on the calendar four times, on each of the four days of the event). NOTE! Disabling this (to show events on EVERY day) will only work if the showHighlightFullEvent property is turned ON (selected). It would make no sense (to me) to have the event labeled, but not highlighted. So make sure you use these together. No harm if you don't, but it won't behave the way you might have expected. It pays to read the documentation. showOnlyEventsInMonth boolean Check this attribute to restrict the Month view to display events ONLY in the current calendar month, and NOT those events that occur in the days before or after the month begins and ends (ie., if the month view shows the 30th and 31st of the previous month on the calendar, events will NOT be displayed for those dates. useCalendarHelp boolean Check this attribute to show a View tab for "Calendar Help". This brings up a new view page that is intended for you to use for help in case you have neophyte users who could use some calendar help. I've added some code that brings up one page of help for "Members" and a different page of help for "Anonymous" users. This could easily be extended to show different help screens for other Roles. See the "help" view page template for more information. The help text is quite minimal, so feel free to expand it for your users. Feel free to send me a copy of your nice help files, too! useAdvancedQuery boolean If checked, CalendarX will use Dieter's AdvancedQuery product for making queries to the catalog to find events. Use this if you want to override those query methods in your skin folder. I find AdvancedQuery significantly easier to use in building complex queries, but it offers no other advantages for general use in CalendarX (ie., not faster). showSubjectBar boolean Deprecated in 0.5 branch. If checked, the Subject bar is shown, and if unchecked, it will disappear from view. Default is ON. Decomplicates the calendar if you don't want to use Public/Private or Subject categories. Recommend using calendarOptionsMacro choice below. calendarOptionsMacro string New in 0.5 branch. Default value: subjectlinks0 String to choose which macro is used to display options at the header of the calendar. There are several to choose from in the CX_props_macro; here is a brief listing of the pre-built ones: subjectlinks: the original, plus the new Users picker on the right side. Looks like the original if Users picker is not activated by the TALES command in showUserListExpression property. subjectlinks0 - blank subjectlinks: shows nothing, a clean calendar Good to use with portlet_cx_choices (the default choice). subjectlinks1 - only the subjects. subjectlinks2 - subjects on top row, others + Users in bottom row. subjectlinks3 - Users in right td, subjects top row, others bottom row. subjectlinks4 - Users in right td, others top row, subjects bottom row. showJumpToDateWidget boolean If checked, a date-picking widget will show up at the top and bottom of the calendar near the Next/Previous links. This widget lets users pick a date and jump to it, instead of using multiple Next, Next, Next click, or manually typing the date into the URL querystring. useNumericMonthInJumpToDateWidget boolean New in 0.5 branch. If checked, the month in the date-picking widget will show up as a number (1 for January, 2 for February, etc.). If unchecked, the months are abbreviated months as chosen by Pythons datetime month() function. Untested, but this may result in the month abbreviations to be rendered in the local language according to settings on the server. showPublicPrivateLink boolean If checked, the *Public* vs *My Events* link will be shown in the Subject Bar. This link allows users to switch between viewing all the published events, or ONLY their own private events. If your calendar is mainly for viewing by anonymous users, you probably don't need this. Default is OFF because this is a nice feature, but not a commonly chosen one. useMultiSubjects boolean If checked, the Subject category picker is a checkbox-style form, allowing users to select multiple subjects for viewing. If unchecked, it switches to (an older) single subject chooser that only allows one Subject category at a time. Default is ON for this new-style Multi-Subject chooser, because it is ever so much nicer. "USER PICKER" widget New for 0.5 branch. This is a new widget that shows a list of users and allows the calendar user to select from the list of users to show ONLY the events created by those particular users. There are currently four properties that control the behavior of the User Picker widget. There are currently two choices for how the users are selected for inclusion in this widget: all users that are "Creators" found in the portal_catalog, or a strict list of manually entered User names. #Uses a TALES expression which if it evaluates to True will #show a select widget to determine which USER's events will be shown #default is (false and isManager). change 0 to 1 for (true and isManager). showUserListExpression string New in 0.5 branch. Default value: python:1 and portal.portal_membership.checkPermission('Manage users', object) Determines whether or not the User Picker widget will be shown. This is a string property that requires a valid TALES statement, that is then evaluated to determine whether or not to show the User Picker. The default value is a simple one that ONLY displays the widget for site Managers. The "1 and" portion is completely useless, except that if you want to disable this feature for everyone, just substitute "0" for "1" in the TALES statement... and this lets you keep the rest of the statement there in case you need to use it sometime. The TALES statement is evaluated via a method defined in the CalendarXFolder.py code. useMultiUsers boolean New in 0.5 branch. Default value: True If selected, this enables you to select multiple Users in the User Picker widget for viewing. If unselected (false), then only one User may be shown in the calendar at a time. useListOfUsersForUserPicker boolean New in 0.5 branch. Default value: True If selected, the Users that show up in the User Picker will be only those listed in the listOfUsersForUserPicker property described below. If not selected, ALL Users that are listed in the portal_catalog as "Creators" will be shown in the User Picker widget. listOfUsersForUserPicker lines New in 0.5 branch. Default value: 3 This is the list of Users that will be shown in the User Picker widget if the useListOfUsersForUserPicker property is true. The default simply lists three ficticious user names to give you the idea. REMOVED: The following properties have been removed from CalendarX options in the 0.5 branch: 1. includeReviewStateVisible boolean 2. showPendingLink boolean Both of these options may be handled by options for displaying events now found in the CX_props_eventstoallow property sheet instead. MOVED TO OTHER PROPERTY SHEETS: The following properties have been MOVED from this property sheet to the new CX_props_eventstoallow property sheet instead. 1. listOfSubjects lines 2. restrictToThisListOfSubjects boolean 3. eventTypes list 4. restrictToThisListOfTypes boolean 5. listOfPaths list 6. restrictToThisListOfPaths boolean 7. restrictToThisFolder boolean 8. listOfSubjectTitles list 9. useSubjectTitles boolean