modules/og_user_roles/README.txt

/* $Id: README.txt,v 1.28 2009/01/16 20:39:16 sun Exp $ */

-- SUMMARY --

OG User Roles allows group administrators of organic groups to grant additional
user roles to individual members of a certain group.

Any additional permissions only apply within the context of this group and not
globally. This means that the additional user roles to grant are determined and
assigned by the requested page; e.g. node/123 belongs to group XYZ for which
the user was granted additional roles. If the user goes to another page that
does not belong to the same group, the additional user roles are no longer
assigned.

Additional user roles can only be granted, not revoked.

Site administrators may also configure a default user role for new group members
or a default user role for new group admins.

For a full description of the module, visit the project page:
  http://drupal.org/project/og_user_roles

To submit bug reports and feature suggestions, or to track changes:
  http://drupal.org/project/issues/og_user_roles


-- REQUIREMENTS --

* Organic Groups and OG Views modules.


-- INSTALLATION --

* Install as usual, see http://drupal.org/node/70151 for further information.


-- CONFIGURATION --

* Configure user permissions in Administer >> User management >> Permissions >>
  og_user_roles module:

  - configure member roles

    Users in roles with the "configure member roles" permission are able to
    assign user roles to group members.

* Configure user permissions in Administer >> User management >> Permissions >>
  og module:

  - administer organic groups

    Users in roles with the "administer organic groups" permission are able to
    configure global OG User Roles settings that apply to all groups.

* Go to Administer >> Organic Groups >> User roles and configure:

  - Assignable roles

    Enable the user roles group admins should be able to grant group members.
    Make sure you granted appropriate permissions to the selected user roles.
    The enabled user roles will be assignable to other users in a group by
    non-site admins.  Thereby you should be conservative in what permissions you
    grant.  E.g. 'create' permissions for a certain content-type or similar.

  - Default role for new group administrators

    Optionally select a user role to automatically assign to new group admins.
    The user role is specific to the groups in which the user is a group
    administrator.  That is, the user will only be granted the role in the group
    he/she is an administrator for.

  - Default role for new group members

    Optionally select a user role to automatically assign to new group members.

  Note that all default roles only apply to new members that join a group and
  not to existing group admins and members.


-- USAGE --

* As a group administrator, go to the group home page.  In the group navigation
  menu block you should see a link titled:

    # subscribers

  That will display the group member list on which you should see the tab
  "Configure roles", which allows group administrators having the "configure
  member roles" permission to assign additional user roles to individual group
  members.


-- NOTES --

* Additionally granted user roles and permissions only take effect within the
  context of a group.  If you want to grant site-wide permissions to a user,
  then you have to grant the regular user role on user/#/edit.


-- CONTACT --

Current maintainers:
* Ron Parker (SomebodySysop) - http://drupal.org/user/61637
* Daniel F. Kudwien (sun) - http://drupal.org/user/54136

Major rewrite into 4.x by Daniel F. Kudwien (sun).

This project has been sponsored by:
* IofC - Initiatives of Change
  Visit http://www.iofc.org for more information.

* Software Creations
  Visit http://www.scbbs.com for more information.

* UNLEASHED MIND
  Specialized in consulting and planning of Drupal powered sites, UNLEASHED
  MIND offers installation, development, theming, customization, and hosting
  to get you started. Visit http://www.unleashedmind.com for more information.

1	/* $Id: README.txt,v 1.28 2009/01/16 20:39:16 sun Exp $ */
2
3	-- SUMMARY --
4
5	OG User Roles allows group administrators of organic groups to grant additional
6	user roles to individual members of a certain group.
7
8	Any additional permissions only apply within the context of this group and not
9	globally. This means that the additional user roles to grant are determined and
10	assigned by the requested page; e.g. node/123 belongs to group XYZ for which
11	the user was granted additional roles. If the user goes to another page that
12	does not belong to the same group, the additional user roles are no longer
13	assigned.
14
15	Additional user roles can only be granted, not revoked.
16
17	Site administrators may also configure a default user role for new group members
18	or a default user role for new group admins.
19
20	For a full description of the module, visit the project page:
21	http://drupal.org/project/og_user_roles
22
23	To submit bug reports and feature suggestions, or to track changes:
24	http://drupal.org/project/issues/og_user_roles
25
26
27	-- REQUIREMENTS --
28
29	* Organic Groups and OG Views modules.
30
31
32	-- INSTALLATION --
33
34	* Install as usual, see http://drupal.org/node/70151 for further information.
35
36
37	-- CONFIGURATION --
38
39	* Configure user permissions in Administer >> User management >> Permissions >>
40	og_user_roles module:
41
42	- configure member roles
43
44	Users in roles with the "configure member roles" permission are able to
45	assign user roles to group members.
46
47	* Configure user permissions in Administer >> User management >> Permissions >>
48	og module:
49
50	- administer organic groups
51
52	Users in roles with the "administer organic groups" permission are able to
53	configure global OG User Roles settings that apply to all groups.
54
55	* Go to Administer >> Organic Groups >> User roles and configure:
56
57	- Assignable roles
58
59	Enable the user roles group admins should be able to grant group members.
60	Make sure you granted appropriate permissions to the selected user roles.
61	The enabled user roles will be assignable to other users in a group by
62	non-site admins. Thereby you should be conservative in what permissions you
63	grant. E.g. 'create' permissions for a certain content-type or similar.
64
65	- Default role for new group administrators
66
67	Optionally select a user role to automatically assign to new group admins.
68	The user role is specific to the groups in which the user is a group
69	administrator. That is, the user will only be granted the role in the group
70	he/she is an administrator for.
71
72	- Default role for new group members
73
74	Optionally select a user role to automatically assign to new group members.
75
76	Note that all default roles only apply to new members that join a group and
77	not to existing group admins and members.
78
79
80	-- USAGE --
81
82	* As a group administrator, go to the group home page. In the group navigation
83	menu block you should see a link titled:
84
85	# subscribers
86
87	That will display the group member list on which you should see the tab
88	"Configure roles", which allows group administrators having the "configure
89	member roles" permission to assign additional user roles to individual group
90	members.
91
92
93	-- NOTES --
94
95	* Additionally granted user roles and permissions only take effect within the
96	context of a group. If you want to grant site-wide permissions to a user,
97	then you have to grant the regular user role on user/#/edit.
98
99
100	-- CONTACT --
101
102	Current maintainers:
103	* Ron Parker (SomebodySysop) - http://drupal.org/user/61637
104	* Daniel F. Kudwien (sun) - http://drupal.org/user/54136
105
106	Major rewrite into 4.x by Daniel F. Kudwien (sun).
107
108	This project has been sponsored by:
109	* IofC - Initiatives of Change
110	Visit http://www.iofc.org for more information.
111
112	* Software Creations
113	Visit http://www.scbbs.com for more information.
114
115	* UNLEASHED MIND
116	Specialized in consulting and planning of Drupal powered sites, UNLEASHED
117	MIND offers installation, development, theming, customization, and hosting
118	to get you started. Visit http://www.unleashedmind.com for more information.
119