Skip to content
Event calendars for CMSimple_XH
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
classes
config
css
help
languages
tests
views
.gitignore
CHANGELOG
LICENSE
README.md
README_DE.md
admin.php
build.xml
calendar.min.js
calendar.png
composer.json
coverage.xml
index.php
phpcompatinfo.json
version.nfo

README.md

Calendar_XH

Calendar_XH facilitates the administration and display of event calendars and lists on CMSimple_XH websites.

This version is a fork of Calendar 1.2.10. Note that svasti has developed Calendar 1.2 further and that version offers plenty more features at the cost of greatly increased complexity.

Table of Contents

Requirements

Calendar_XH requires CMSimple_XH ≥ 1.7.0 with the Fa_XH plugin, and PHP ≥ 5.5.4.

Download

The lastest release is available for download on Github.

Installation

The installation is done as with many other CMSimple_XH plugins. See the CMSimple_XH wiki for further details.

  1. Backup the data on your server.
  2. Unzip the distribution on your computer.
  3. Upload the whole directory calendar/ to your server into CMSimple_XH's plugins/ directory.
  4. Set write permissions for the subdirectories config/, css/ and languages/.
  5. Navigate to PluginsCalendar in the back-end to check if all requirements are fulfilled.

Settings

The plugin's configuration is done as with many other CMSimple_XH plugins in the website's back-end. Select PluginsCalendar.

You can change the default settings of Calendar_XH under Config. Hints for the options will be displayed when hovering over the help icon with your mouse.

Localization is done under Language. You can translate the character strings to your own language if there is no appropriate language file available, or customize them according to your needs.

The look of Calendar_XH can be customized under Stylesheet.

Usage

Event Editor

The administration of the events is done in the back-end (PluginsCalendarEdit Events). Note that adding and deleting events happens only temporarily; you have to save the events to make that change permanent.

Alternatively, you can embed the event editor on a normal CMSimple_XH page, so the events can be edited by non-admins also. Use the following plugin call:

{{{editevents()}}}

Embedding the event editor on a page should only be done if access to this page requires authorization via Register_XH or Memberpages.

Besides normal events, it is also possible to define birthdays by entering ### as location, the name of the birthday child as event and the date of birth as start date.

Calendars

You can show the event calendar either from the template:

<?=calendar()?>

or only on a page:

{{{calendar()}}}

All defined events of the current month are highlighted in the calendar, and linked to the event page that is defined in the language settings of Calendar_XH.

Event List

The event list is supposed to be embedded on the event page that is defined in the language settings of Calendar_XH with the following plugin call:

{{{events()}}}

Next Event

Optionally, you can show the next scheduled event in a marquee like manner, either from the template:

<?=nextevent()?>

or on a page:

{{{nextevent()}}}

Import

To import existing .ics files (iCalendar format), you have to put them in the content/ folder (right besides the calendar.csv file). Then navigate to PluginsCalendarImport where you can actually import the desired file(s). Note that the imported events are treated as new events; importing the same .ics file multiple times will add all events multiple times.

Limitations

Calendar_XH is unsuitable for lots of events. Depending on the server, roughly 100 events should be fine, but more events may cause issues.

Troubleshooting

Report bugs and ask for support either on Github or in the CMSimple_XH Forum.

License

Calendar_XH is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Calendar_XH is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantibility or fitness for a particular purpose. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Calendar_XH. If not, see http://www.gnu.org/licenses/.

Copyright © 2005-2006 Michael Svarrer
Copyright © 2007-2008 Tory
Copyright © 2008 Patrick Varlet
Copyright © 2011 Holger Irmler
Copyright © 2011-2013 Frank Ziesing
Copyright © 2017-2019 Christoph M. Becker

Credits

The Calendar plugin for CMSimple has originally be developed by Michael Svarrer, and then been improved by Tory, Patrick Varlet, Holger Irmler and Frank Ziesing. Many thanks to all these developers!

The plugin logo has been designed by Alessandro Rei. Many thanks for publishing this icon under GPL.

And last but not least many thanks to Peter Harteg, the father of CMSimple, and all developers of CMSimple_XH without whom this amazing CMS wouldn't exist.

You can’t perform that action at this time.