Skip to main content

Events with simplelayout.

Project description

==============================================================================
ftw.events
==============================================================================

.. contents:: Table of Contents

``ftw.events`` is a Plone add-on allowing you to add containers (event folders)
containing items representing an event (event page). It is backed by
``plone.app.event`` and is powered by ``ftw.simplelayout``.

This Plone add-on is compatible with Plone 4.3.x


Installation
************

- Add the package to your buildout configuration:

::

[instance]
eggs +=
...
ftw.events

- Install the "default" GenericSetup profile.


Usage
*****

Start by creating a container which will hold the events by adding a *event folder*.
Add as many *event pages* to the event folder as you like.


Mopage Support
--------------

``ftw.events`` provides integration for the mopage mobile app
(http://web.anthrazit.org/).


Data Endpoint
~~~~~~~~~~~~~

The view ``mopage.events.xml`` returns an XML-feed with the latest events within
the context it is called. It can becalled on any type of object.

- The mopage-API expects a ``partnerid`` and a ``importid``.
They are incldued when submitted via GET-parameter, e.g.:
``http://foo.com/events/mopage.events.xml?partnerid=123&importid=456``

- The endpoint returns only 100 events by default.
This can be changed with the parameter ``?per_page=200``.

- The endpoint returns ``Link``-headers in the response with pagination links.


Trigger behavior
~~~~~~~~~~~~~~~~

The behavior ``ftw.events.behaviors.mopage.IPublisherMopageTrigger`` can be added
on a event folder in order to configure automatic notification to the mopage API
that new events are published.

In order for the behavior to work properly you need an ``ftw.publisher`` setup.
Only the receiver-side (public website) will trigger the notification.
A configured ``collective.taskqueue`` is required for this to work.

Buildout example:

.. code:: ini

[instance]
eggs +=
ftw.events[mopage_publisher_receiver]

zope-conf-additional +=
%import collective.taskqueue
<taskqueue />
<taskqueue-server />


Then enable the behavior for the event folder type and configure the trigger
with the newly availabe fields.


Background
**********

The name of the content type *event page* has been chosen in order to avoid confusion
with the content type *event* of Plone.


Development
***********

**Python:**

1. Fork this repo
2. Clone your fork
3. Shell: ``ln -s development.cfg buildout.cfg``
4. Shell: ``python boostrap.py``
5. Shell: ``bin/buildout``

Run ``bin/test`` to test your changes.

Or start an instance by running ``bin/instance fg``.


Links
*****

- Github: https://github.com/4teamwork/ftw.events
- Issues: https://github.com/4teamwork/ftw.events/issues
- PyPI: http://pypi.python.org/pypi/ftw.events
- Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.events


Copyright
*********

This package is copyright by `4teamwork <http://www.4teamwork.ch/>`_.

``ftw.events`` is licensed under GNU General Public License, version 2.

Changelog
=========


1.2.0 (2016-10-18)
------------------

- Use ftw.referencewidget for saving path relations in eventlistingblocks.
Beacuse of a bug in MultiContentTreeFieldWidget, references were not saved
after a restart of the instance which lead to the blocks not working anymore.
[raphael-s]

- Implement mopage support. [jone]

- Split up location into structured fields title, street, ZIP and city. [jone]


1.1.0 (2016-09-26)
------------------

- Make EventFolder and EventListingBlock addable on the Plone Site.
[lknoepfel]


1.0.1 (2016-09-20)
------------------

- Change German translation for event listing block. [jone]

- Fix AttributeError in create_event_listing_block. [jone]

- Added action for ics export. [tschanzt]


1.0.0 (2016-08-02)
------------------

- Fixed bug where default value on eventlistingblock was not set. [lknoepfel]

- Added ftw.calendar integration. [lknoepfel]

- Don't list EventPage in the navigation [lkoepfel]

- Initial implementation [jone]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ftw.events-1.2.0.tar.gz (41.0 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page