You are here

Home » API reference » User Relationships 6

README.txt in User Relationships 6

Same filename in this branch
  1. 6 README.txt
  2. 6 user_relationship_elaborations/README.txt
  3. 6 user_relationship_mailer/README.txt
  4. 6 user_relationship_migrate/README.txt
  5. 6 user_relationship_defaults/README.txt
  6. 6 user_relationship_implications/README.txt
  7. 6 user_relationship_invites/README.txt
  8. 6 user_relationship_node_access/README.txt
  9. 6 user_relationship_blocks/README.txt
  10. 6 user_relationships_api/README.txt
Same filename and directory in other branches
  1. 5 README.txt
  2. 5.2 README.txt
  3. 7 README.txt
User Relationships
------------------
User Relationships is a pretty self-descriptive module. It allows users the
opportunity to create relationships between each other.

The module has been broken up into component pieces in an effort to keep the size
down and the speed up. The list of modules and a quick intro about each is below

Send comments to Jeff Smick: http://drupal.org/user/107579/contact, or post an issue at
http://drupal.org/project/user_relationships.

Requirements
------------
Drupal 6


Installation
------------
1.  Copy the user_relationships folder to the appropriate Drupal (sites/all/modules or sites/all/default) directory.

2.  Enable User Relationships in the "Site building -> Modules" administration screen.

    If this is only a requirement of another module and the UI is not needed you'll
    only need to enable the API module.

3.  If you've enabled the UI module you can create relationship types and modify settings under
    Administer -> User management -> Relationships


Included Modules
----------------
NOTE: Please read the individual README.txt files in each module's directory for a more in-depth
      explanation of the module and its functionality.

User Relationships API:
  This is the purely functional portion. It will only provide an API that other modules can
  use to control relationships

User Relationships UI:
  A basic user interface. UR-UI provides admins the ability to create realtionship types and
  users to request/cancel/approve/disapprove/remove relationships with each other.

User Relationship Blocks:
  Provides some basic blocks to show relationships and perform actions.

User Relationship Defaults:
  Gives admins the ability to create default relationships that are added to a user when they sign up

User Relationship Implications:
  Enables the creation of implied relationships, relationships that are created automatically when
  a specified relationship is created.

User Relationships Mailer:
  A helper module that will send email notifications about relationship actions



Credits
-------
Written by Jeff Smick (sprsquish).
Originally written for and financially supported by OurChart Inc. (http://www.ourchart.com)
Thanks to the BuddyList module team for their inspiration

File

README.txt
View source 
  1. 

  2. User Relationships

  3. ------------------

  4. User Relationships is a pretty self-descriptive module. It allows users the

  5. opportunity to create relationships between each other.

  6. 

  7. The module has been broken up into component pieces in an effort to keep the size

  8. down and the speed up. The list of modules and a quick intro about each is below

  9. 

  10. Send comments to Jeff Smick: http://drupal.org/user/107579/contact, or post an issue at

  11. http://drupal.org/project/user_relationships.

  12. 

  13. Requirements

  14. ------------

  15. Drupal 6

  16. 

  17. 

  18. Installation

  19. ------------

  20. 1.  Copy the user_relationships folder to the appropriate Drupal (sites/all/modules or sites/all/default) directory.

  21. 

  22. 2.  Enable User Relationships in the "Site building -> Modules" administration screen.

  23. 

  24.     If this is only a requirement of another module and the UI is not needed you'll

  25.     only need to enable the API module.

  26. 

  27. 3.  If you've enabled the UI module you can create relationship types and modify settings under

  28.     Administer -> User management -> Relationships

  29. 

  30. 

  31. Included Modules

  32. ----------------

  33. NOTE: Please read the individual README.txt files in each module's directory for a more in-depth

  34.       explanation of the module and its functionality.

  35. 

  36. User Relationships API:

  37.   This is the purely functional portion. It will only provide an API that other modules can

  38.   use to control relationships

  39. 

  40. User Relationships UI:

  41.   A basic user interface. UR-UI provides admins the ability to create realtionship types and

  42.   users to request/cancel/approve/disapprove/remove relationships with each other.

  43. 

  44. User Relationship Blocks:

  45.   Provides some basic blocks to show relationships and perform actions.

  46. 

  47. User Relationship Defaults:

  48.   Gives admins the ability to create default relationships that are added to a user when they sign up

  49. 

  50. User Relationship Implications:

  51.   Enables the creation of implied relationships, relationships that are created automatically when

  52.   a specified relationship is created.

  53. 

  54. User Relationships Mailer:

  55.   A helper module that will send email notifications about relationship actions

  56. 

  57. 

  58. 

  59. Credits

  60. -------

  61. Written by Jeff Smick (sprsquish).

  62. Originally written for and financially supported by OurChart Inc. (http://www.ourchart.com)

  63. Thanks to the BuddyList module team for their inspiration