You are here

README.txt in Module Grants 6

Same filename and directory in other branches
  1. 6.4 README.txt
  2. 6.3 README.txt
  3. 7 README.txt
DESCRIPTION
===========
This module gets around two quirks in the 6.x core Node module. 
Currently the Node module:
- causes access grants to be ignored for unpublished content;
- ORs together access grants coming from multiple modules; this results
  in content being made accessible by one module when access had already
  been restricted by another, which is undesirable in most cases.

The module ensures that access grants are tested for unpublished content just 
as they are for published content, so that using the Workflow module (or any 
other module that uses the node_access table) you can implement workflows that 
deal effectively with content moving from author via moderator to publisher 
BEFORE it is published (which is where it's needed most, once content is 
visible for all to see, it's a bit late to start a publication workflow 
process!).
Using Taxonomy Access Control (or Lite) you can restrict access to content
to user-defined "vocabularies" such as departments or regions. With Module
Grants this will work for unpublished content just as it does for published 
content.
Moreover when Workflow and TAC or (TAC-Lite) are used together this module
makes sure that the combination exhibits the expected behaviour: access is
granted to content only when it is in the correct state AND of the appropriate
vocabulary "term" (such as department, country, etc.).
The module_grants module achieves this by AND-ing rather than OR-ing the grants.

After installation users will have access to a new menu item, "My content" that 
shows a list of all content accessible to them based on their permissions and 
access grants as determined by enabled modules implementing hook_node_grants().

INSTALLATION
============
1. Place the "module_grants" folder in your "sites/all/modules" directory.
2. Enable the module under Administer >> Site building >> Modules.
3. Under Administer >> User management >> Permissions, section "module_grants
   module" tick the "access content summary" box for "authenticated user".
   There's usually no need to tick "administer nodes", which is good because
   "administer nodes" equates to almost god-like powers that you wouldn't 
   normally give to normal users.
4. If required, install and enable as many modules for content access control 
   as you need for your situation. Typical examples are Taxonomy Access Control
   (or use TAC Lite) and Workflow.

USAGE
=====
The module creates a new root menu item, 'My content' visible to the
administrator and to roles that have the "access content summary" permission. 
These users will see two new tabs:
 o "Viewable" shows all nodes that may be viewed by the logged-in user as
   granted by enabled modules that implement hook_node_grants()
 o "Editable" shows all nodes that may be edited by the logged-in user
 
You can use this module in combination with TAC or TAC-Lite for fine-grained
access control based on vocabularies (such as "department") assigned to the 
various content types. You can then create department-specific roles (eg 
Sports Author, Music Author) and enforce that these roles can only access
content belonging to their departments, whether it's published or not.
Create your grants "schemes" on this page: Administer >> User management >> 
Access control by taxonmy.

In addition you may want to install the Workflow module to further segragate
roles (eg author and moderator) via access control based on states such as
"in draft", "in review" and "published". See Administer >> Site building >>
Workflow.

The module makes sure that access to content is given only when both the 
TAC (Lite) and the Workflow Access modules grant it (as opposed to one OR
the other).

Be aware that any permissions given in the "node module" section override the
access grants given by the Workflow and TAC-Lite modules, so you probably only 
want to assign a few creation permissions in the node module and grant 
view, update and delete via TAC/TAC-Lite and/or Workflow.

This module also works well with the Revisioning module for creating effective
publication workflows operating on published as well as unpublished content
revisions. 

AUTHOR
======
Rik de Boer, IBS, Melbourne, Australia.

File

README.txt
View source
  1. DESCRIPTION
  2. ===========
  3. This module gets around two quirks in the 6.x core Node module.
  4. Currently the Node module:
  5. - causes access grants to be ignored for unpublished content;
  6. - ORs together access grants coming from multiple modules; this results
  7. in content being made accessible by one module when access had already
  8. been restricted by another, which is undesirable in most cases.
  9. The module ensures that access grants are tested for unpublished content just
  10. as they are for published content, so that using the Workflow module (or any
  11. other module that uses the node_access table) you can implement workflows that
  12. deal effectively with content moving from author via moderator to publisher
  13. BEFORE it is published (which is where it's needed most, once content is
  14. visible for all to see, it's a bit late to start a publication workflow
  15. process!).
  16. Using Taxonomy Access Control (or Lite) you can restrict access to content
  17. to user-defined "vocabularies" such as departments or regions. With Module
  18. Grants this will work for unpublished content just as it does for published
  19. content.
  20. Moreover when Workflow and TAC or (TAC-Lite) are used together this module
  21. makes sure that the combination exhibits the expected behaviour: access is
  22. granted to content only when it is in the correct state AND of the appropriate
  23. vocabulary "term" (such as department, country, etc.).
  24. The module_grants module achieves this by AND-ing rather than OR-ing the grants.
  25. After installation users will have access to a new menu item, "My content" that
  26. shows a list of all content accessible to them based on their permissions and
  27. access grants as determined by enabled modules implementing hook_node_grants().
  28. INSTALLATION
  29. ============
  30. 1. Place the "module_grants" folder in your "sites/all/modules" directory.
  31. 2. Enable the module under Administer >> Site building >> Modules.
  32. 3. Under Administer >> User management >> Permissions, section "module_grants
  33. module" tick the "access content summary" box for "authenticated user".
  34. There's usually no need to tick "administer nodes", which is good because
  35. "administer nodes" equates to almost god-like powers that you wouldn't
  36. normally give to normal users.
  37. 4. If required, install and enable as many modules for content access control
  38. as you need for your situation. Typical examples are Taxonomy Access Control
  39. (or use TAC Lite) and Workflow.
  40. USAGE
  41. =====
  42. The module creates a new root menu item, 'My content' visible to the
  43. administrator and to roles that have the "access content summary" permission.
  44. These users will see two new tabs:
  45. o "Viewable" shows all nodes that may be viewed by the logged-in user as
  46. granted by enabled modules that implement hook_node_grants()
  47. o "Editable" shows all nodes that may be edited by the logged-in user
  48. You can use this module in combination with TAC or TAC-Lite for fine-grained
  49. access control based on vocabularies (such as "department") assigned to the
  50. various content types. You can then create department-specific roles (eg
  51. Sports Author, Music Author) and enforce that these roles can only access
  52. content belonging to their departments, whether it's published or not.
  53. Create your grants "schemes" on this page: Administer >> User management >>
  54. Access control by taxonmy.
  55. In addition you may want to install the Workflow module to further segragate
  56. roles (eg author and moderator) via access control based on states such as
  57. "in draft", "in review" and "published". See Administer >> Site building >>
  58. Workflow.
  59. The module makes sure that access to content is given only when both the
  60. TAC (Lite) and the Workflow Access modules grant it (as opposed to one OR
  61. the other).
  62. Be aware that any permissions given in the "node module" section override the
  63. access grants given by the Workflow and TAC-Lite modules, so you probably only
  64. want to assign a few creation permissions in the node module and grant
  65. view, update and delete via TAC/TAC-Lite and/or Workflow.
  66. This module also works well with the Revisioning module for creating effective
  67. publication workflows operating on published as well as unpublished content
  68. revisions.
  69. AUTHOR
  70. ======
  71. Rik de Boer, IBS, Melbourne, Australia.