Skip to content

Commit

Permalink
Started updates to README, created routing yml, renamed views inculde…
Browse files Browse the repository at this point in the history
…, added views config yml and private_message twig template.
  • Loading branch information
mccrodp committed Dec 22, 2015
1 parent f0bf2f0 commit 25c8783
Show file tree
Hide file tree
Showing 7 changed files with 574 additions and 59 deletions.
25 changes: 5 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
D8 Status : Under Development (non functional)

CONTENTS OF THIS FILE
---------------------
* Introduction
Expand All @@ -9,6 +11,7 @@ CONTENTS OF THIS FILE
* Development and Test
* Maintainers


INTRODUCTION
------------
A message type and entity reference fields, enabling sending and receiving
Expand All @@ -20,10 +23,6 @@ The message_private module includes the following.
+ A message type "Private Message" with entity reference field referencing users
+ A message view, message_private for "User Messages"

The sub-module message_private_og includes the following.
+ An entity reference field for groups to associate messages to groups
+ A "Group Messages" display for the message_private view


DEPENDENCIES
------------
Expand All @@ -39,18 +38,12 @@ The message_private module requires the following modules:
* Views (https://www.drupal.org/project/views)
* Token (https://www.drupal.org/project/token

The message_private_og module requires the following modules:
* OG (https://drupal.org/project/og)


INSTALLATION
------------
* Install as you would normally install a contributed drupal module. See:
https://drupal.org/documentation/install/modules-themes/modules-7
https://drupal.org/documentation/install/modules-themes/modules-8
for further information.
* If using message_private_og, make sure you have created an OG group content
type named "Group". Otherwise, you will need to manually configure the entity
reference field to use your custom group content type.


CONFIGURATION
Expand Down Expand Up @@ -85,13 +78,6 @@ role get the maximum limit by calculating the lowest time per message over each
role. Users with the 'bypass private message access control' permission bypass
these limitations.

Message Private OG:
When using the Message Private OG sub-module, the Group Messages display has
a contextual filter which filters by group ID of the logged in user. This is
developed taking into account that a content type called "Group" exists for all
Group instances. Anything other than this setup requires user customisation. You
must manually set the field_message_group_ref contextual filter to use group
bundle to enable group filter on views.

HOW TO USE
----------
Expand All @@ -101,13 +87,12 @@ or
Visit the "Messages" tab detailed below and find the "Create a new message"
local action.

To View inbox, sent and group messages:
To View inbox and sent messages:
Visit your user page at /user and find the "Messages" tab which displays
received messages (Inbox local task), the "Sent" local task under that tab which
displays sent messages and the "Group" local task which displays group messages.
/user/USER_ID/messages/inbox
/user/USER_ID/messages/sent
/user/USER_ID/messages/group

SECURITY
--------
Expand Down
Loading

0 comments on commit 25c8783

Please sign in to comment.