Skip to content

Commit

Permalink
docs: some more documentation in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cgoIT committed May 2, 2024
1 parent 6293415 commit 9be14c5
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 6 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,24 @@ Run the following command in your project directory:
composer require cgoit/calendar-extended-bundle
```


IMPORTANT NOTICE
----------------

Starting with version 2 of this bundle some features are not supported any more.

| Feature | Description |
|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| Event Registration | This bundle does *NOT* support event registrations any more. You can use other bundles like `inspiredminds/contao-event-registration` for this purpose |
| Frontend editing in FullCalendar | This feature is *NOT* supported any more |
| FullCalendar Upgrade | FullCalendar was upgraded to version 6.1. So no more dependency to JQuery exists. |


Upgrade from version 1.x
------------------------

If you want to upgrade from version 1 run the `contao:migrate` script. In the first step do all the database updates *without* any deletes. This ensures that all migrations can run after the first round of migration. If you are really sure that version 2 is working for you, you can run all the deletes via the `contao:migrate` script.

Contao 5 support
----------------

Expand Down
3 changes: 0 additions & 3 deletions contao/languages/de/tl_module.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
$GLOBALS['TL_LANG']['tl_module']['businessDays'] = ['Arbeitstage', 'Tage, an denen die Geschäftszeiten gelten.'];
$GLOBALS['TL_LANG']['tl_module']['businessDayStart'] = ['Arbeitszeit von', 'Beginn der Arbeitszeiten.'];
$GLOBALS['TL_LANG']['tl_module']['businessDayEnd'] = ['Arbeitszeit bis', 'Ende der Arbeitszeiten.'];
$GLOBALS['TL_LANG']['tl_module']['eventLimit'] = ['Events limitieren', 'Limitiert die Anzahl der Events eines Tages.'];
$GLOBALS['TL_LANG']['tl_module']['weekNumbers'] = ['Kalenderwochen', 'Kaldenderwochen werden im Kalendaer angezeigt.'];

$GLOBALS['TL_LANG']['tl_module']['cal_times_range'] = ['Zeitfenster für den Stundenplan.', 'Zeigt die Zeiten links als Label im Stundeninterval an.'];
Expand All @@ -45,5 +44,3 @@
$GLOBALS['TL_LANG']['tl_module']['cal_fc_week'] = 'Wochenübersicht';
$GLOBALS['TL_LANG']['tl_module']['cal_fc_day'] = 'Tagesübersicht';
$GLOBALS['TL_LANG']['tl_module']['cal_fc_list'] = 'Listenansicht';

$GLOBALS['TL_LANG']['tl_module']['includeJQuery'] = 'Sie müssen JQuery dem Layout hinzufügen um den FullCalendar nutzen zu können.';
3 changes: 0 additions & 3 deletions contao/languages/en/tl_module.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
$GLOBALS['TL_LANG']['tl_module']['businessDays'] = ['Business days', 'Days on which business hours apply.'];
$GLOBALS['TL_LANG']['tl_module']['businessDayStart'] = ['Business hours from', 'Start of working hours.'];
$GLOBALS['TL_LANG']['tl_module']['businessDayEnd'] = ['Business hours to', 'End of working hours.'];
$GLOBALS['TL_LANG']['tl_module']['eventLimit'] = ['Event limit', 'Limits the number of events displayed on a day.'];
$GLOBALS['TL_LANG']['tl_module']['weekNumbers'] = ['Week numbers', 'Determines if week numbers should be displayed on the calendar.'];

$GLOBALS['TL_LANG']['tl_module']['cal_times_range'] = ['Timeframe of timetable.', 'Displays the time al label on the left side.'];
Expand All @@ -44,5 +43,3 @@
$GLOBALS['TL_LANG']['tl_module']['cal_fc_week'] = 'Weekly overview';
$GLOBALS['TL_LANG']['tl_module']['cal_fc_day'] = 'Daily overview';
$GLOBALS['TL_LANG']['tl_module']['cal_fc_list'] = 'List view';

$GLOBALS['TL_LANG']['tl_module']['includeJQuery'] = 'You must add JQuery to the layout to be able to use the FullCalendar.';

0 comments on commit 9be14c5

Please sign in to comment.