Metadata-Version: 1.1
Name: ftw.activity
Version: 1.1.3
Summary: An activity feed for Plone.
Home-page: https://github.com/4teamwork/ftw.activity
Author: 4teamwork AG
Author-email: mailto:info@4teamwork.ch
License: GPL2
Description: ftw.activity
        ===============
        
        ``ftw.activity`` provides a view with an activity stream for Plone.
        
        .. image:: https://raw.githubusercontent.com/4teamwork/ftw.activity/master/docs/screenshot.png
        
        
        How it works
        ============
        
        The feed is based on a simple catalog query restricted to the current
        context, ordered by modified date so that the newest modifications are
        on top.
        
        **Limitations:**
        
        - The ordering by modified date is not exactly accurate since the
          precision of the catalog index is only down to the minute.
        - Since it is based on a catalog query each object only appears once
          even when it is edited multiple times in a row.
        - Only existing objects are listed, so deleting objects will not appear
          in the feed at all.
        - Only actions which change the modification date are covered.
        - We do not register any links or actions, so that you can integrate
          it into Plone as you like. See the usage sections.
        
        
        Usage
        =====
        
        
        - Add ``ftw.activity`` as dependency to your package (``setup.py``) or
          to your buildout configuration:
        
        ::
        
            [instance]
            eggs +=
                ftw.activity
        
        - Install the generic import profile in Plone's addons control panel.
        
        Once the package is installed there is no link to the view.
        The view is available as ``/activity`` on any context, so you might
        want to place a link anywhere you like or add an action.
        
        For collections, ``ftw.activity`` registers an ``Activity`` view which
        can be selected as default view. Just make sure to sort the collection
        by modification date and reverse it for best experience.
        
        ``ftw.activity`` also registers an
        `ftw.tabbedview <https://github.com/4teamwork/ftw.tabbedview>`_
        tab with the name ``tabbedview_view-activity``.
        
        
        Custom event representations
        ============================
        
        By default the each event is represented by some metadata
        (e.g. author with portrait, action, etc) and the title of the modified
        object.
        
        If you'd like to display more information you can do this by registering
        a custom representation adapter in your custom code.
        
        Register the adapter in your ZCML:
        
        .. code:: xml
        
          <adapter factory=".activity.IssueResponseRepresentation"
                   for="..interfaces.IIssueResponse *"
                   provides="ftw.activity.interfaces.IActivityRepresentation"
                   />
        
        create the adapter class (example `./activity.py`):
        
        .. code:: python
        
          from ftw.activity.browser.representations import DefaultRepresentation
          from Products.Five.browser.pagetemplatefile import ViewPageTemplateFile
        
          class IssueResponseRepresentation(DefaultRepresentation):
              index = ViewPageTemplateFile('templates/issue_representation.pt')
        
              # helper methods when needed
        
        and a template (example `./templates/issue_representation.pt`):
        
        .. code:: html
        
          <metal:wrapper use-macro="context/@@activity_macros/macros/event">
            <metal:CONTENT fill-slot="body-content">
        
              <div class="issue-text"
                   tal:content="context/text" />
        
            </metal:CONTENT>
          </metal:wrapper>
        
        take a look at the
        `activity_macros <https://github.com/4teamwork/ftw.activity/blob/master/ftw/activity/browser/templates/activity_macros.pt>`_
        for details on what slots you can fill.
        
        
        
        Links
        -----
        
        - github: https://github.com/4teamwork/ftw.activity
        - pypi: http://pypi.python.org/pypi/ftw.activity
        - CI: https://jenkins.4teamwork.ch/search?q=ftw.activity
        
        
        Copyright
        ---------
        
        This package is copyright by `4teamwork <http://www.4teamwork.ch/>`_.
        
        ``ftw.activity`` is licensed under GNU General Public License, version 2.
        
        Changelog
        =========
        
        
        1.1.3 (2014-11-18)
        ------------------
        
        - Fixes a bug where the activity view crashed when the modifying user is no
          longer available.
          [mbaechtold]
        
        
        1.1.2 (2014-09-24)
        ------------------
        
        - Ignore comments in activity view.
          Fixes a bug where the activity view crashed when comments were added.
          [jone]
        
        
        1.1.1 (2014-09-24)
        ------------------
        
        - Empty brown-bag release.
        
        1.1.0 (2014-09-04)
        ------------------
        
        - Add support for collections.
          [jone]
        
        
        1.0.0 (2014-09-03)
        ------------------
        
        - Initial implementation.
        
Keywords: ftw activity feed
Platform: UNKNOWN
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.3
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
