Extension:MsCalendar

From mediawiki.org
MediaWiki extensions manual
MsCalendar
Release status: stable
Implementation Ajax, Tag
Description Provides an easy-to-use month view calendar
Author(s) Martin Schwindl, Martin Keyler, Frédéric Souchon, Felipe Schenone and Patrick Dudics
Latest version 3.0 (2023-03-19)
MediaWiki 1.39+
PHP 5.3+
Database changes Yes
License GNU General Public License 3.0 only
Download
Example https://mediawiki.solutions/wiki/MsCalendar
‎<MsCalendar>
Quarterly downloads 56 (Ranked 96th)
Translate the MsCalendar extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The MsCalendar extension provides an easy-to-use month view calendar. Entries are formatted as one-liners and can span multiple days.

Installation[edit]

  • Download and move the extracted MsCalendar folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/MsCalendar
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'MsCalendar' );
    
  • Run the update script which will automatically create the necessary database tables that this extension needs.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Warning Warning: Some older versions of this extension had an XSS vulnerability in it. You should make sure you are either using exactly version 2.0-1, or are using version 2.3 or higher

Usage[edit]

Wikitext[edit]

To insert a calendar into a wiki page, the minimal wikitext is:

<MsCalendar>Name of the calendar</MsCalendar>

By default, all entries are listed alphabetically. If you want to sort them by id (the date at which they were added), do:

<MsCalendar sort="id">Name of the calendar</MsCalendar>

Interface[edit]

On opening a calendar page, today's date is viewed and highlighted by default:

You can navigate the calendar, using the panel at the top. The "HEUTE" button will always take you back to today's date:

Add an entry by clicking the little "+" sign at the according date:

Now you can name your event ("Name des Events"), change the date ("Datum") of the event, set the duration in days ("Dauer in Tagen") and choose if the event is recurring annually ("Jährlich wiederholen"). Confirm your entries by clicking "Eintrag erstellen":

To change or delete ("Event Löschen") an entry, just click on it.

Please keep in mind that all entries are displayed as one-liners and shortened accordingly if too long. Using "mouse-over" they still can be read without opening them:

As you can see, this example calendar uses the sorting option: