You are here

README.txt in Private Message 8.2

Same filename and directory in other branches
  1. 8 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers


INTRODUCTION
------------

The Private Message module allows for private messages between users on a site.
It has been written to be fully extendable using Drupal 8 APIs.

 * For a full description of the module visit
   https://www.drupal.org/node/2871948

 * To submit bug reports and feature suggestions, or to track changes visit
   https://www.drupal.org/project/issues/private_message


REQUIREMENTS
------------

This module requires no modules outside of Drupal core.


INSTALLATION
------------

Install the Private Message module as you would normally install a contributed
Drupal module. Visit https://www.drupal.org/node/1897420 for further
information.


CONFIGURATION
-------------

    1. Navigate to Administration > Extend and enable the Private Message
       module.
    2. Navigate to Administration > People > Permissions and give the two
       permissions (use private messaging system, access user profiles)
       to the roles that should use the messaging system. Save permissions.
    3. To write a private message to another user, navigate to the path
       /private-messages.

Configuring the Private Message Inbox Block
    1. Navigate to Administration > Structure > Block Layout.
    2. Find the Private Message Inbox Block and select the Configure button.
    3. Give the block a title.
    4. Select the number of threads to show in the block.
    5. Select the number of threads to be loaded with ajax.
    6. Select an Ajax refresh rate. This is the number of seconds between checks
       if there are any new messages. Note: setting this number to zero will
       disable refresh and the inbox will only be refreshed upon page refresh.
    7. In the Visibility horizontal tab section there are three options for
       visibility: Content types, Pages and Roles.
    8. The user may also want to set the block to only show on the following
       paths:
        * /private-messages
        * /private-messages/*
       This will limit the block to only show on private message thread pages.
    9. Select to region for block display from the Region dropdown.
    10. Save block.

Configuring the Private Message Notification Block
    1. Navigate to Administration > Structure > Block Layout.
    2. Find the Private Message Notification Block and select the Configure
       button.
    3. Give the block a title.
    4. Select an Ajax refresh rate. This is the number of seconds between checks
       if there are any new messages. Note: setting this number to zero will
       disable refresh and the inbox will only be refreshed upon page refresh.
    5. In the Visibility horizontal tab section there are three options for
       visibility: Content types, Pages and Roles.
    6. Select to region for block display from the Region dropdown.
    7. Save block.

To Configure Private Message Threads
    1. Navigate to Administration > Structure > Privates Messages > Private
       Message Threads.
    2. Select the Manage fields tab and fields can be added as with any other
       entity.
    3. Select the Manage display to order the items in a thread.
    4. Save block.

For other use stories and configurations, please visit
https://www.drupal.org/node/2871948


Note: if Bartik is not the enabled theme, the Private Message Inbox block will
need to be placed in a region somewhere on the page.


MAINTAINERS
-----------

Current maintainers:

 * Jay Friendly (Jaypan) - https://www.drupal.org/u/jaypan
 * Eduardo Telaya (edutrul) - https://www.drupal.org/u/edutrul

Supporting organizations:

 * Jaypan - https://www.drupal.org/jaypan

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Introduction
  4. * Requirements
  5. * Installation
  6. * Configuration
  7. * Maintainers
  8. INTRODUCTION
  9. ------------
  10. The Private Message module allows for private messages between users on a site.
  11. It has been written to be fully extendable using Drupal 8 APIs.
  12. * For a full description of the module visit
  13. https://www.drupal.org/node/2871948
  14. * To submit bug reports and feature suggestions, or to track changes visit
  15. https://www.drupal.org/project/issues/private_message
  16. REQUIREMENTS
  17. ------------
  18. This module requires no modules outside of Drupal core.
  19. INSTALLATION
  20. ------------
  21. Install the Private Message module as you would normally install a contributed
  22. Drupal module. Visit https://www.drupal.org/node/1897420 for further
  23. information.
  24. CONFIGURATION
  25. -------------
  26. 1. Navigate to Administration > Extend and enable the Private Message
  27. module.
  28. 2. Navigate to Administration > People > Permissions and give the two
  29. permissions (use private messaging system, access user profiles)
  30. to the roles that should use the messaging system. Save permissions.
  31. 3. To write a private message to another user, navigate to the path
  32. /private-messages.
  33. Configuring the Private Message Inbox Block
  34. 1. Navigate to Administration > Structure > Block Layout.
  35. 2. Find the Private Message Inbox Block and select the Configure button.
  36. 3. Give the block a title.
  37. 4. Select the number of threads to show in the block.
  38. 5. Select the number of threads to be loaded with ajax.
  39. 6. Select an Ajax refresh rate. This is the number of seconds between checks
  40. if there are any new messages. Note: setting this number to zero will
  41. disable refresh and the inbox will only be refreshed upon page refresh.
  42. 7. In the Visibility horizontal tab section there are three options for
  43. visibility: Content types, Pages and Roles.
  44. 8. The user may also want to set the block to only show on the following
  45. paths:
  46. * /private-messages
  47. * /private-messages/*
  48. This will limit the block to only show on private message thread pages.
  49. 9. Select to region for block display from the Region dropdown.
  50. 10. Save block.
  51. Configuring the Private Message Notification Block
  52. 1. Navigate to Administration > Structure > Block Layout.
  53. 2. Find the Private Message Notification Block and select the Configure
  54. button.
  55. 3. Give the block a title.
  56. 4. Select an Ajax refresh rate. This is the number of seconds between checks
  57. if there are any new messages. Note: setting this number to zero will
  58. disable refresh and the inbox will only be refreshed upon page refresh.
  59. 5. In the Visibility horizontal tab section there are three options for
  60. visibility: Content types, Pages and Roles.
  61. 6. Select to region for block display from the Region dropdown.
  62. 7. Save block.
  63. To Configure Private Message Threads
  64. 1. Navigate to Administration > Structure > Privates Messages > Private
  65. Message Threads.
  66. 2. Select the Manage fields tab and fields can be added as with any other
  67. entity.
  68. 3. Select the Manage display to order the items in a thread.
  69. 4. Save block.
  70. For other use stories and configurations, please visit
  71. https://www.drupal.org/node/2871948
  72. Note: if Bartik is not the enabled theme, the Private Message Inbox block will
  73. need to be placed in a region somewhere on the page.
  74. MAINTAINERS
  75. -----------
  76. Current maintainers:
  77. * Jay Friendly (Jaypan) - https://www.drupal.org/u/jaypan
  78. * Eduardo Telaya (edutrul) - https://www.drupal.org/u/edutrul
  79. Supporting organizations:
  80. * Jaypan - https://www.drupal.org/jaypan