lespf / lespf-calendar
Calendar widget with holidays
Requires
- php: >=8.1
- typo3/cms-core: >=11.5.0 <12.4.99
Requires (Dev)
- typo3/testing-framework: ^6.9.0
Replaces
- typo3-ter/lespf-calendar: v0.8.1
README
📗 Table of Contents
- 📖 About the Project
- 💻 Getting Started
- 👥 Authors
- 🔭 Future Features
- 🤝 Contributing
- 🙏 Acknowledgements
- ❓ FAQ
- 📝 License
📖 Lespf_Calendar
Lespf Calendar is a plugin extension for the Typo3 CMS. It shows a tiny month calendar with markers for holidays and - if you wish - events.
🛠 Built With
Tech Stack
The main language is PHP. There is some use of fluid templates and CSS. Data is handled in form of YAML files (local) and SQL queries (global).
Server
- Typo3
- PHP from 8.1 on
Database
- MariaDB or other database supported by Typo3
Key Features
- holidays for many European countries are included
- events can be imported from a common event extension
- styling by CSS
💻 Getting Started
To get a local copy up and running, follow these steps.
Prerequisites
In order to run this project you need:
- A webserver with PHP from version 8.0 with Datetime extension,
- Typo3 V11 or V12, and
- if you want to import events from extensions, one of the
following plugins:
- News,
- EventNews, or
- SfEventMgt
Setup
As long as the calendar is neither on packagist nor on the Typo3 extension repository (TER), you have to download it manually.
So either clone this repository to your desired folder: sh cd your-folder git clone willadt@gitlab.com:lespf/lespf_calendar.git or download it as a ZIP file.
Install
Install this project with:
- composer, or
- upload it with the Typo3 extension manager.
For composer, you have to configure your Typo3 installation for local packages and put the files there, if you want to get the cutting edge. If the latest official version is OK, you just can emit
composer require lespf/lespf-calendar
For upload of a cutting edge version with the extension manager into your Typo3 installation, you should rename the ZIP file that you downloaded to lespf_calendar.zip (removing the release date/number stuff) before uploading. Official numbered versions should find their way to TER, so you may download them from there.
Post-Install
Run Maintainance/database compare after installation. When reinstalling, you have to reload the database table. You might want to use a tool like phpmyadmin to import ext_tables_static+adt.sql, if database upload within the extension manager does not suffice.
Usage
There is (hopefully complete) documentation for configuration and usage of the plugin written in Restructured Text format within the project's Documentation subfolder. It shall not be repeated here.
This documentation is also accessible online via the Typo3 extension repository (TER).
For writing YAMl files please stick to the examples in the subfolder Resources/Private/Regions.
👥 Authors
👤 Peter Willadt
- GitLab: @gitlabhandle
🔭 Future Features
- [ ] add further countries
🤝 Contributing
Contributions, issues, and feature requests are welcome!
As holidays are best understood if they happen in the culture you live in, I am grateful for help. Within the package documentation you will find some examples of difficulties I was confronted with while scratching on the surface.
Feel free to check the issues page.
🙏 Acknowledgments
I would like to thank...
- the Typo3 community for developer documentation
- the authors of several plugins I inspected for the tricks of the trade, especially 'static Info Tables' and 'tt_address'
❓ FAQ
How can find out which countries are supported?
- As the list of countries grows from time to time, the safest way is to inspect the file ext-tables+adt.sql
Can I add private entries to the database table?
- Please don't. They would be gone with the next update. You may add your holidays (and events) with YAML files.
📝 License
As a Typo3 extension, this project is licensed accoding to the GNU General Public License, version 2 or later. Please consult license information for the Typo3 project for details.