sc.contentrules.group 1.0b1

**************************************
Content Rules: User group actions
**************************************

.. contents:: Content
:depth: 2

Overview
--------

**Content Rules: User group actions** (sc.contentrules.group) package provides
content rule actions to create or remove an user group.

This package is tested with Travis CI:

.. image:: https://secure.travis-ci.org/simplesconsultoria/sc.contentrules.group.png
:target: http://travis-ci.org/simplesconsultoria/sc.contentrules.group

Use case
---------

A college with descentralized content management and groups dedicated to research. Each group should manage its own content.

In their portal they want to host areas for each research group they sponsor.
All those areas will be under the folder /research/. A research group called
"Environmental Studies" will have an area at /research/environmental-studies.

Every time a new research group is added under /research/ they need to create at
least two user groups:

* Editors: Group of users responsible for publishing content and managing
this area.

* Members: Group of users with access to this area.

Also, every time a research group is removed from /research/ they want to remove
existing user groups related to it.


Actions
---------

This package provides two content rules actions, one to create a new user
group, other to remove an existing user group.

Create User Group
^^^^^^^^^^^^^^^^^^^

Used to create a new user group this action have three options:

Group Id
Unique name for the newly created group. You are allowed to use ${title} in
here to dinamically generate the id for the group. i.e.: If this field have
a value of **${title} Editors** and the action is being executed for a
folder with title "Environmental Studies", Group Id will be
"Environmental Studies Editors"

Group Title
Friendly name for the newly created group. You are allowed to use ${title}
in here to dinamically create the id for the group. i.e.: If this field
have a value of **Editors for Research Group: ${title}** and the action is
being executed for a folder with title "Environmental Studies", Group Title
will be "Editors for Research Group: Environmental Studies"

Roles
Global roles for newly created group. Roles selected here will be effective
in the whole portal.

.. note:: In order to apply a local role -- set a role for the newly created
group only in the object that triggered the content rule -- you need
to have the **sc.contentrules.localrole** package installed and use
the package's provided action.


Remove User Group
^^^^^^^^^^^^^^^^^^^

Used to remove an existing user group this action have just one option:

Group Id
Id of the group to be removed. You are allowed to use ${title} in
here to dinamically generate the id for the group. i.e.: If this field have
a value of **${title} Editors** and the action is being executed for a
folder with title "Environmental Studies", Group Id will be
"Environmental Studies Editors"


Requirements
------------

* Plone 3.3.x and above (http://plone.org/products/plone)

Installation
------------

To enable this product,on a buildout based installation:

1. Edit your buildout.cfg and add ``sc.contentrules.group``
to the list of eggs to install ::

[buildout]
...
eggs =
sc.contentrules.group

After updating the configuration you need to run the ''bin/buildout'',
which will take care of updating your system.


Sponsoring
----------

Development of this product was sponsored by:

* `Simples Consultoria <http://www.simplesconsultoria.com.br/>`_.

* `IEA/USP <http://www.iea.usp.br/>`_.


Credits
-------

* Erico Andrei (erico at simplesconsultoria dot com dot br)

* Héctor Velarde (hector at simplesconsultoria dot com dot br)

Changelog
----------------

1.0b1 (2012-10-30)
^^^^^^^^^^^^^^^^

* Add an action to remove existing user groups [ericof]

* PEP8 [ericof]

* Travis support [ericof]

0.5 (2011-09-15)
^^^^^^^^^^^^^^^^^^

* Spanish translation [hvelarde]

* Initial release [erico_andrei]