==============================================================================
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.16.0 (2023-08-25)
-------------------
- Add plone.restapi support [mathias.leimgruber]
1.15.1 (2020-09-03)
-------------------
- Add more info to rss feed and use Event start date as pubDate. [mathias.leimgruber]
- Respect syndications settings on EventFolder RSS viewlet. [mathias.leimgruber]
1.15.0 (2020-07-27)
-------------------
- Fix german formatted date translation for open-ended events [Nachtalb]
- Fix plone 5 upgrade step, which accidentally broke ftw.keywordwidget [mathias.leimgruber]
- Remove obsolete dependency from Plone 5. From now on install the "plone4" extra for Plone 4 installations [Nachtalb]
- Add possibility to show a leadimage within the block. [busykoala]
1.14.4 (2020-01-09)
-------------------
- Add ftw.events portal_types translations to plone domain. [tinagerber]
1.14.3 (2019-12-18)
-------------------
- Fix condition introduced in release 1.14.2. [mathias.leimgruber]
1.14.2 (2019-12-17)
-------------------
- Improve reindex_indexes install hook - to not reindex if not necessary. [mathias.leimgruber]
1.14.1 (2019-12-14)
-------------------
- Provide precompiled bundle. [tinagerber]
1.14.0 (2019-12-05)
-------------------
- New styling for event_listing view [jone, tinagerber]
1.13.2 (2019-10-02)
-------------------
- Use same rss label text as ftw.news for a more unified experience [Nachtalb]
1.13.1 (2019-09-12)
-------------------
- Add a location-setter to fix the ics-importer. [elioschmutz]
1.13.0 (2019-09-03)
-------------------
- Be able to add custom "more items" link for EventListingBlocks. [tinagerber]
1.12.0 (2019-08-29)
-------------------
- Add customizable title to archive portlet [Nachtalb]
1.11.4 (2019-07-25)
-------------------
- Fix event accessor location field (includes features like location in the ics export) [Nachtalb]
1.11.3 (2019-05-29)
-------------------
- Change sort order to match the same the EventListingBlock (next events on top) [Nachtalb]
1.11.2 (2019-05-21)
-------------------
- Fix typo in "Veranstalgungsauflistung" => "Veranstaltungsauflistung" [Nachtalb]
1.11.1 (2019-05-14)
-------------------
- Fix event archive portlet compatibility issue with ftw.news [Nachtalb]
1.11.0 (2019-05-14)
-------------------
- Add event archive portlet [Nachtalb]
- Add missing plone 5 registry.xml records (previously plone 4 propertiestool.xml) [Nachtalb]
1.10.0 (2019-05-01)
-------------------
- Add event_listing view for EventFolder [Nachtalb]
- Add plone 5.1 support [busykoala]
1.9.0 (2019-01-18)
------------------
- Add simplelayout view to plone views action.
The prefix "@@"" hides the simplelayout view in plone views action.
Removing this makes it accessible. [busykoala]
- Add arrow in front of "more"-button, to create a similar appearance as
in ftw.news. [busykoala]
1.8.0 (2018-11-05)
------------------
- Enable "ics_view" on event folder, so a ICS file can be exported containing
all the events within the event folder. [mbaechtold]
1.7.1 (2018-02-06)
------------------
- Add RSS view for eventlisting block.
[raphael-s]
1.7.0 (2017-12-08)
------------------
- Add collective.taskqueue to test-dependencies [raphael-s]
- Group fields of the event listing block into separate fieldsets for
better user experience. [mbaechtold]
- Use ReferenceObjSourceBinder for filter by path field in eventlistingblock.
[mathias.leimgruber]
- Fix filter for subject on eventlistingblock: UnicodeDecodeError of the subject had umlauts.
[mathias.leimgruber]
- Use "ftw.keywordwidget" for setting the keywords on the event listing
block and the event page. [mbaechtold]
1.6.2 (2017-04-28)
------------------
- Add compatibilty with lates ftw.testbrowser 1.21.0.
[mathias.leimgruber]
- Respect `exclude_past_events` setting of block, also on the event listing view.
[mathias.leimgruber]
1.6.1 (2017-03-30)
------------------
- Fix a bug which prevented inactive event pages from being shown in
combination with Solr. [mbaechtold]
1.6.0 (2017-03-22)
------------------
- Add option allowing to hide the event listing block if there are no
events to be shown. [mbaechtold]
- Show inactive events if the user has the permission to add
events. [mbaechtold]
1.5.0 (2017-02-28)
------------------
- Move the global ics export documentaction.
[Kevin Bieri]
- Make Event and EventFolder linkable in TinyMCE
[raphael-s]
1.4.0 (2017-01-19)
------------------
- Convert "filter_by_path" references of the event listing blocks.
This should have been done in 1.2.0.
[mbaechtold]
- Show text of "ICS Export" action again.
[Kevin Bieri]
1.3.0 (2016-12-06)
------------------
- Use a text field for the value of the zip code instead of an integer
field. [mbaechtold]
1.2.1 (2016-10-20)
------------------
- Fix chameleon support for mopage export. [jone]
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]
Raw data
{
"_id": null,
"home_page": "https://github.com/4teamwork/ftw.events",
"name": "ftw.events",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ftw events",
"author": "4teamwork AG",
"author_email": "mailto:info@4teamwork.ch",
"download_url": "https://files.pythonhosted.org/packages/3a/18/44a2c43bceb9409fb0250a2fe96946249fdf61d4901661b905ae7e83f96e/ftw.events-1.16.0.tar.gz",
"platform": null,
"description": "==============================================================================\nftw.events\n==============================================================================\n\n.. contents:: Table of Contents\n\n``ftw.events`` is a Plone add-on allowing you to add containers (event folders)\ncontaining items representing an event (event page). It is backed by\n``plone.app.event`` and is powered by ``ftw.simplelayout``.\n\nThis Plone add-on is compatible with Plone 4.3.x\n\n\nInstallation\n************\n\n- Add the package to your buildout configuration:\n\n::\n\n [instance]\n eggs +=\n ...\n ftw.events\n\n- Install the \"default\" GenericSetup profile.\n\n\nUsage\n*****\n\nStart by creating a container which will hold the events by adding a *event folder*.\nAdd as many *event pages* to the event folder as you like.\n\n\nMopage Support\n==============\n\n``ftw.events`` provides integration for the mopage mobile app\n(http://web.anthrazit.org/).\n\n\nData Endpoint\n-------------\n\nThe view ``mopage.events.xml`` returns an XML-feed with the latest events within\nthe context it is called. It can becalled on any type of object.\n\n- The mopage-API expects a ``partnerid`` and a ``importid``.\n They are incldued when submitted via GET-parameter, e.g.:\n ``http://foo.com/events/mopage.events.xml?partnerid=123&importid=456``\n\n- The endpoint returns only 100 events by default.\n This can be changed with the parameter ``?per_page=200``.\n\n- The endpoint returns ``Link``-headers in the response with pagination links.\n\n\nTrigger behavior\n----------------\n\nThe behavior ``ftw.events.behaviors.mopage.IPublisherMopageTrigger`` can be added\non a event folder in order to configure automatic notification to the mopage API\nthat new events are published.\n\nIn order for the behavior to work properly you need an ``ftw.publisher`` setup.\nOnly the receiver-side (public website) will trigger the notification.\nA configured ``collective.taskqueue`` is required for this to work.\n\nBuildout example:\n\n.. code:: ini\n\n [instance]\n eggs +=\n ftw.events[mopage_publisher_receiver]\n\n zope-conf-additional +=\n %import collective.taskqueue\n <taskqueue />\n <taskqueue-server />\n\n\nThen enable the behavior for the event folder type and configure the trigger\nwith the newly availabe fields.\n\n\nBackground\n**********\n\nThe name of the content type *event page* has been chosen in order to avoid confusion\nwith the content type *event* of Plone.\n\n\nDevelopment\n***********\n\n**Python:**\n\n1. Fork this repo\n2. Clone your fork\n3. Shell: ``ln -s development.cfg buildout.cfg``\n4. Shell: ``python boostrap.py``\n5. Shell: ``bin/buildout``\n\nRun ``bin/test`` to test your changes.\n\nOr start an instance by running ``bin/instance fg``.\n\n\nLinks\n*****\n\n- Github: https://github.com/4teamwork/ftw.events\n- Issues: https://github.com/4teamwork/ftw.events/issues\n- PyPI: http://pypi.python.org/pypi/ftw.events\n- Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.events\n\n\nCopyright\n*********\n\nThis package is copyright by `4teamwork <http://www.4teamwork.ch/>`_.\n\n``ftw.events`` is licensed under GNU General Public License, version 2.\n\nChangelog\n=========\n\n\n1.16.0 (2023-08-25)\n-------------------\n\n- Add plone.restapi support [mathias.leimgruber]\n\n\n1.15.1 (2020-09-03)\n-------------------\n\n- Add more info to rss feed and use Event start date as pubDate. [mathias.leimgruber]\n- Respect syndications settings on EventFolder RSS viewlet. [mathias.leimgruber]\n\n\n1.15.0 (2020-07-27)\n-------------------\n\n- Fix german formatted date translation for open-ended events [Nachtalb]\n- Fix plone 5 upgrade step, which accidentally broke ftw.keywordwidget [mathias.leimgruber]\n- Remove obsolete dependency from Plone 5. From now on install the \"plone4\" extra for Plone 4 installations [Nachtalb]\n- Add possibility to show a leadimage within the block. [busykoala]\n\n\n1.14.4 (2020-01-09)\n-------------------\n\n- Add ftw.events portal_types translations to plone domain. [tinagerber]\n\n\n1.14.3 (2019-12-18)\n-------------------\n\n- Fix condition introduced in release 1.14.2. [mathias.leimgruber]\n\n\n1.14.2 (2019-12-17)\n-------------------\n\n- Improve reindex_indexes install hook - to not reindex if not necessary. [mathias.leimgruber]\n\n\n1.14.1 (2019-12-14)\n-------------------\n\n- Provide precompiled bundle. [tinagerber]\n\n\n1.14.0 (2019-12-05)\n-------------------\n\n- New styling for event_listing view [jone, tinagerber]\n\n\n1.13.2 (2019-10-02)\n-------------------\n\n- Use same rss label text as ftw.news for a more unified experience [Nachtalb]\n\n\n1.13.1 (2019-09-12)\n-------------------\n\n- Add a location-setter to fix the ics-importer. [elioschmutz]\n\n\n1.13.0 (2019-09-03)\n-------------------\n\n- Be able to add custom \"more items\" link for EventListingBlocks. [tinagerber]\n\n\n1.12.0 (2019-08-29)\n-------------------\n\n- Add customizable title to archive portlet [Nachtalb]\n\n\n1.11.4 (2019-07-25)\n-------------------\n\n- Fix event accessor location field (includes features like location in the ics export) [Nachtalb]\n\n\n1.11.3 (2019-05-29)\n-------------------\n\n- Change sort order to match the same the EventListingBlock (next events on top) [Nachtalb]\n\n\n1.11.2 (2019-05-21)\n-------------------\n\n- Fix typo in \"Veranstalgungsauflistung\" => \"Veranstaltungsauflistung\" [Nachtalb]\n\n\n1.11.1 (2019-05-14)\n-------------------\n\n- Fix event archive portlet compatibility issue with ftw.news [Nachtalb]\n\n\n1.11.0 (2019-05-14)\n-------------------\n\n- Add event archive portlet [Nachtalb]\n- Add missing plone 5 registry.xml records (previously plone 4 propertiestool.xml) [Nachtalb]\n\n1.10.0 (2019-05-01)\n-------------------\n\n- Add event_listing view for EventFolder [Nachtalb]\n- Add plone 5.1 support [busykoala]\n\n\n1.9.0 (2019-01-18)\n------------------\n\n- Add simplelayout view to plone views action.\n The prefix \"@@\"\" hides the simplelayout view in plone views action.\n Removing this makes it accessible. [busykoala]\n\n- Add arrow in front of \"more\"-button, to create a similar appearance as\n in ftw.news. [busykoala]\n\n\n1.8.0 (2018-11-05)\n------------------\n\n- Enable \"ics_view\" on event folder, so a ICS file can be exported containing\n all the events within the event folder. [mbaechtold]\n\n\n1.7.1 (2018-02-06)\n------------------\n\n- Add RSS view for eventlisting block.\n [raphael-s]\n\n\n1.7.0 (2017-12-08)\n------------------\n\n- Add collective.taskqueue to test-dependencies [raphael-s]\n\n- Group fields of the event listing block into separate fieldsets for\n better user experience. [mbaechtold]\n\n- Use ReferenceObjSourceBinder for filter by path field in eventlistingblock.\n [mathias.leimgruber]\n\n- Fix filter for subject on eventlistingblock: UnicodeDecodeError of the subject had umlauts.\n [mathias.leimgruber]\n\n- Use \"ftw.keywordwidget\" for setting the keywords on the event listing\n block and the event page. [mbaechtold]\n\n\n1.6.2 (2017-04-28)\n------------------\n\n- Add compatibilty with lates ftw.testbrowser 1.21.0.\n [mathias.leimgruber]\n\n- Respect `exclude_past_events` setting of block, also on the event listing view.\n [mathias.leimgruber]\n\n\n1.6.1 (2017-03-30)\n------------------\n\n- Fix a bug which prevented inactive event pages from being shown in\n combination with Solr. [mbaechtold]\n\n\n1.6.0 (2017-03-22)\n------------------\n\n- Add option allowing to hide the event listing block if there are no\n events to be shown. [mbaechtold]\n\n- Show inactive events if the user has the permission to add\n events. [mbaechtold]\n\n\n1.5.0 (2017-02-28)\n------------------\n\n- Move the global ics export documentaction.\n [Kevin Bieri]\n\n- Make Event and EventFolder linkable in TinyMCE\n [raphael-s]\n\n\n1.4.0 (2017-01-19)\n------------------\n\n- Convert \"filter_by_path\" references of the event listing blocks.\n This should have been done in 1.2.0.\n [mbaechtold]\n\n- Show text of \"ICS Export\" action again.\n [Kevin Bieri]\n\n\n1.3.0 (2016-12-06)\n------------------\n\n- Use a text field for the value of the zip code instead of an integer\n field. [mbaechtold]\n\n\n1.2.1 (2016-10-20)\n------------------\n\n- Fix chameleon support for mopage export. [jone]\n\n\n1.2.0 (2016-10-18)\n------------------\n\n- Use ftw.referencewidget for saving path relations in eventlistingblocks.\n Beacuse of a bug in MultiContentTreeFieldWidget, references were not saved\n after a restart of the instance which lead to the blocks not working anymore.\n [raphael-s]\n\n- Implement mopage support. [jone]\n\n- Split up location into structured fields title, street, ZIP and city. [jone]\n\n\n1.1.0 (2016-09-26)\n------------------\n\n- Make EventFolder and EventListingBlock addable on the Plone Site.\n [lknoepfel]\n\n\n1.0.1 (2016-09-20)\n------------------\n\n- Change German translation for event listing block. [jone]\n\n- Fix AttributeError in create_event_listing_block. [jone]\n\n- Added action for ics export. [tschanzt]\n\n\n1.0.0 (2016-08-02)\n------------------\n\n- Fixed bug where default value on eventlistingblock was not set. [lknoepfel]\n\n- Added ftw.calendar integration. [lknoepfel]\n\n- Don't list EventPage in the navigation [lkoepfel]\n\n- Initial implementation [jone]",
"bugtrack_url": null,
"license": "GPL2",
"summary": "Events with simplelayout.",
"version": "1.16.0",
"project_urls": {
"Homepage": "https://github.com/4teamwork/ftw.events"
},
"split_keywords": [
"ftw",
"events"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3a1844a2c43bceb9409fb0250a2fe96946249fdf61d4901661b905ae7e83f96e",
"md5": "9ba3489067c066cc9c46d2ece5110b4b",
"sha256": "1f9447db6d65fe96444849f7cb4cf4ab8594737e806ec7c3fa6cae185df60fea"
},
"downloads": -1,
"filename": "ftw.events-1.16.0.tar.gz",
"has_sig": false,
"md5_digest": "9ba3489067c066cc9c46d2ece5110b4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 68374,
"upload_time": "2023-08-25T15:47:04",
"upload_time_iso_8601": "2023-08-25T15:47:04.054687Z",
"url": "https://files.pythonhosted.org/packages/3a/18/44a2c43bceb9409fb0250a2fe96946249fdf61d4901661b905ae7e83f96e/ftw.events-1.16.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-25 15:47:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "4teamwork",
"github_project": "ftw.events",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "ftw.events"
}
JSON
