Mocca Calendar Application
A Calendar Application supporting several Calendars |
Type | XAR |
Category | |
Developed by | xwiki:XWiki.edgo, Clemens Robbenhaar, Thomas Mortagne |
Active Installs | 298 |
Rating | |
License | GNU Lesser General Public License 2.1 |
Description
Combines the Calendar Application application with the FullCalendar Application to provide an "out of the box" usable calendar within XWiki with the slick UI from the "FullCalendar" jQuery plugin.
Usage
After installing the extension you should have a "Calendar" in the applications panel; alternatively you can reach the application at http://<server>/xwiki/bin/view/MoccaCalendar/
The application maintains several calendars. One default calender is preinstalled.
The start page displays all events of all calendars in the current month.
Users can either add new events (which end up in the default calendar, unless specified differently) or new calendars.
Overview page
Calendars have a description and color. All events of a given calendar are displayed in the color of it's calendar.
Events, beside of being colored like their corresponding calendar, also have a short name, a description, a start and an end date. Events can be "all day" events or have a defined start and end time, too.
Display of various events on the main calendar page
Creating events
Clicking on the "Create an Event" link opens a modal dialog which allows you to give the new event a title, start and end date and time and a description. (The description only shows up in the details view). "All day" events are supported, too (currently you have to give even "all day" a dummy time for start and end date, too, which will be ignored however.)
Recurring events are not yet supported.
Dialog to create a new event
Editing events
Clicking on an event in the calendar opens the detail view of the event. In this dialog you can edit the event or delete the event (you have to confirm the delete in the dialog.)
Detail view of an existing event
Editing an existing event
Alternatively you can view the Event as a wiki page by clicking on the "View" button in the dialog; on that page you can add attachments, look at the history, etc.
You can go back to the calendar you came from via the link at the bottom, or to the main calendar overview via the link in the breadcrumbs.
An event viewed as wiki page
Managing Calendars
At the bottom of the overview page you can find a table of all existing calendars, with options to view edit or delete them, and a link to add new calendars on top of it:
List of all existing calendars
If you click on the "Create a calendar" link you will be first led to the normal "add page" dialog, which then will create a new calendar and show it to you in edit mode. You can set up the title, color (via the convenient color picker) and description. The latter is shown in the detail view of the calendar.
Editing a calendar
iCalendar export
You can use Mocca Calendar iCal export to add iCalendar export.
Issues
If you find a bug or have a suggestion for improvement, please report it in the Issue Tracker. Please check if the issue has been reported there already.
For MoccaCalendar Developers
Compatibility
The oldest supported XWiki version can be found in the root pom.xml as the version of the xwiki-commons-pom.
You can set up a barebone instance of that version by running: mvn clean process-test-resources in the directory application-mocca-calendar-tests. Start the instance with ./target/xwiki/start_xwiki.sh or .\target\xwiki\start_xwiki.bat.
Always test changes at least against the oldest supported and the newest XWiki version. If a feature cannot be made to work in the oldest supported version, change the oldest supported version to a more recent one where that feature works.
Create a Release
Releases are created via the Contrib Release process, with some modifications:
Preparation
Make sure the issue tracker has no open issues assigned to the to-be-released version - or move them to the next version.
Make sure you use a java version compatible with the oldest supported XWiki version - otherwise the integration tests might not be pleased.
Update the translations from l10n.xwiki.org with the help of the script in MVN=/path/to/your/mvn L10N_USER=youraccount L10N_PASSWORD="your passwd" ./application-mocca-calendar-scripts/release-translations.sh. (See application-mocca-calendar-scripts/README.md for more options/quirks of the script.)
To prevent any browser caching issues, update the version number manually in the src/main/resources/MoccaCalendar/Macro.xml.
Commit all changes so far and push the results.
Perform release
In the root directory:
git push
git status
# prepare the release
mvn -Pintegration-tests -Darguments="-DskipTests" release:prepare
# create a maintenance branch - not needed for minor releases
git branch stable-X.Y application-mocca-calendar-X.Y
# perform the actual release
mvn -Darguments="-DskipTests -Dgpg.skip=true" -Pintegration-tests release:perform
# push the changes to github
git push origin master
git push origin stable-X.Y
Then push the release through http://nexus.xwiki.org/nexus/#stagingRepositories
Before finishing the release, check the validity of the release by installing the pending release in a fresh XWiki instance for the extension manager, "extended search" > 'org.xwiki.contrib:application-mocca-calendar-ui' + version number.
Cleanup
- Sync the release on this page via the button right to "Extension imported from repository".
- Read this page and update the descriptions, if necessary
- Especially update the release notes; open this page in the object editor and update the "Release notes" field of the corresponding ExtensionCode.ExtensionVersionClass; at least adding the jira issues :Of course feel free to add any other things worth noting.{{jira url="https://jira.xwiki.org" style="list" source="jql"}}
project = MOCCACAL and fixVersion = "X.Y.Z"
{{/jira}} - Mark the version as released in jira and create the next version (if not already done).
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Release Notes
v2.5.4
v2.5.3
v2.5.2
v2.5.1
v2.5
v2.4.4
v2.4.3
added translations for lv and sk
v2.4.2
v2.4.1
added dependency missing from 2.4
v2.4
v2.3.1
v2.3
v2.2.2
fixed bungled release number in 2.2.1
v2.2.1
v2.2
v2.1.9
v2.1.8
Dependencies
Dependencies for this extension (org.xwiki.contrib:application-mocca-calendar-ui 2.5.4):
- org.xwiki.platform:xwiki-platform-rendering-wikimacro-store 6.4
- org.xwiki.rendering:xwiki-rendering-macro-html 6.4
- org.xwiki.platform:xwiki-platform-rendering-macro-code 6.4
- org.xwiki.platform:xwiki-platform-rendering-macro-groovy 6.4
- org.xwiki.platform:xwiki-platform-rendering-macro-include 6.4
- org.xwiki.platform:xwiki-platform-rendering-macro-velocity 6.4
- org.xwiki.platform:xwiki-platform-livetable-ui 6.4
- org.xwiki.platform:xwiki-platform-appwithinminutes-ui 6.4
- org.xwiki.platform:xwiki-platform-jodatime 6.4
- org.xwiki.contrib:macro-fullcalendar 2.0.2