Settings desc. - Calendarforum

Search
Go to content

Main menu:

Settings desc.

Functions > Misc.> > Admin> > Settings >
Calendar Settings - Description

The calendar settings which are automatically generated during the installation process are stored in the settings table of the database. All settings can be changed by the calendar administrator  via the Settings page in the administration drop down menu on the navigation bar at the top right corner  of the screen.
For those interested in technical details: The following are explanations of the PHP variables stored in the settings table of the database:
  • calendarTitle: The title of the LuxCal calendar that is displayed in the header of the various calendar views.
  • calendarUrl: The full URL address of the calendar, used for notification purposes, E.g. http://www.mysite.xxx/calendar/index.php.
  • calendarEmail: The sender's e-mail address ("From") in emails sent by the calendar. E.g. reminders, cron job summary reports. See also notifSender below.
  • backLinkUrl: URL of parent page. If specified, a Back button will be displayed on the left side of the Navigation Bar which links to this URL. For instance to link back to the parent page from which the calendar was started.
  • timeZone: Your local time zone. See the PHP Supported Time Zones for possible values. Setting the correct time zone is important for the "today" indication in the various views and when the "notification" feature is used.
  • notifSender: When the calendar sends reminder emails, the sender field of the email    can contain either the calendar email address, or the email address of the user who created the    event. In case of the user email address, the receiver can reply to the email.
  • rssFeed: If enabled: RSS feed links will be displayed in the calendar footer and will be included in the HTML head section.
  • navButText: If enabled: The buttons on the navigation bar will be displayed with text
  • navToapList: If enabled: A To approve list button will be displayed on the navigation bar for users with at least manager rights. The button can be used to display the list of events that need approval.
  • navTodoList: If enabled: A Todo list button will be displayed on the navigation bar, which can be used to display the Todo list.
  • navUpcoList: If enabled: An Upcoming button will be displayed on the navigation bar, which can be used to display the Upcoming Events list.
  • viewMenu: Specifies whether the view menu is displayed in the calendar's options panel. Possible values: 0 = disabled, 1 = enabled.
  • groupMenu: Specifies whether the user group filter is displayed in the calendar's options panel. Possible values: 0 = disabled, 1 = enabled.
  • userMenu: Specifies whether the user filter is displayed in the calendar's options panel. Possible values: 0 = disabled, 1 = enabled.
  • catMenu: Specifies whether the event category filter is displayed in the calendar's options panel. Possible values: 0 = don't display the category filter menu, 1 = display the category filter menu.
  • langMenu: Specifies whether the calendar users are allowed to select their preferred user interface language the calendar's options panel. Possible values: 0 = don't display the language selection menu, 1 = display the language selection menu.
  • viewButtons: View buttons to be displayed on the navigation bar (1:year, 2:month, 3:work month, 4:week, 5:work week 6:day, 7:upcoming, 8:changes)
  • defaultView: The initial calendar view to be displayed when the LuxCal Calendar is started. Possible values/views: 1 = Year, 2 = Full Month, 3 = Work Month, 4 = Full Week, 5 = Work Week, 6 = Day (today), 7 = Upcoming events and 8 = Changes.
  • language: The default user interface language. Only installed languages can be specified.
  • ownerTitle: When enabled, the event owner's name will be shown in front of the event title in the various calendar views (0:disabled 1:enabled).
  • privEvents: Can be disabled, enabled or default. If enabled: The user can choose to create private events, which are hidden from other users. If default: All events entered by a logged in user will default to private.
  • details4All: If disabled: event details will only be visible to the owner of the event and to users with 'post all' rights. If enabled: event details will be visible to the owner of the event and to all other users. If "for logged-in users": Event details will only be visible to logged-in users.
  • evtDelButton: If disabled: the Delete button in the Event window will not be visible. If enabled: the Delete button in the Event window will be visible, so all users with sufficient rights can delete events. If manager: the Delete button in the Event window will only be visible to users with "manager" rights.
  • eventColor: Specifies whether events should be displayed with the event owner color, or with the event category color (0: owner color, 1: category color)
  • xField1Label / xField2Label: The name of two optional free format text fields, which can be added to the Event window form and in all calendar views and pages. The specified name can be max. 15 characters long. E.g. 'Email address', 'Website', 'Phone number'.
  • xField1Public / xField2Public: Specifies if the respective extra field is visible to all users, or just to logged in users. Possible values: 0 = disabled, 1 = enabled.
  • selfReg: Indicates whether users can register themselves via the Log-in page. Possible values: 0 = self-registration disabled, 1 = self-registration enabled.
  • selfRegGrp: The ID of the group to which self-registered users are automatically assigned.
  • selfRegNot: Indicates whether a notification should be sent to the admin when a user has self-registered. Possible values: 0 = disabled, 1 = enabled.
  • restLastSel: Indicates whether the last user selections (the Option Panel settings) should be restored. When the user revisits the calendar at a later moment, these values will be restored. Possible values: 0 = not set, 1 = set
  • cookieExp: Number of days before a 'Remember me' cookie - set during Login - expires
  • evtTemplGen: Specifies which event fields should be displayed and in which order, on the general calendar views and pages.
  • evtTemplUpc: Specifies which event fields should be displayed and in which order in the Upcoming Events view.
  • popBoxFields: Specifies which event fields should be displayed in the pop-up box when hovering events.
  • popBoxYear: Specifies whether a pop up box with event details should be displayed in Year view when hovering an event.
  • popBoxMonth: Specifies whether a pop up box with event details should be displayed in Month view when hovering an event.
  • popBoxWkDay: Specifies whether a pop up box with event details should be displayed in Week/Day view when hovering an event.
  • popBoxUpc: Specifies whether a pop up box with event details should be displayed in Upcoming Events view when hovering an event.
  • yearStart: The start month in year view (1-12 or 0, 0: current month).
  • colsToShow: The number of months to show per row in year view.
  • rowsToShow: The number of 4-months rows to show in year view. The default value is 4.
  • weeksToShow: The number of weeks to show in month view. The value 0 (zero) has a special meaning and will result in the display of just one single full month. The default value is 10.
  • workWeekDays: A string of numbers which specify the days of the week to show in work month view and work week view. Valid day numbers are: 1 = Monday, 2 = Tuesday, ... , 7 = Sunday.
  • lookaheadDays: The number of days to look ahead in upcoming view, todo list and RSS feeds. The default value is 14 (two weeks).
  • dwStartHour: The start of the full time block on the day and week views. The default value is 6 (corresponding to 6:00am). This parameter helps to avoid wasting space for the nightly hours, where normally no, or very few, events are planned.
  • dwEndHour: The end of the full time block on the day and week views. The default value is 18 (corresponding to 18.00/6:00pm). This parameter helps to avoid wasting space for the nightly hours, where maybe no, or very few, events are planned.
  • dwTimeSlot: The time slot size (in minutes) in day/week view. Together with the dwStartHour (see above) this value determines the number of rows in day/week view.
  • dwTsHeight: The time slot display height (in number of pixels) in day/week view.
  • showLinkInMV: Specifies whether URL-links, specified in the description field or one of the extra fields (see xField1 and xField2 above) of the events, should be shown in month view (0: no, 1: yes)
  • monthInDCell: Specifies whether in month view in each day cell the three-letter month abbreviation should be displayed (0: no, 1: yes)
  • dateFormat: Text string defining the format of dates in dd, mm and yyyy. Possible characters: y: yyyy, m: mm, d: dd and any non-alphanumeric as separator.
  • MdFormat: Text string defining the format of dates in dd and month. Possible characters: d: dd, M: month in letters and any non-alphanumeric as separator.
  • MdyFormat: Text string defining the format of dates in dd, month and yyyy. Possible characters: d: dd, M: month in letters, y: yyyy and any non-alphanumeric as separator.
  • MyFormat: Text string defining the format of dates in month and yyyy. Possible characters: M: month in letters, y: yyyy and any non-alphanumeric as separator.
  • DMdFormat: Text string defining the format of dates in weekday, dd and month. Possible characters: WD: weekday in text, d: dd, M: month in letters and any non-alphanumeric as separator.
  • DMdyFormat: Text string defining the format of dates in weekday, dd, month and yyyy. Possible characters: WD: weekday in text, d: dd, M: month in letters, y: yyyy and any non-alphanumeric as separator.
  • timeFormat: Text string defining the format of times in hh and mm. Possible characters: h: hours, m: minutes, a: am/pm (optional), A: AM/PM (optional) and any non-alphanumeric as separator.
  • weekStart: The first day of the week. Possible values: 0 = Sunday, 1 = Monday.
  • weekNumber: Specifies whether week numbers should be displayed in the various calendar views. Possible values: 0 = disabled, 1 = enabled. The default value is 1.
  • mailServer: Specifies whether PHP mail or SMTP mail should be used for email reminders and periodic reports. Possible values: 0 = mail disabled, 1 = PHP mail, 2 = SMTP mail. The default value is 1.
  • smtpServer: Text string specifying the name of the SMTP server. For gmail this is for instance 'smtp.gmail.com'.
  • smtpPort: Specifies the SMTP port number. For example 25, 465, 587. Gmail for example uses port number 465.
  • smtpSsl: Specifies whether Secure Sockets Layer (SSL) should be used. Possible values: 0 = no, 1 = yes. Gmail for instance uses SSL. The default value is 1.
  • smtpAuth: Specifies whether authentication should be used when sending SMTP mail. Possible values: 0 = no, 1 = yes. Gmail for instance uses authentication. The default value is 1.
  • smtpUser: Text string specifying the SMTP user name. Required when SMTP authentication should be used.
  • smtpPass: Text string specifying the SMTP password. Required when SMTP authentication should be used.
  • adminCronSum: Specifies whether the calendar administrator will receive a summary    report after the periodic functions have been executed. Automatic periodic functions should be installed (see below) and emailing cron job output should be enabled on the server.
  • chgEmailList: A list with destination email addresses for calendar changes sent by the sendchg.php script. Automatic periodic functions should be installed (see below).
  • chgNofDays: The number of days the sendchg.php script (see previous variable)    should look back for calendar changes. If the automatic periodic functions have been installed (see below), this variable could be set to 1 (one day)
  • icsExport: Export events in iCalendar format to a .ics file in the 'files' folder. The file name is the calendar name with blanks replaced by a underscore. This function works via a cron job.
  • eventExp: The number of days after the event's due date when an event expires and will be automatically deleted (0:never). This function works via a cron job.
  • maxNoLogin: Indicates after how many 'no-login' days a user account should be automatically deleted. Possible values: 0 = never delete a user account, 1 - 365 = number of days. Automatic periodic functions should be installed (see below).
  • miniCalView: The calendar view for the LuxCal mini calendar. Possible values/views: 1 = Full Month, 2 = Work Month, 3 = Full Week, 4 = Work Week.
  • miniCalPost: Indicates whether events can be added, edited and deleted via the mini calendar without opening the full calendar. Possible values: 0 = posting of events disabled, 1 = posting of events enabled. The default value is 0.
  • popFieldsMcal: Specifies which event fields should be displayed in the hover box with event details in the mini calendar. Only fields which are also defined in the setting "evtTemplate" will be displayed. If no fields are specified, no hover box will be displayed.
  • mCalUrlFull: When clicking the month at the top of the mini calendar, to go to the full calendar, the user will be directed to this URL. If not specified, the full calendar will open in a new window. This URL is in particular useful when the full calendar is embedded in an existing user page.
  • popFieldsSbar: Specifies which event fields should be displayed in the hover box with event details in the stand-alone sidebar. Only fields which are also defined in the setting "evtTemplate" will be displayed. If no fields are specified, no hover box will be displayed.
  • showLinkInSB: Specifies whether URL-links, from the description field of the events, should be shown in the sidebar (0: no, 1: yes).
  • sideBarDays: The number of days to look ahead in the sidebar. The default value is 14 (two weeks).
 
Copyright 2015. All rights reserved.
Back to content | Back to main menu