a LuxSoft product

LuxCal Event calendar

Table of Content

  1. Introduction

  2. Specialties of display 0

  3. Specialties of display 1 - 3

  4. Tailoring the display's configuration settings

  5. How to embed displays in your web page

  6. Explanation of the general configuration settings used by most displays


1. Introduction

LuxCal displays are single-file programs meant to create a dedicated events listing of the upcoming events in your calendar. Displays work out-of-the-box and are highly configurable in an easy way. They must be located in the root folder of the LuxCal calendar. Directly after installing or upgrading the calendar you can browse with your browser to the file and see the result. An example of the URL for for instance display1: www.yoursite.xxx/calendar/display1.php.

There are currently 4 different displays available:


IMPORTANT: To avoid losing your changes when upgrading the calendar, tailoring the configuration settings of displays should NOT be done in the displayX.php files in the calendar root, but should be done as described in section 4 hereafter.

2. Specialties of display 0

3. Specialties of display 1 - 3

4. Tailoring the display's configuration settings

Displays have a section with default configuration settings, specifying for example which events should be shown and defining the graphical user interface (lay-out, colors, fonts, etc.). The most important configuration settings are explanation at the end of this document.

You can change the default configuration settings in the following ways:

So if you are using only one displayX.php, then copying the configuration file, with the same name as the displayX.php and extension .cnf, from the "samples" folder to the "configs" folder and editing the settings will do.

If you are using multiple displays of the same type (e.g. a display 1 with birthdays and a display 1 (the same) with all other events, then you can copy a configuration file for this display from the "samples" folder to the "configs" folder and make a tailored copy for each of your multiple displays.

5. How to embed displays in your web page

Displays have been designed to be shown in a limited space, they are best viewed on a narrow-width display (for instance a smart phone) or in a narrow-width iframe integrated in your website.

Example:

Integrated in your web page:

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

In your style sheet:

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

Optionally displays can be called with a URL parameter ?cats=comma-separated-category-ID-list. In this case only events in the specified categories will be shown, provided that the specified category is part of the category ID list in the display configuration. In this way you can have the same display multiple times in your web pages, each showing events in different categories.

6. Explanation of the general configuration settings used by most displays

Set Start and End Date
General Settings

 - End of LuxCal Displays User Guide -

design 2020 - powered by LuxSoft