What does it do?

LesPf Calendar displays a simple month calendar in a table. Common holidays are properly marked, you can also have markings for events you have entered into your Typo3 installation. The calendar can cope with one of several distinct event extensions. You may also configure a list of recurring days to be marked.

This extension's only purpose is a quick overview, it is not and shall not become a full calendar with all the bells and whistles.

The calendar can be styled by CSS.

Screenshots

Dependent on your CSS, the calendar might look like this.

Choosing a Region

The calendar plugin gets included like any other plugin. You have to enter a region for proper display of holidays. Normally, region names consist of a country name and an (optional) region name, separated by a hyphen. Please use uppercase, according to ISO 3166.

If a region does not work, it may be not yet contained in the region database.

If your admin has configured a special file with additional dates, you have to enter the file name with extension .yaml instead of a region code. So instead oy typing something like 'GB-SCT' or 'FR', you enter 'custom.yaml' or something like that.

Filtering Events

If you got events that should not be visible to website users, you have to do something more:

• If you have distinct folders for public and private events, choose a folder (or several folders) in which you have entered the public events. If you do not choose at least one folder, any folder will be considered.
• You may give a special category to any event that shall be displayed or hidden. Your administrator can configure the categories to display.

Using distinct folders is probably the better way, as it is more obvious to choose a folder to store an event than to think of setting categories anytime you create an event.

How to find out category numbers

The easy way without any database privileges is to tag an event with some categories and to view the calendar output source code in your browser.

Including Changed Events

The calendar gets redrawn with Typo3's cache cycle (probably once a day). If you have changed or created an event within the current month, you should clear the cache for the page on which the calendar is shown, so that it gets immediately visible.

Dependencies

LesPf calendar needs the PHP datetime extension. This extension is in typically incuded in hosted environments. If you run your own server, you may perhaps have to install it.

As long as you are happy with weeks and holidays, there are no further dependencies. If you want to display events, you have to use an extension that supports this. LesPf Calendar can read data from the following extensions:

• SfEventMagement,
• Eventnews,
• or from News.

You may install one of them after LesPf Calendar, if you have not done so before.

Extending data

You may adopt further countries or regions in the form of YAML files. Sample files are provided in the Resources/Private/Regions subdirectory of the extension. You can also add other kinds of recurring events than holidays to your YAML file. You will find more information in the Developer Corner developer section of this manual.

To make the extension use your YAML file, you have to set the TypoScript variable ext.lespf_calendar.settings.customeventpath to an appropriate value, e.g. fileadmin and you have to add .yaml to the region code in the plugin configuration, e.g. "custom.yaml" if your file happens to be named so. Please cosult the4 next section for security concenrs.

Privacy and Security Concerns

Typical Example

plugin.tx_lespf_calendar.settings {
   # Optional: configure path for private YAML file
   # If restricting backend users is not important:
   #   customeventpath = fileadmin/
   # else (probably better) something like:
   customeventpath = EXT:my_extension/Resources/Private/Regions/
}
page {
  includeCSS {
    myCustomStylesheet = EXT:lespackage/Resources/Public/Css/csspatch.css
    myOtherStyleSheet = EXT:lespf_calendar/Resources/Public/Css/lespf_calendar.css
  }
}

Restricting Categories

SELECT uid, title FROM `sys_category` WHERE deleted = 0;

Calendar Formatting

Adding Additional Calendars

Basically, there are two ways to enter calendar data:

• YAML files
• Entries in the table tx_lespfcalendar_domain_model_calendar

Your preferred way to enter data is to use a YAML file. See below for the database. You will find sample YAML files within the extension's Resources/Private/Regions directory.

YAML files can be built completely from scratch, they can include other YAML files or they can be based on the database.

Please read the Configuration section for the way to configure the extension to find your YAML file. Please read the For Editors section to find out how to select a YAML file for the calendar widget.

The abbreviations of weekdays in calendar headings come from the translation files. If your language is not supported yet and you do not want to translate language files, you can configure the extension to use your own fluid template with headings you have entered.

About the Table tx_lespfcalendar_domain_model_calendar

The table contains official calendar data. It is intended that the table gets rebuilt from scratch whenever you reinstall or update the calendar extension. So please don't enter any data there.

Updating

Automatic reimport of calendar base data does not happen, when the extension gets reinstalled. With traditional installations, you just can reimport data with the extension manager.

Calendars

The calendar plugin is based on the Gregorian Calendar, so it fits European countries well, but probably nothing else. It defaults to Sunday being the last day of the week, but it can be tweaked to accept Sunday as the first weekday.

There is no provision or intention to handle other calendar systems, e.g. the lunar calendar of Islam or the lunisolar Jewish calendar.

Holidays

I have little understanding of holidays outside my cultural bubble. Beside a lack of time, this lack of expertise keeps me from adding all the holiday lists I can find.

Just some examples for difficulties:

• In Denmark there are two holidays that always happen on Sunday. In Germany, I would not include such days into a calendar.
• In Bavaria, there is a holiday that is only valid in communities with a majority of catholic people. This can not be properly shown. In cases like this, you should add it to your site as an event or within a YAML file.
• In Austria, not nation-wide holidays appear to be only valid for the public sector, but not for businesses. I tried to map this by calling these days partial instead of holiday.
• In Germany, Dec. 24 and Dec. 31 have special rules for opening hours of stores, but these days are not holidays. I have not included them, though they might also be partials.
• In the UK, holidays get shifted to the next Monday if they happen to fall on a weekend. I tried to map this by the shifting... field.
• In the Czech Republic, there exist two kinds of holidays that apparently differ by the categories of stores that are allowed to open. I have flagged both kinds as holiday.
• Also in the Czech Republic, there are official remarkable days that are apparently no holidays. I have not entered them.
• In Belgium, there exist holidays for the Flemish part of the country, for the Walloon part, and for the German part. Unfortunately, the ISO 3166-2 region codes know only about the Flemish part, the Walloon part and the Brussels region. So for me, there is one region missing and one region that I do not know how to handle.
• In Switzerland, there are at least four distinct levels of holidays, the level varying from region to region, and there are a lot of local holidays. Also it has to be taken into account, if a majority of the population is catholic. Oh, and some holidays should get canceled if it leads to Monday and Tuesday being a holiday, but this cancelling is not respected everywhere[1]. As a consequence, I feel not qualified to enter Swiss holidays correctly.

Events

Recurring events within YAML files that span from the end of one year to the next will not show up in December and January. Please split them up.

There is no rule for shifting recurring events away from holidays.

Implementation

The calendar extension uses raw database queries to determine events. This is not generally considered as good practice, but it is way faster than to load complete events, just to find out when they start and end.

Version 0.9.1

• Easter dependent dates were not correct in some timezones. This is hopefully fixed.

Version 0.9.0

• Fixed ext_tables_static+adt.sql to contain only insert statements, so loading tyble contents from Typo3 will work as intended.

Version 0.8.3

• Added compatibility to Typo3 13.

Version 0.8.2

• Extension manual is now on docs.typo3.org, accessible via Typo3 extension repository.

Version 0.8.1

• Region entries containing paths will be truncated to their basename.
• A wrong template for calendars had been shipped with the releases 0.7.6 and 0.8.0. This is corrected.
• Added Iceland.

Version 0.8.0

• Improved documentation.
• Repared plugin title visibilty in backend.

Version 0.7.6

• Added some further European countries (IT, SP, PT, LT, LI, EE).
• Added 12-24 and 12-31 as partials for Germany.
• Took provisions for displaying ISO 8601 week number.
• Took provisions for memorial days.
• Improved documentation for developers.

Version 0.7.5

• Changed TCA to prevent accidental editing of holidays table.
• Added shifting rule for events with fixed weekdays.

Version 0.7.4

• First publishing to Typo3 Extension Repository

Version 0.7.3

• Improved documentation.
• Added support for monthly repeated events.

Version 0.7.2

• Added choice of week start (Monday or Sunday).
• Updated documentation.
• Fixed database record display in backend.

Version 0.7.1

• Initial public release.