Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 4.82 KB

README.rst

File metadata and controls

103 lines (68 loc) · 4.82 KB

Introduction

Plonesocial.activitystream is part of the ploneintranet suite.

This package, ploneintranet.activitystream, provides a building block for Plone integrators who want to create a custom social business solution in Plone.

If you're an end-user looking for a pre-integrated solution, you should install ploneintranet.suite instead.

Credits

Cosent

This package is maintained by Cosent.

ploneintranet.activitystream

Plonesocial.activitystream uses the view @@stream view (provided by ploneintranet.core) on the SiteRoot.

If you have installed ploneintranet.network as well, and hit @@stream/network it will show only updates of people you're following.

A navigation bar is provided which detects the presence of ploneintranet.network, as well as local workspaces that provide a local microblog, and displays nagivation options suitable for the context.

Plonesocial.activitystream also provides an "Activity Portal" view for the SiteRoot. The Activity Portal view renders a portletmanager viewlet in which you can add an "Activity Stream" portlet (and also a "Microblog" portlet if you installed ploneintranet.microblog. This may look like a complex construct but it provides integrators with easy customization flex points, and it provides content managers with maximal control over what is rendered where, and in which sequence. Moreover by using a portlet for rendering, content managers can set various rendering options. You can re-use the viewlet, or the portlet, as you see fit using ZCML overrides. YMMV.

The core rendering component, which is used by all views, is the stream_provider content provider. Extracting the display logic to a separate content provider promotes re-use. activitystream_provider fetches ploneintranet.microblog updates, if microblog is installed. It merges those with content creations and plone.app.discussion replies fetched from ZCatalog. If ploneintranet.network is installed, it will filter the activity stream by "following" subscription.

To enable loose coupling, ploneintranet.activitystream does not depend on ploneintranet.microblog or ploneintranet.network. Instead, it probes if those components are installed and available, or not. Depending on the availability of those other ploneintranet components, ploneintranet.activitystream adapts its behavior.

Plonesocial.activitystream looks nicer if you also install ploneintranet.theme.

Build status

Unit tests

https://secure.travis-ci.org/cosent/ploneintranet.activitystream.png http://jenkins.ploneintranet.net/buildStatus/icon?job=Plone%20Social%20Activitystream

Robot tests for Plone Social and Plone Intranet

http://jenkins.ploneintranet.net/buildStatus/icon?job=Plone%20Social%20Suite http://jenkins.ploneintranet.net/buildStatus/icon?job=Plone%20Intranet%20Suite%20Master

Roadmap

An extensive roadmap for the ploneintranet suite is available on github.

Copyright (c) Plone Foundation

This package is Copyright (c) Plone Foundation.

Any contribution to this package implies consent and intent to irrevocably transfer all copyrights on the code you contribute, to the Plone Foundation, under the condition that the code remains under a OSI-approved license.

To contribute, you need to have signed a Plone Foundation contributor agreement. If you're listed on Github as a member of the Plone organization, you already signed.