Table of Content
1. Introduction
In the LuxCal calendar the PDF Print feature can be selected via the side-menu. When using LuxCal displays (see displays.txt), a PDF button in the header of the display can be enabled in the configuration settings of the display.
When the user selects the PDF menu item or button, a PDF dialog is opened where the user can specify the PDF print format (Portrait or Landscape) and a start and end time. Active selections in the calendar (e.g. via the Options Panel or restrictions via the user group) are also applied by the PDF print feature.
2. Tailoring the PDF's configuration settings
The PDF creation scripts have a section with default configuration settings, specifying for the header and footer of the PDF print, the event title lay-out, the event fields to be printed and defining the graphical user interface colors. The most important configuration settings are explanation at the end of this document.
Changing the PDF settings for the full calendar
You can change the default PDF configuration settings by copying the file pdf.cnf in the "samples" folder to the 'configs' folder and by tailoring the settings in this file.
Changing the PDF settings for the displays
Copy the pdfX.cnf file in the "samples" folder to the 'configs' folder, rename the file and tailor the settings in this file and in the parent display specify the file name (without extension) in the display's $pdfCnf setting.
If you are using multiple displays and want to tailor the PDF settings for each display individually, repeat the above for each display.
3. Explanation of the PDF configuration settings
- $calID = "";
Calendar ID. If there are multiple calendars in use, here you can specify which calendar to use. E.g. "mycal". When this setting is left blank (""), the default calendar will be taken. - $pageHdr = "#c - Upcoming Events";
Page header text of the PDF file. E.g. "Upcoming events". If #c is part of the text, the it will be replaced by the calendar title. - $pageFtr = "#p>page #n>#u #d";
Page footer template (#p: period, #n: page number, #d: date/time printed, u: user name (if logged in), >: tab (left > center > right)) - $sortD = 0;
Event sorting on dates; 0: ascending, 1: descending. - $maxDays = 0;
Max. number of days to show; 0: no maximum. - $evtHead = '#c owner: #o';
Event head template. The combination of the # and the subsequent character will be replaced by the corresponding value, as follows: #e: event title, #c: event title - category color, #u: event title - owner group color, #o: event owner. All other characters in the template will be part of the event head. - $evtBody = '123';
List of event fields to show. Each number represents an event field, as follows: 1: venue, 2: category, 3: description, 4: Extra field 1, 5: Extra field 2, 6: Email notification data (if requested), 7: Date/time added edited), 8: attachments. The order of the events fields corresponds to the order of the numbers in $evtBody. - $hdStyle = '';
Event head style ('' (empty): normal, 'B': bold, 'I': italic, 'U': underline).