LuxCal Event calendar

I have downloaded LuxCal for database type:

MySQL

SQLite

Table of Content

1. Installation of Updates

2. New Installation

   1. Requirements

   2. Before You Start

   3. Installation Steps

   4. Configuring / Customizing the Calendar

   5. My Calendar doesn't Work

3. Calendar Configuration

   1. LuxCal Version Number and Database Parameters

   2. Automatic Periodic Functions

   3. Installing a New Language

   4. Creating Context-Sensitive Help

   5. Using SMTP Mail for Reminders and Reports

   6. Configuring / Customizing Stand-alone Displays

   7. Configuring / Customizing PDF Printouts

4. Installing Additional Calendars

   1. Calendars with an Individual Database

   2. Calendars Sharing the Same Database

5. Switching from a MySQL to an SQLite database and Vice Versa

6. Adding the Calendar to an Existing Web Page

   1. Link to the Calendar

   2. Add a Sidebar with Upcoming Events

   3. Embed a Stand-alone Display

   4. Embed the Full Calendar

   5. Embed One Specific Calendar View Without Navigation Bar

   6. Embed a so-called Calendar "Display"

   7. Applying Filters to the Calendar

   8. Single Sign On (SSO)

1. Installation of Updates

To upgrade to a new version of the LuxCal Event Calendar follow the instructions in the file "release_notes_luxcal_xxx.html" (where xxx is the calendar version number).

2. New Installation

a. Requirements

For the installation of the LuxCal Event Calendar on the server of your hosting provider, you will need:

• A web accessible folder on a web server to install the LuxCal files.

• The web server should be able to run PHP-scripts (PHP 5.4 or higher).

• A MySQL database on the web server to store the LuxCal Event Calendar data.

b. Before You Start

c. Installation Steps

To install the LuxCal Event Calendar on the server of your hosting provider, follow the next steps:

1. Download and unzip the latest version of LuxCal (file: luxcalxxx.zip, where 'xxx' is the calendar version number) in a temporary location. This file contains the following compressed files: luxcalxxx-calendar.zip and luxcalxxx-toolbox.zip. Unzip the file luxcalxxx-calendar.zip and upload all files and folders to a web accessible folder on the server where you wish to install LuxCal. Keep the luxcalxxx-toolbox.zip file for possible later use.

2. With your Web browser browse to the folder of the LuxCal installation; this will redirect you to the installxxx.php script ('xxx' is the calendar version number) and show the Installation page.

3. On the Installation page read the instructions and enter the calendar and administrator details and select "test" If all tests pass successfully, select "install/save". The script will create the necessary tables in the database and saves your LuxCal version number and the database parameters in a file called lcconfig.php in the calendar's root folder. The script will create the SQLite database in the specified folder with the necessary database tables and saves your LuxCal version number and the database parameters in a file called lcconfig.php in the calendar's root folder.

4. Launch the calendar by browsing to the calendar's URL to ensure the calendar displays properly.

5. Keep a backup copy of the lcconfig.php file. It contains the LuxCal version number and the parameters for the database.

Note: The file luxcalxxx-toolbox.zip (see step 2 above) contains the LuxCal tools which should be kept for later use and which should be uploaded to the calendar root folder only when needed.

d. Configuring / Customizing the Calendar

The Settings page in the administration menu on the navigation bar can be used to easily change the calendar's configuration settings which are stored in the settings table of the database. These settings, for instance, define the calendar title, the time zone, the language file to be used for the user interface, the default initial view when the calendar is started, the number of weeks/months displayed in the various views, the date and time format, and many other things.

IMPORTANT: Currently the TimeZone is set to "Europe/Amsterdam". If you are in a different time zone, change the TimeZone to your local time zone. See the PHP Supported Timezones for possible values.

The user interface style (colors, fonts, etc.) can be customized via the UI-Styling page in the administration menu. See the admin_guide.html, section "User Interface Styling" for further instructions. This can be particularly useful when the calendar is embedded in an existing web page and should match the style of the parent web page.

e. My Calendar doesn't Work

The most frequent problems:

• PHP parse error when starting the calendar

  This error occurs when the version of the PHP installation on your server is too low (see Requirements above). PHP parse errors are normally logged in a log file on the server. The location of this log file varies per provider. Ask your provider how to upgrade to a higher PHP version.

• The calendar shows a blank page

  Often this problem is caused by the fact that the calendar cannot connect to the MySQL database, for instance when the database parameters (username, password or database name) are not correct. The database parameters are stored in the file lcconfig.php in the calendar root folder.

  Often this problem is caused by the fact that the calendar cannot connect to the database, for instance when the SQLite database file is not present or cannot be accessed.

  This error also occurs when the version of the PHP installation on your server is too low (see Requirements above). In this case syntax errors may occur, which are logged in a log file on the server. The location of this log file varies per provider. In this case ask your provider how to upgrade to a higher PHP version.

• When logging in your name is not displayed at the right top of the window

  When logging in, for instance as administrator, your name should appear in the right upper corner of the calendar window. Sometimes this doesn't happen. This problem occurs when 'sessions' are not enabled, or not working, in the PHP installation on your server. This problem also occurs when cookies are not enabled in your browser. Contact LuxSoft if you are not sure how to solve this.

With the lctools.php script, which you can find in the LuxCal toolbox, you can check if your LuxCal calendar installation is ready for use or to further analyse above problems.

3. Calendar Configuration

a. LuxCal Version Number and Database Parameters

During the LuxCal installation process a file called lcconfig.php is created and stored in the root folder of the calendar. If, when launching the calendar, the file lcconfig.php is not present in the calendar's root folder, it is assumed the calendar has not yet been installed and consequently the calendar's installation script will be started.

The file lcconfig.php contains the following data (in the form of PHP variables):

• lcV: The version number of the LuxCal installation. For example "4.5.0M". This version number is used by the calendar to check if the current calendar installation is up-to-date with the installed calendar files and to determine if the upgrade script should be run.

• dbType: The type of database used by the calendar. This can be either MySQL or SQLite.

• The following database parameters:

  • host name: This is the name of the database server and is often called "localhost".

  • user name: The database user name is the user name required to connect to the database. This user name was chosen when the database was created on the server of your ISP. Note: This user name should not be confused with the admin's user name to log in to the calendar!

  • password: The database password is the password required to connect to the database. This password was chosen when the database was created on the server of your ISP. Note: This password should not be confused with the admin's password to log in to the calendar!

  • database name: This is the name of the database on the database server which will be used by the LuxCal calendar to store all its data. The calendar data is stored in the following tables: events, users, categories and settings.

  dbDir: The name of the folder where the calendar database files are stored, relative to the calendar root folder.

• dbDef: The default calendar. When multiple calendars are installed and no calendar is specified in the calendar URL, then this default calendar will be opened.

• dbSel: This parameter specifies whether, in case of multiple calendars, a calendar selection menu should be present in the calendars Option Panel (for the admin only).

b. Automatic Periodic Functions

The following automatic periodic functions are available:

• Email / SMS notifications for event due dates
• Daily email messages with calendar changes
• Daily export of events in iCalendar format
• Automatic deletion of expired events
• Automatic deletion of expired (unused) user accounts

To make the automatic periodic functions work, a cron job needs to be created on the server (or on an external server), which executes the file lcalcron.php, in the root folder of the calendar, daily at approx. 2:00am. For cron job details see the header of the lcalcron.php file.

If you are not familiar with cron jobs, ask your hosting provider for help. A general description of how to define a cron job can be found in the header of the file 'lcalcron.php' in the calendar root folder.

- The Email / SMS Notification Feature

For events entered in the calendar the user can choose to send an email and/or SMS reminder (notification) directly or one or several days before the event is due. For a more detailed description of this feature, see the admin_guide.html

This feature should be configured on the admin's Settings page in the section Reminders.

In the Reminder's subsection General you can specify the default recipients list, shown when creating events. If the list is left blank, the default recipient will be the event owner.

In the Reminder's subsection Email, the various values and parameters needed to be able to send email notifications can be specified.

In the Reminder's subsection SMS, the various values and parameters needed to be able to send SMS notifications can be specified. The first thing required to be able to use the SMS service, is to find a provider, which offers a mail-to-sms service, meaning that an SMS can be sent by sending an email with the SMS data to the provider. The layout of the provider's email address to be used should be for example: {free text 1}{recipient mobile phone number}{free text 2}@mail2sms.com. On the Settings page this layout is defined by the SMS carrier template. With some providers it is possible to add some special text with the sender ID (normally the mobile phone number) to the email's subject field; this can be achieved on the Settings page by completing the SMS subject template.

- Receiving Calendar Changes by Email

In a multi-user environment it could be useful to be aware of changes being applied to the calendar content, i.e. a list with events added, edited and deleted. Such a list can be called up via the options panel. It is however also possible to have a list with changes automatically sent daily to one or more email addresses.

Via the Settings page the administrator can specify the number of days to look back for changes and a list with email addresses. If the number of days to look back for changes is set to 0 (zero), no emails with changes will be sent.

- Daily Export of Events in iCalendar format

When enabled on the admin's Settings page, each day a file in iCalendar format (.ics extension) will be created in the 'files' folder with all events occurring in the time range -1 week until +1 year. These files can be imported by other calendar applications. The name of the file is the calendar name with the characters ' ','/','\','?','*',':',';','{','}' replaced by an underscore and diacritics removed. A new file will overwrite the previous one.

- Automatic Deletion of Expired Events

Events which due date has past can automatically be deleted. Via the Settings page the administrator can specify the number of days after an event's due date when an event will automatically be deleted. If the number of days is set to 0 (zero), no events will be deleted.

Note: deleted events are flagged "deleted"; definitively removing deleted events from the database is done via the admin's Database page.

- Automatic Deletion of Expired (unused) User Accounts

The account of users who have not logged in during a certain number of days can automatically be deleted. Via the Settings page the administrator can specify the number of 'no login' days after which the user account will be deleted. If the number of 'no login' days is set to 0 (zero), no user accounts will be deleted.

This function can be particularly useful when users are allowed to self-register (this feature can be switched on/off on the admin's Settings page).

c. Installing a New Language

= Note: in the following text the part {language} (including the braces) of the file names represents the name of the relevant language. =

A new language for the user interface of the LuxCal calendar can be installed as follows:

• Download and unzip the desired language pack from the LuxSoft site.

  If your language pack is not available:

  • translate the files lang/ai-english.php and lang/ui-english.php (translate the texts to the right of the => signs) and save the files with the names ai-{newlang}.php and ui-{newlang}.php respectively.
    Use character encoding utf-8 without BOM (see note below).

  • translate the file lang/ug-english.php (leave the html tags unchanged) and save it with the name ug-{newlang}.php.
    Use character encoding utf-8 without BOM (see note below).

• upload the files ai-{newlang}.php, ui-{newlang}.php and ug-{newlang}.php to the lang/ folder on the server.

• on the Settings page (see Calendar Configuration Settings in Section 4 below), change the user interface language in the Calendar Settings to the new language.

• if the user interface language menu is displayed in the calendar's options panel, the new installed language will automatically be added to the menu.

IMPORTANT NOTE: When using special characters (e.g. accents) in the language files, the ui and ug files can best be saved with character encoding: utf-8 without BOM (BOM = Byte Order Mark). If your text editor does not support utf-8 without BOM, you can download and use Notepad++ (Notepad++ on Sourceforge). This is an excellent free text editor!

d. Creating Context-Sensitive Help

Each calendar page has a Help option in the side menu which can be opened via the hamburger button in the right upper corner of the calendar. If no context-sensitive help is available, selecting Help will open a window with the general Help information. If however context-sensitive help information is available, dedicated help for the current calendar page will be shown.

For each calendar page context-sensitve help information can be created in a file which is stored in the calendar's help folder. The file name contains the associated calendar page number (see "(pn)" below) and the language (see "(lang)" below); it should take one of the following formats:

• ug-(pn)-(lang).html
• ug-(pn).html

A list of possible calendar page numbers can be found at the end of this section.

The calendar's help function will search the "help" folder for a file in the order given above. So for example, if the current page is Month view and the current user interface language is English, it searches for "ug-02-english.html" and if not found it will search for "ug-02.html". If no context-sensitive help file is found, the general help file "ug-english.php" from the "lang" folder will be displayed.

If the language is omitted in the file name, the file will be used whatever user interface language is active.

So for example the file "ug-02-english.html" contains the help information for the calendar's Month view page in the English language.

The context-sensitive help files may contain HTML-code. The file should contain the HTML code which is normally placed between the <body>-tags of an HTML file (not the body-tags themselves). The calendar's styles sheet will be applicable.

Examples of context-sensitive help files can be found in the calendar's "help" folder.

Possible calendar pages and numbers:

01: Year view
02: Full Month view
03: Work Month view
04: Full Week view
05: Work Week view
06: Day view
07: Upcoming view
08: Changes view
09: Matrix view (categories)
10: Matrix view (users)
20: Login page
21: Account page
22: Search page
23: Contact Form page
24: Thumbnails page
30: Event Add window
31: Event Edit window
32: Event Report window
39: User Guide
80: Settings page
81: Categories page
82: Users page
83: User Groups page
84: Database page
85: User Import page (CSV file)
86: User Export page (CSV file)
87: Event Import page (iCal file)
88: Event Export page (iCal file)
89: Event Import page (CSV file)

e. Using SMTP Mail for Reminders and Reports

Reminder emails and email reports (triggered by a cron job) are sent by default via the PHP mail system. If however, email authentication is required, the admin can choose on the Settings page, under General, to use an SMTP mail server.

Before choosing SMTP mail on the admin's Settings page, the following SMTP mail server parameters must be specified on the Settings page:

• SMTP server address
• SMTP port number (often port 25 or, if SSL enabled, 465.
• SSL (Secure Socket Layer) enabled/disabled
• SMTP server user name
• SMTP server password

Note: TLS (Transport Layer Security) is not supported.

If you don't know what parameters to use, ask your mail provider for the correct parameters.

Example: To use a gmail SMTP server with your "my.mail@gmail.com" email address, the SMTP settings on the Settings page should be as follows:

• SMTP server address: smtp.gmail.com
• SMTP port number: 465
• SSL (Secure Socket Layer): enabled
• SMTP server user name: my.mail
• SMTP server password: mygmailpassword

The tool called "smtptest.php", which you can find in the LuxCal toolbox, can be used to test the SMTP settings specified on the Settings page.

e. Configuring / Customizing Stand-alone Displays

When using a stand-alone display (see section 6c hereafter) the used display has a number of default configuration settings, which can be tailored to your needs. In the file displays.html in the calendar's "configs" folder you will find detailed instruction of how to tailor the configuration settings when using one or more displays.

e. Configuring / Customizing PDF Printouts

PDF printouts in A4 and A5 format can be produced from the calendars side menu and from stand-alone displays (see section 6c hereafter). Each PDF printout format has a number of default configuration settings, which can be tailored to your needs. In the file pdfs.html in the calendar's "configs" folder you will find detailed instruction of how to tailor the configuration settings for the PDF printouts.

4. Installing Additional Calendars

IMPORTANT NOTE:: When multiple calendars are installed within one LuxCal software installation, these calendars will be fully independent. However, since the thumbnails of all calendars are installed in the same "thumbnails" folder and the names of thumbnail images managed via the Thumbnail Images page are prepended with the user ID of the user who uploaded the thumbnail, users with the same user ID in each calendar will see and be able to delete each others thumbnail images.

5. Switching from a MySQL to an SQLite database and Vice Versa

The LuxCal calendar is available in two flavors: 1) using a MySQL database and 2) using an SQLite database. The functionality of both is fully identical; so the calendar user will notice no difference between both versions.

The technical differences between both versions can be summarized as follows:

The SQLite database is held in a separate single file at a location of your choice. No set up or administration is needed. During the installation, just tell the calendar where to store it and what name it should be given and that's all there is.
When running multiple calendars, each individual calendar will have its own database file, which name corresponds to the calendar ID. So handling the individual databases is really easy; just a matter of copying, moving, renaming, or whatever.

The MySQL database is running on a (maybe virtual) database server installed by your ISP. Before installing the calendar, you will have to create the database, using tools provided by your ISP.
The database is defined by host (db server) name, user name, password and database name.
When running multiple calendars, each individual calendar has its own set of database tables in the same MySQL database. For each calendar, the relevant set of tables has a unique name (the calendar ID) prefixed to each database table. Handling the individual databases can only be done via software tools.

6. Adding the Calendar to an Existing Web Page

To use the calendar on an other web site, the following possibilities are available:

• link to the calendar's URL, which will open the calendar in a new page.

• Add an Upcoming Events Sidebar. This light-weight list shows all public events for the coming x days.

• embed a mini calendar, which can be used to view events and - if enabled by the admin - add, edit and delete events.

• embed the full calendar with navigation bar, which the visitor can use to change the options the calendar.

• embed one specific calendar view without navigation bar. The visitor cannot navigate to other views and cannot change the options of the calendar

a. Link to the Calendar

To link to the LuxCal calendar in an existing web page and open it in a new window, the following HTML code can be used:

<a href="http://www.mycalsite.xx/luxcal/" target="_blank">Go To My Calendar</a>

If you want to display a subset of the available events, see "Applying Filters to the Calendar" below.

b. Add a Sidebar with Upcoming Events or ToDo list

A sidebar with public upcoming events or a ToDo list for the coming x days can be added to your web page. The sidebar is placed in a <div>-tag container, can be placed at any location and is fully customizable. An example is shown on the LuxCal Demo page of the LuxSoft web site. The sidebar can be added to your web page by adding the following lines of code to the <head>-section of your web page:

<link rel="stylesheet" type="text/css" href="mycalendarfolder/css/css_sbar.php"> <script type="text/javascript" src="mycalendarfolder/common/toolbox.js"></script>

and adding the following lines of code to the body of your web page:

<?php $sbClass = {sidebar class}; * $sbCal = {calendar ID}; * $sbContent = {sidebar content}; * $sbHeader = {sidebar title}; * $sbEvtHead = {event layout}; * $sbGroups = {list of user groups for which events to show}; * $sbUsersIn = {list of users to include}; * $sbUsersEx = {list of users to exclude}; * $sbCats = {list of event categories to show}; * $sbMaxNbr = {max. number of events to show}; * $sbUpDays = {max. number of days to show}; * $sbWeekDay = {week day for which events to show}; * $sbRec1x = {show only the next recuriing event}; * include './mycalendarfolder/lcsbar.php'; ?>

* These parameters are optional and can be omitted. See explanation hereafter.

Explanation of the lines of code:

All parameters indicated by {....}, including the braces, are text strings between single or double quotes.

• <?php: start PHP and ?>: end PHP. If the lines of code are added to a PHP section, these PHP-tags can be omitted.
• $sbClass: This is the class of the container <div>-tag which is used in the CSS to define the style for the sidebar container. This line of code is optional and will default to 'sideBar'. The styles for 'sideBar' are defined in the file css/css_sbar.php of your calendar installation.
• $sbCal: This is the calendar ID, which is the prefix to be used for the MySQL database table names. If not specified, the prefix will be taken from the file lcconfig.php, which was specified during the calendar installation.
  $sbCal: This is the name of the calendar database file (without extension) to be used. If not specified, the default calendar from the lcconfig.php file will be taken.
• $sbContent: This variable defines the content of the sidebar. If its value is 'todo', the sidebar will show the ToDo list, which is a list with events requiring an action. In this case an interactive checkbox is displayed in front of each event which can be checked/unchecked by each visitor. This line of code is optional and when omitted the sidebar content will default to the upcoming events list.
• $sbHeader: The title of the sidebar. This line of code is optional. If not specified, the title of the sidebar will be taken from the language files.
• $sbEvtHead: A template specifying the layout of the events in the sidebar. The template contains a string of keys (# followed by a character) and literal characters. Each key will be replaced by the corresponding event value and each literal character will remain unchanged. The following keys are allowed: #e: event title, #c: event title - category color, #u: event title - owner group color, #o: event owner, #a: age, #/: new line. When the key #a is used, it will be replaced by the age of a person if the following two conditions are met: 1) The event category has "Repeat" set to "every year" and 2) In the event's description field somewhere a year of birth in parentheses is present, e.g. "(1997)". The |-character can be used to create an "age" section. If within two |-characters the #a key evaluates to an empty string, the whole section will be removed. Example: "#c| (#a)|" could result in "See my dentist", but also in "Jane's birthday (27)". This line of code is optional. If not specified, the default layout template will be '#c| (#a)|'.
• $sbGroups: This is a list with one or more user group ID numbers (see admin's User Group page) for which events should be included in the sidebar. The ID numbers should be separated by commas. This line of code is optional. If not specified, the events of all user groups will be included.
• $sbUsersIn: This is a list with one or more user ID numbers that should be included in the sidebar (for user IDs see admin's Users page). The ID numbers should be separated by commas. This line of code is optional. If not specified, the events of all users will be included.
• $sbUsersEx: Same as above, but for users to be excluded (for user IDs see admin's Users page). If $sbUsersIn is specified, $sbUsersEx will be ignored.
• $sbCats: This is a list with one or more event category ID numbers (see admin's Categories page) that should be included in the sidebar. Just the value 0 (zero) means 'show all event categories'. The ID numbers should be separated by commas. This line of code is optional. If not specified, all event categories will be included.
• $sbMaxNbr: Maximum number of events to show in the sidebar.
• $sbUpDays: Maximum number of day to show. If not specified, the number of "Days to look ahead in sidebar" from the admin's Settings page will be taken
• $sbWeekDay: The week day for which events should be shown. 0 = Sunday, 1 = Monday, . . . 6 = Saturday. If specified, the $sbUpDays (see above) will automatically be set to 1. If not specified, events will be shown for all days of the week.
• $sbRec1x: Enable/disable 'show only the next recurring event'. 0 = disable, 1 = enable. If enabled, the first occurrence of a recurring event will be shown while subsequent occurrences will be suppressed.
• include: At this place the sidebar code will be included.

In the above lines of code you should replace mycalendarfolder by the name of the root folder of your calendar installation.

The file css_sbar.php contains the default style for the sidebar container <div>, which should be tailored to your needs. In the same file you can customize the style, colors, fonts, etc. of the sidebar content. The title of the sidebar can be set per sidebar and the events in the sidebar can be filtered on the event sequence number and/or user ID. This allows for more than one sidebar per site, each with its own title and a different list of events.

Example of two sidebar definitions for the same website which are complementary:

<?php $sbClass = 'sideBar1'; $sbHeader = 'Birthdays/Holidays'; $sbCats = '2,4'; include './mycalendarfolder/lcsbar.php'; ?> <?php $sbClass = 'sideBar2'; $sbHeader = 'All other events'; $sbCats = '1,3,5'; $sbUpDays = '7'; include './mycalendarfolder/lcsbar.php'; ?>

For each event the following will be displayed: date, time and title. Via the admin's Settings page, under "Stand-Alone Sidebar", you can choose whether further event details should be shown in a pop-up box (like in the full LuxCal calendar) when hovering an event and if URLs from the event description (if any) should be displayed in the sidebar as a hyperlink. On the same Settings page you can specify the number of days to look ahead for events in the sidebar.

The sidebar is using the database and tools of the full calendar and therefore the full calendar should be present in the "mycalendarfolder" (see code above).

c. Embed a Stand-alone Display

LuxCal provides a number of so-called displays which are single-file programs meant to create a dedicated events listing of for instance the upcoming events in your calendar for public visitors. Displays work out-of-the-box and are highly configurable in an easy way.

Currently available displays are included in this distribution (in the calendar's root folder) and can be viewed on the "LuxCal Displays" page of the LuxSoft website.

After the calendar installation you can directly browse with your browser to the displayX.php file in the calendar's root folder and see the result. An example of the URL: www.yoursite.xxx/calendar/displayX.php

Displays have a number of default configuration settings, defining which events should be shown and defining the graphical user interface (colors, fonts, etc.). In the file displays.txt in the calendar's "configs" folder you will find detailed instructions of how to tailor the default settings of the displays.

Since displays have been designed to be shown in a limited space, you can for instance integrate them in your own website by adding them in an iframe, with a recommended width of 400px.

Example:

• In your web page:

<iframe class="display" src="calendar/display0.php"></iframe>

• In your style sheet:

iframe.display {
  width:400px;
  height:600px;
  overflow:hidden;
  border:1px solid grey;
  border-radius:5px;
  box-shadow:5px 5px 5px #888;
}

d. Embed the Full Calendar

To embed the full LuxCal calendar in an existing web page, an inline frame (iframe) can be used. This can for example be done with the following HTML code:

<iframe id="luxcal" src="http://www.mysite.xx/luxcal/?cP=2"></iframe>

With parameter cP the default view can be set (e.g. year: cP=1, month: cP=2, . . . ,upcoming: cP=7)

If you want to display a subset of the available events, see "Applying Filters to the Calendar" below.

Via the CSS styles of your site, the id luxcal can be used to position and define the style of the iframe containing the luxcal calendar. The style for id luxcal could for instance look as follows:

#luxcal { width:80%; height:800px; margin:20px; border-style:solid; border-width:1px; border-color:grey; }

e. Embed One Specific Calendar View without Navigation Bar

To embed the LuxCal calendar without navigation bar, the parameter hdr=0 should be added to the URL as follows:

<iframe src="http://www.mysite.xx/luxcal/?hdr=0&cP=2"></iframe>

If the navigation bar is suppressed by adding hdr=0 to the URL, the visitor will not be able to navigate the calendar and select other views.
To suppress the calendar header, but leave the navigation links in the various views enabled, hdr=-1 should be added to the calendar URL. In this case the header will be suppressed, but the user will still be able to go to other views via the links in the calendar body: e.g. by clicking the week number or the date in the day cells.

The following parameters can be added to select the view to display and the user-interface language:

• cP to set the view (e.g. year: cP=1, month: cP=2, . . . , upcoming: cP=7)
• cL to set the user-interface language (e.g. French: cL=Francais). The specified language must be present in the lang/ folder)

For example the HTML code to show the Upcoming Events page without navigation bar, in the French language looks as follows:

<iframe id="luxcal" src="http://www.mysite.xx/luxcal/?hdr=0&cP=7&cL=Francais"></iframe>

Via the CSS styles of your site, the id luxcal can be used to position and define the style of the iframe containing the LuxCal calendar. The style for id luxcal could for instance look as follows:

#luxcal { width:80%; height:800px; margin:20px; border-style:solid; border-width:1px; border-color:grey; }

Important:
The parameter hdr=x is remembered via the PHP session mechanism; this means that if you access the embedded calendar without navigation bar, then thereafter, when accessing your normal (not-embedded) calendar when your session is still active (max. one hour) you will also see no navigation bar. This can be solved by adding the parameter hdr=1 to the URL of your normal calendar.

If you want to display a subset of the available events, see "Applying Filters to the Calendar" below.

f. Embed a so-called Calendar "Display"

Since LuxCal version 4.5.1 a number of so called "displays" have been developed for the calendar.

A display in this context is a single-file self contained program, which can be embedded in your web page using an inline frame (<iframe>), presenting the calendar events in an attractive user interface. Displays can also be viewed on mobile devices and will show the calendar events in a fancy user interface without the overhead of headers, bars and buttons.

Embedding a display in your web page is very easy; it's just a matter of inserting an in-line frame in your web page with a link to the desired display file, which must be located in the calendar root folder. To view a display on your mobile device, nothing needs to be done; make sure the desired display is located in the calendar root folder and on your mobile device just browse to the display file installed on your server.

Displays work out of the box and are highly configurable. Each display program file has an easy to use configuration section, which allows you to specify which events and event fields should be shown and to tailor the user interface colors and text.

Displays use the calendar toolboxes and the calendar settings, like date format, time format, first day of the week, etc., and therefore must be located in the calendar root folder.

On the "Displays" page of the LuxSoft website you will find more information about displays and a demonstration of the currently available displays.

g. Applying Filters to the Calendar

When using a link to the calendar or embed the full calendar, parameters can be added to the calendar URL to specify which events hould be shown. When adding parameters, the following syntax should be used: The first parameter starts with a '?' and parameters are separated by an '&', like: www.mysite.net/calendar?par1=3&par2=7. If a parameter can have several values it can be passed as an array by adding square brackets toe the parameter name, like: www.mysite.net/calendar?par1[]=3&par1[]=7.

Parameter cG can be added to the URL to specify the IDs of one or several user groups for which events should be displayed. Parameter cC can be added to the URL to specify the IDs of one or several event categories for which events should be displayed. The user group IDs and event category IDs can be found on the admin's User Group page and Categories page respectively. For example, to specify a user group, with ID 4 the parameter "?cG[]=4" should be added to the URL. If the events of a second user group, for instance, with ID 6 should be displayed as well, then "?cG[]=4&cG[]=6" should be added to the URL. The same counts for the cC parameter when specifying one or more event categories to show.

Example:
If you want to display a calendar without header (navigation bar) showing events from users in the user groups with IDs 4 and 7 and only showing events in event category 2, then the link should be like: www.mysite.net/calendar?hdr=0&cG[]=4&cG[]=4&cC[]=2.

h. Single Sign On (SSO)

When the calendar is embedded in a PHP-based website where users have to log in, users logged in on the parent website can be logged in to the calendar automatically in a secure way, using PHP sessions.

To achieve this the parent website scripts should:

• start PHP sessions, if not done already, by adding the following PHP statement to the parent website PHP script:
  session_name('PHPSESSID');
session_start(); PHP sessions must be started before anything is sent out to the browser (like header information), so this statement must be added somewhere at the start of the script.
• save the user name or the user email address in the session variable 'lcUser' by adding the following statement to the parent website PHP script at any point before the iframe statement with the calendar URL: $_SESSION['lcUser'] = '<user email>'; or $_SESSION['lcUser'] = '<user name>'; The part <user email> or <user name> is a string with the user email address or user name which corresponds to the email address or user name required to log the user in to the calendar (specified by the admin when the calendar user account was created).

Because PHP session data are stored on the server, the user name / email address are not visible to the users.

- End of Installation Guide -