https://github.com/collective/collective.workspace

Restricted workspaces for Plone
https://github.com/collective/collective.workspace

Last synced: about 1 month ago
JSON representation

Restricted workspaces for Plone

• Host: GitHub
• URL: https://github.com/collective/collective.workspace
• Owner: collective
• Created: 2013-06-13T05:10:18.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-02-21T10:28:02.000Z (almost 2 years ago)
• Last Synced: 2024-11-02T17:36:27.944Z (about 1 month ago)
• Language: Python
• Size: 325 KB
• Stars: 7
• Watchers: 119
• Forks: 11
• Open Issues: 6
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst

Awesome Lists containing this project

• awesome-plone - collective.workspace - Easily manage 'membership' in specific areas of a Plone Site. It allows to grant people access to areas of content using a membership group rather than local roles for each user, and to delegate control over that group to people who don't have access to the site-wide user/group control panel. (Content and utilities for content)

README

        
.. image:: https://github.com/collective/collective.workspace/workflows/tests/badge.svg

    :target: https://github.com/collective/collective.workspace/actions?query=workflow%3Atests

collective.workspace

====================

Introduction

------------

collective.workspace package for providing 'membership' in specific areas of a Plone Site.

It allows you to grant people access to areas of content using a membership group rather than local roles for each user, and to delegate control over that group to people who don't have access to the site-wide user/group control panel.

collective.workspace provides a ``collective.workspace.team_workspace`` behavior that can be enabled for any Dexterity content type. When enabled, it adds a "Roster" tab which is where you can manage the team.

All the functionality takes place via an IWorkspace adapter, which can be overridden to specify:

* A list of groups, and the roles that each group should receive. These groups are created automatically via a PAS plugin, and automatically granted local roles using a borg.localrole adapter.

* The schema for which fields should be stored for each member in the roster. This includes checkboxes for the groups, to determine which groups the member is in.

* Action links for each row in the roster. The default is an "Edit" link which brings up a popup to edit the fields for that person's roster membership.

* Action buttons at the bottom of the roster which apply to the rows the user selects. An example of this could be a 'Send email' action, so a roster admin can easily email users in the roster.

Unlike similar previous packages (see slc.teamfolder and collective.local.*), collective.workspace supplies its own PAS groups plugin, instead of using standard Plone groups. This means that you can prevent Workspace-specific groups from appearing in the sitewide group control panel.

Some other features are:

* Membership in a roster is indexed, so you can search the catalog for items of portal_type X that have a particular user in their roster.

* Events are fired when roster memberships are added/modified/removed.

Basic Installation

------------------

* Add collective.workspace to your buildout eggs.

* Install collective.workspace in the 'Add-ons' section of Plone's Site Setup.

* Enable the behaviour on your dexterity content type (Either using GenericSetup or Site Setup -> Dexterity Content Types).

Compatibility

-------------

For Plone 5.1 and 5.2 you should use version 3.x.

For Plone 4.3 and 5.0 you should use version 2.x.

Custom Workspace Groups

-----------------------

The default groups available on a workspace are 'Guests', 'Members', and 'Admins'.

You can customise the groups that are available editing the registry record ``collective.workspace.available_groups``.