You are here

README.txt in Subgroups for Organic groups 6

--------------------------
DESCRIPTION
--------------------------
This module enables a user with the proper permissions to build group 
hierarchies (or tree) by nesting groups under other groups. Simple or complex
group hierarchies can be easily created.

When a hierarchy has been established, user memberships and/or content posted
to a group can be propagated up, down or sideways along the tree. So when a
user joins a group, their membership can also get created in other parent,
child or sibling groups. Separate propagation settings can be applied for
content and membership propagation.  

Admin rights, both promotion and demotion, can also propagate to other groups
so a group admin of one group can automatically become an admin at other 
groups depending on the propagation settings.

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

--------------------------
DEPENDENCIES
--------------------------
Subgroups for Organic Groups requires the following modules to also be
installed:
 - Organic Groups (http://drupal.org/project/og)

--------------------------
SETUP
--------------------------
  1. After installation, configure permissions:
     Administer > User management > Permissions > og_subgroup module
     Refer to the PERMISSIONS section below.

  2. Go to the admin settings page (admin/og/subgroups).

  3. Configure the settings as appropriate:
     - Content Propagation:
       Propagate content up (parents), down (children) or sideways
       (siblings). Leaving all checkboxes unchecked means that content will
       not be propagated.

     - Subscribing Members
       Propagate user memberships up (parents), down (children) or sideways
       (siblings). Leaving all checkboxes unchecked means that memberships
       will not be propagated.

     - Unsubscribing Members
       Propagate user memberships removal up (parents), down (children) or
       sideways (siblings). Leaving all checkboxes unchecked means that
       propagation will not happen when unsubscribing memberships.

     - User demotion
       ...

  4. (optional) Go to admin/build/block and enable the Subgroups block.
     This block only shows up when in the context of a group and displays the
     hierarchy for navigation purposes.

  5. Create a group content type, referr to the OG module's README.txt file.

  6. Create a new group node by going to the node/add form. There will be a
     Subgroups fieldset where you can designate a parent group.

--------------------------
PERMISSIONS
--------------------------
  - 'administer groups hierarchy'
    Grant users the privilege to access the module's administrative
    settings page (admin/og/subgroups)

  - 'edit groups hierarchy'
    Grant users the privilege to create and edit hierarchies

--------------------------
Documentation
--------------------------
http://drupal.org/node/267277 - legacy docs. updated docs to come...

--------------------------
MODULES
--------------------------
Subgroups ships with the following sub modules. View the README.txt file of
each sub module for futher details.
  - Hierarchical Select for Subgroups
  - OG Subgroups Context

--------------------------
BLOCKS
--------------------------
OG subgroups module provides a block called 'Subgroups' that shows the 
subgroups tree. The block takes into consideration cases where a user can't 
access a private group but still has access to the node/xxx/subgroups. In such
cases the group will appear as <private group>.

--------------------------
VIEWS
--------------------------
Subgroups has Views integration and provides some fields, arguments, sorts
and filters which are outlined below. The Views Tree module,
(http://drupal.org/project/views_tree), works great for displaying all or a
portion of the subgroup hierarchy in a tree format for blocks or pages display.

Fields:
  - Child Groups
    A list of direct children of a group

  - Parent Group ID
    The nid of the parent group

  - Parent Group Title
    The node title of the parent group

Arguments:
  - Group ID
    Using a group's nid as a starting point, get all group nodes along the
    subgroup path (up, down or sideways).

  - Group ID (for posts)
    Using a group's nid as a starting point, get content that has been posted
    to group nodes along the subgroup path (up, down, sideways).

  - Parent Group ID
    The group ID of a parent node. Filters for groups that has the specified
    parent. Similar to the 'child groups' field but returns each child as a
    separate row.

Sort:
  - Hierarchy Order
    Sort the groups or content by hierarchy order.

Filter:
  - Subgroups overrides the standard OG filter for posts and changes the
    group selector widget to display the groups in a tree format.

File

README.txt
View source
  1. --------------------------
  2. DESCRIPTION
  3. --------------------------
  4. This module enables a user with the proper permissions to build group
  5. hierarchies (or tree) by nesting groups under other groups. Simple or complex
  6. group hierarchies can be easily created.
  7. When a hierarchy has been established, user memberships and/or content posted
  8. to a group can be propagated up, down or sideways along the tree. So when a
  9. user joins a group, their membership can also get created in other parent,
  10. child or sibling groups. Separate propagation settings can be applied for
  11. content and membership propagation.
  12. Admin rights, both promotion and demotion, can also propagate to other groups
  13. so a group admin of one group can automatically become an admin at other
  14. groups depending on the propagation settings.
  15. --------------------------
  16. INSTALLATION
  17. --------------------------
  18. Install as usual, see http://drupal.org/node/70151 for further information.
  19. --------------------------
  20. DEPENDENCIES
  21. --------------------------
  22. Subgroups for Organic Groups requires the following modules to also be
  23. installed:
  24. - Organic Groups (http://drupal.org/project/og)
  25. --------------------------
  26. SETUP
  27. --------------------------
  28. 1. After installation, configure permissions:
  29. Administer > User management > Permissions > og_subgroup module
  30. Refer to the PERMISSIONS section below.
  31. 2. Go to the admin settings page (admin/og/subgroups).
  32. 3. Configure the settings as appropriate:
  33. - Content Propagation:
  34. Propagate content up (parents), down (children) or sideways
  35. (siblings). Leaving all checkboxes unchecked means that content will
  36. not be propagated.
  37. - Subscribing Members
  38. Propagate user memberships up (parents), down (children) or sideways
  39. (siblings). Leaving all checkboxes unchecked means that memberships
  40. will not be propagated.
  41. - Unsubscribing Members
  42. Propagate user memberships removal up (parents), down (children) or
  43. sideways (siblings). Leaving all checkboxes unchecked means that
  44. propagation will not happen when unsubscribing memberships.
  45. - User demotion
  46. ...
  47. 4. (optional) Go to admin/build/block and enable the Subgroups block.
  48. This block only shows up when in the context of a group and displays the
  49. hierarchy for navigation purposes.
  50. 5. Create a group content type, referr to the OG module's README.txt file.
  51. 6. Create a new group node by going to the node/add form. There will be a
  52. Subgroups fieldset where you can designate a parent group.
  53. --------------------------
  54. PERMISSIONS
  55. --------------------------
  56. - 'administer groups hierarchy'
  57. Grant users the privilege to access the module's administrative
  58. settings page (admin/og/subgroups)
  59. - 'edit groups hierarchy'
  60. Grant users the privilege to create and edit hierarchies
  61. --------------------------
  62. Documentation
  63. --------------------------
  64. http://drupal.org/node/267277 - legacy docs. updated docs to come...
  65. --------------------------
  66. MODULES
  67. --------------------------
  68. Subgroups ships with the following sub modules. View the README.txt file of
  69. each sub module for futher details.
  70. - Hierarchical Select for Subgroups
  71. - OG Subgroups Context
  72. --------------------------
  73. BLOCKS
  74. --------------------------
  75. OG subgroups module provides a block called 'Subgroups' that shows the
  76. subgroups tree. The block takes into consideration cases where a user can't
  77. access a private group but still has access to the node/xxx/subgroups. In such
  78. cases the group will appear as .
  79. --------------------------
  80. VIEWS
  81. --------------------------
  82. Subgroups has Views integration and provides some fields, arguments, sorts
  83. and filters which are outlined below. The Views Tree module,
  84. (http://drupal.org/project/views_tree), works great for displaying all or a
  85. portion of the subgroup hierarchy in a tree format for blocks or pages display.
  86. Fields:
  87. - Child Groups
  88. A list of direct children of a group
  89. - Parent Group ID
  90. The nid of the parent group
  91. - Parent Group Title
  92. The node title of the parent group
  93. Arguments:
  94. - Group ID
  95. Using a group's nid as a starting point, get all group nodes along the
  96. subgroup path (up, down or sideways).
  97. - Group ID (for posts)
  98. Using a group's nid as a starting point, get content that has been posted
  99. to group nodes along the subgroup path (up, down, sideways).
  100. - Parent Group ID
  101. The group ID of a parent node. Filters for groups that has the specified
  102. parent. Similar to the 'child groups' field but returns each child as a
  103. separate row.
  104. Sort:
  105. - Hierarchy Order
  106. Sort the groups or content by hierarchy order.
  107. Filter:
  108. - Subgroups overrides the standard OG filter for posts and changes the
  109. group selector widget to display the groups in a tree format.