plone.app.event - a calendar framework for Plone

Overview

plone.app.event is a new calendar framework for Plone.

Features:

• Dexterity behaviors and Archetypes type,

• Timezone support,

• Recurring Events,

• Whole day events,

• Open end events (End on the same day),

• Icalendar export,

• Icalendar import,

• Better calendar and events portlets,

• An event listing and event detail view.

It was developed with these goals in mind:

• Encapsulation and independence: All event related code should reside in a single package. Relevant, re-usable functionality is split to seperate packages. Plone’s dependencies on calendar related code should be reduced to a minimum. plone.app.event should be able to be deinstalled from Plone.

• Dexterity and Archetypes support: plone.app.event should provide Dexterity behaviors, which can be used in Dexterity types and an ATEvent content type (factored out from ATContentTypes). For a Dexterity event type, use plone.app.contenttypes 1.1 or newer.

• Standards compliancy: We support the icalendar standard (RFC5545) including recurrence.

• Recurring events based on the RFC5545 standard.

Documentation

• Installation
  • Upgrading from plone.app.event 1.x
  • Configuration
• Architectural Overview
  • Design goals
  • Packages
  • Other, external packages
• Developer documentation
  • The IEvent interface
  • Custom event content types
  • Getting and setting properties
  • Getting occurrences from IEventRecurrence implementing objects
  • Reusing the @@event_summary view to list basic event information
• Running tests
• Development design choices

API documentation

• plone.app.event API
  • plone.app.event.base
    • AnnotationAdapter
    • DT()
    • PatchedDateTime
      • PatchedDateTime.strftime()
    • construct_calendar()
    • dates_for_display()
    • default_end()
    • default_start()
    • default_timezone()
    • dt_end_of_day()
    • dt_start_of_day()
    • expand_events()
    • filter_and_resort()
    • find_context()
    • first_weekday()
    • get_events()
    • guess_date_from()
    • localized_now()
    • localized_today()
    • spell_date()
    • start_end_from_mode()
    • start_end_query()
    • ulocalized_time()
    • wkday_to_mon0()
    • wkday_to_mon1()
  • plone.app.event.interfaces
  • plone.app.event.recurrence
    • EventOccurrenceAccessor
    • ImageScalingViewFactory
    • Occurrence
    • OccurrenceTraverser
    • RecurrenceSupport
      • RecurrenceSupport.occurrences()
  • plone.app.event.browser.event_listing
    • EventEventListing
    • EventListing
    • EventListingIcal
  • plone.app.event.browser.event_summary
    • EventSummaryView
      • EventSummaryView.next_occurrences
      • EventSummaryView.num_more_occurrences
  • plone.app.event.browser.event_view
    • EventView
  • plone.app.event.browser.formatted_date
    • FormattedDateProvider
    • FormattedStartDateProvider
  • plone.app.event.browser.leadimage_viewlet
    • LeadImageViewlet
  • plone.app.event.dx.behaviors
    • EventAccessor
      • EventAccessor.timezone
    • StartBeforeEnd
    • default_end()
    • default_start()
  • plone.app.event.dx.interfaces
  • plone.app.event.dx.traverser
    • OccurrenceTraverser
  • plone.app.event.ical.exporter
    • EventsICal
    • ICalendarEventComponent
      • ICalendarEventComponent.geo
    • add_to_zones_map()
    • calendar_from_collection()
    • calendar_from_container()
    • calendar_from_event()
    • construct_icalendar()
  • plone.app.event.ical.importer
    • IcalendarImportSettings
    • IcalendarImportSettingsForm
      • IcalendarImportSettingsForm.getContent()
    • IcalendarImportSettingsFormView
      • IcalendarImportSettingsFormView.disable()
      • IcalendarImportSettingsFormView.enable()
      • IcalendarImportSettingsFormView.form
    • IcalendarImportTool
    • no_file_protocol_url()