modules/aclfield/README.txt

(// $Id$

ACL Field

The ACL (Access Control List) Field module attempts to pull together many disparate access control systems into a single, consistent interface. ACL Field decouples the granting of permissions from the setting of permission levels. Modules still control which grants are available (e.g roles, membership in Organic Groups, being in a buddylist), but the setting of permission levels (view, update, and delete) is done by a user via the node edit form.

INSTALLATION

This module requires CCK. No other modules are necessary. Enable on your modules administration page.

Hopefully, more modules will implement the hooks ACL Field generates (more on this below) and make more functionality available to users. It is strongly recommended that you turn other access control mechanisms off, though it is not strictly necessary. The results might be, *ahem*, unpredictable.

ACL Field is only 5.0 compatible.

USAGE

To use ACL Field, install as described above.

Go to admin/content/types and choose a content type to work on. Add a field. Select the ACL Field option. You probably want the "Standard" widget option to begin with. Give your field name. You probably want to select "multiple" in the field data settings.

Go to create/content and click on the content type you modified. In the, ACL Field, select a permission type to add to this node's access control list. For example, select User Roles. The page will refresh and you will have a new addition to your form listing out the possible roles and a default permission of "view" selected. You may choose "no permissions", "view", "view and edit", or "view, edit & delete" as possible permissions.

When you save your node, the role(s) you have selected will be given the access permissions you chose.

ADVANCED USAGE

(coming soon)

MODULE DEVELOPERS

There are several hooks that this module creates which your modules can implement to become part of the ACL Field system. I will be detailing them in a more complete document soon.

FUTURE DEVELOPMENT

I may rewrite this module as a nodeapi module instead of a CCK field. The jury is still out which would be better for this purpose.


1	(// $Id$
2
3	ACL Field
4
5	The ACL (Access Control List) Field module attempts to pull together many disparate access control systems into a single, consistent interface. ACL Field decouples the granting of permissions from the setting of permission levels. Modules still control which grants are available (e.g roles, membership in Organic Groups, being in a buddylist), but the setting of permission levels (view, update, and delete) is done by a user via the node edit form.
6
7	INSTALLATION
8
9	This module requires CCK. No other modules are necessary. Enable on your modules administration page.
10
11	Hopefully, more modules will implement the hooks ACL Field generates (more on this below) and make more functionality available to users. It is strongly recommended that you turn other access control mechanisms off, though it is not strictly necessary. The results might be, ahem, unpredictable.
12
13	ACL Field is only 5.0 compatible.
14
15	USAGE
16
17	To use ACL Field, install as described above.
18
19	Go to admin/content/types and choose a content type to work on. Add a field. Select the ACL Field option. You probably want the "Standard" widget option to begin with. Give your field name. You probably want to select "multiple" in the field data settings.
20
21	Go to create/content and click on the content type you modified. In the, ACL Field, select a permission type to add to this node's access control list. For example, select User Roles. The page will refresh and you will have a new addition to your form listing out the possible roles and a default permission of "view" selected. You may choose "no permissions", "view", "view and edit", or "view, edit & delete" as possible permissions.
22
23	When you save your node, the role(s) you have selected will be given the access permissions you chose.
24
25	ADVANCED USAGE
26
27	(coming soon)
28
29	MODULE DEVELOPERS
30
31	There are several hooks that this module creates which your modules can implement to become part of the ACL Field system. I will be detailing them in a more complete document soon.
32
33	FUTURE DEVELOPMENT
34
35	I may rewrite this module as a nodeapi module instead of a CCK field. The jury is still out which would be better for this purpose.
36
37
38