You are here

Home » API reference » Organic groups 5.2

README.txt in Organic groups 5.2

Same filename and directory in other branches
  1. 5.8 README.txt
  2. 5 README.txt
  3. 5.3 README.txt
  4. 5.7 README.txt
  5. 6.2 README.txt
  6. 6 README.txt
  7. 7 README.txt
DESCRIPTION
--------------------------
Enable users to create and manage their own 'groups'. Each group can have subscribers, and maintains a group page where subscribers can post into. Posts may be placed into multiple groups (i.e. cross-posting) and individual posts may be shared with non-subscribers or not. Membership to groups may be open, closed, moderated, or invitation only. Add-on modules are available for group image galleries, group calendars, group vocabulary, group stores, and so on.

Groups may choose their own theme and language. Groups have RSS feeds, and so on.

INSTALLATION
---------------
- If not already active, enable the Views and Views_RSS modules. These are now prerequisites. 
- Enable the og module. 
- Visit the admin/og/og page. If you want to protect some posts so that only certain users may view them, then click the button to enable access control.
- On admin/og/og, see the 'Group home page node types' field at bottom. You usually want to create a new node type via admin/content/types page and then select that node type here. See the first item in NOTES below. 
- Set other preferences on admin/og/og as desired. It may take some experimenting before you arrive at a configuration weil suited to your needs.
- On the admin/content/types/og page, disable comments and attachments for node types which are designated as groups
- On the admin/build/themes/settings pages, in 'Display post information on' section, uncheck each node type which has been designated as a group.
- On the admin/block page, enable the 'Group details' with a low 'weight' value. Optionally enable the 'Group authors', 'Group notifications', 'New groups, 'My groups' blocks.
- Grant permissions as needed on the admin/access page 
- Begin creating groups, subscribing to those groups, and posting into those groups. The subscribe link appears in the Group details block, for non invite-only groups.
- Consider enabling the following modules which work well with OG: Pathauto, Locale. After your install is working nicely, consider enabling og add-on modules like og_mandatory_group, og_vocab, etc.

NOTES
----------------
- This module supports designating any type of node to be a group. This node type should be defined by a custom module or via the admin/content/types page. When defining your type, you usually want the title label to be 'Group name' and the body label to be 'Welcome message'. Since all nodes of this type are treated as groups, you will usually not want to designate the standard page, story, or book node types as groups. The capacity to make custom node types groups means that you can have custom fields for your groups and even several different kinds of groups. Specify the group types at bottom of admin/og/og and also remember to disable attachments and comments for each type. Lastly, you should not create nodes *before* setting up the node type as a group. If you do do that, you have to re-save each node of that type so it acquires its group settings.
- There are a few handy tabs at the path 'group'. You might want to add a link in your navigation to that url. Each tab also provides a useful RSS feed.
- 'Administer nodes' permission is required for changing the Manager of a group
- 'Administer nodes' permission enables viewing of all nodes regardless of private/public status
- All subscriber management happens on the 'subscriber list' page which is linked from the group Block (while viewing a group page). This includes approving subscription requests (for selective groups), subscribing/unsubscribing users and promoting users into group admins.
- If you decide to stop using this module, just disable it as usual. If you ever decide to re-enable, all your prior group information will be restored.

UPGRADING FROM 4.7 TO 5.0
-----------------
- In order to support the new 'as many node access modules as desired' feature of core, much has changed. A full update path to the new database configuration has been provided. However, not every scenario has been tested. Please backup your database before upgrading. Also, please report successes or failures with the update via http://drupal.org/project/issues/og or send email to Moshe Weitzman (see bottom of this file).
- The og_basic module has been deprecated. You should delete it.
- When you perform an update, og will create try to create a custom node type for you. This code sometimes fails though (help wanted). You may manage it afterwards at admin/content/types.
- Views.module is now required (and views_rss).

THEMES
------------------
You may wish to stylize nodes which have properties assigned by this module.
--- public vs. private posts are denoted by $node->og_public
--- group assignments (if any) are to be found in $node->og_groups. this is an array of nids. the group names are in $node->og_groups_names.
--- you may wish to omit the node author and time if we are showing a group home page. also consider not showing node links for these nodes since they just add clutter.
--- provided in this package are two template files for the phptemplate engine. One stylizes group nodes as suggested above and the other stylizes all other nodes as suggested above. These can be starting points for your customization of look and feel of the central area of the group home page. you may also investigate themeing of Views for more techniques.

INTEGRATION
---------------------
- This module exposes an API for retrieving and managing subscriptions via direct PHP functions [og_save_subscription()] and via XMLRPC.

UNIT TESTING
----------------------
This module comes with a suite of unit tests. Please help build more of them. See http://drupal.org/simpletest

TODO/BUGS/FEATURE REQUESTS
----------------
- see http://drupal.org/project/issues/og

CREDITS
----------------------------
Authored and maintained by Moshe Weitzman <weitzman AT tejasa DOT com>
Contributors: Gerhard Killesreiter, Angie Byron, Derek Wright, Thomas Ilsche, Ted Serbinski
Sponsored by Bryght - http://www.bryght.com
Sponsored by Broadband Mechanics - http://www.broadbandmechanics.com/
Sponsored by Finnish Broadcasting Company - http://www.yle.fi/fbc/

File

README.txt
View source 
  1. DESCRIPTION

  2. --------------------------

  3. Enable users to create and manage their own 'groups'. Each group can have subscribers, and maintains a group page where subscribers can post into. Posts may be placed into multiple groups (i.e. cross-posting) and individual posts may be shared with non-subscribers or not. Membership to groups may be open, closed, moderated, or invitation only. Add-on modules are available for group image galleries, group calendars, group vocabulary, group stores, and so on.

  4. 

  5. Groups may choose their own theme and language. Groups have RSS feeds, and so on.

  6. 

  7. INSTALLATION

  8. ---------------

  9. - If not already active, enable the Views and Views_RSS modules. These are now prerequisites. 

  10. - Enable the og module. 

  11. - Visit the admin/og/og page. If you want to protect some posts so that only certain users may view them, then click the button to enable access control.

  12. - On admin/og/og, see the 'Group home page node types' field at bottom. You usually want to create a new node type via admin/content/types page and then select that node type here. See the first item in NOTES below. 

  13. - Set other preferences on admin/og/og as desired. It may take some experimenting before you arrive at a configuration weil suited to your needs.

  14. - On the admin/content/types/og page, disable comments and attachments for node types which are designated as groups

  15. - On the admin/build/themes/settings pages, in 'Display post information on' section, uncheck each node type which has been designated as a group.

  16. - On the admin/block page, enable the 'Group details' with a low 'weight' value. Optionally enable the 'Group authors', 'Group notifications', 'New groups, 'My groups' blocks.

  17. - Grant permissions as needed on the admin/access page 

  18. - Begin creating groups, subscribing to those groups, and posting into those groups. The subscribe link appears in the Group details block, for non invite-only groups.

  19. - Consider enabling the following modules which work well with OG: Pathauto, Locale. After your install is working nicely, consider enabling og add-on modules like og_mandatory_group, og_vocab, etc.

  20. 

  21. NOTES

  22. ----------------

  23. - This module supports designating any type of node to be a group. This node type should be defined by a custom module or via the admin/content/types page. When defining your type, you usually want the title label to be 'Group name' and the body label to be 'Welcome message'. Since all nodes of this type are treated as groups, you will usually not want to designate the standard page, story, or book node types as groups. The capacity to make custom node types groups means that you can have custom fields for your groups and even several different kinds of groups. Specify the group types at bottom of admin/og/og and also remember to disable attachments and comments for each type. Lastly, you should not create nodes *before* setting up the node type as a group. If you do do that, you have to re-save each node of that type so it acquires its group settings.

  24. - There are a few handy tabs at the path 'group'. You might want to add a link in your navigation to that url. Each tab also provides a useful RSS feed.

  25. - 'Administer nodes' permission is required for changing the Manager of a group

  26. - 'Administer nodes' permission enables viewing of all nodes regardless of private/public status

  27. - All subscriber management happens on the 'subscriber list' page which is linked from the group Block (while viewing a group page). This includes approving subscription requests (for selective groups), subscribing/unsubscribing users and promoting users into group admins.

  28. - If you decide to stop using this module, just disable it as usual. If you ever decide to re-enable, all your prior group information will be restored.

  29. 

  30. UPGRADING FROM 4.7 TO 5.0

  31. -----------------

  32. - In order to support the new 'as many node access modules as desired' feature of core, much has changed. A full update path to the new database configuration has been provided. However, not every scenario has been tested. Please backup your database before upgrading. Also, please report successes or failures with the update via http://drupal.org/project/issues/og or send email to Moshe Weitzman (see bottom of this file).

  33. - The og_basic module has been deprecated. You should delete it.

  34. - When you perform an update, og will create try to create a custom node type for you. This code sometimes fails though (help wanted). You may manage it afterwards at admin/content/types.

  35. - Views.module is now required (and views_rss).

  36. 

  37. THEMES

  38. ------------------

  39. You may wish to stylize nodes which have properties assigned by this module.

  40. --- public vs. private posts are denoted by $node->og_public

  41. --- group assignments (if any) are to be found in $node->og_groups. this is an array of nids. the group names are in $node->og_groups_names.

  42. --- you may wish to omit the node author and time if we are showing a group home page. also consider not showing node links for these nodes since they just add clutter.

  43. --- provided in this package are two template files for the phptemplate engine. One stylizes group nodes as suggested above and the other stylizes all other nodes as suggested above. These can be starting points for your customization of look and feel of the central area of the group home page. you may also investigate themeing of Views for more techniques.

  44. 

  45. INTEGRATION

  46. ---------------------

  47. - This module exposes an API for retrieving and managing subscriptions via direct PHP functions [og_save_subscription()] and via XMLRPC.

  48. 

  49. UNIT TESTING

  50. ----------------------

  51. This module comes with a suite of unit tests. Please help build more of them. See http://drupal.org/simpletest

  52. 

  53. TODO/BUGS/FEATURE REQUESTS

  54. ----------------

  55. - see http://drupal.org/project/issues/og

  56. 

  57. CREDITS

  58. ----------------------------

  59. Authored and maintained by Moshe Weitzman 

  60. Contributors: Gerhard Killesreiter, Angie Byron, Derek Wright, Thomas Ilsche, Ted Serbinski

  61. Sponsored by Bryght - http://www.bryght.com

  62. Sponsored by Broadband Mechanics - http://www.broadbandmechanics.com/

  63. Sponsored by Finnish Broadcasting Company - http://www.yle.fi/fbc/