Skip to content
Snippets Groups Projects
Commit 3186f8c0 authored by Nikolay Lobachev's avatar Nikolay Lobachev
Browse files

Issue #3342249 by LOBsTerr: Documenting Readme.md file according to markdown template

parent 56e3bcd1
No related branches found
No related tags found
No related merge requests found
CONTENTS OF THIS FILE
---------------------
* Introduction
* Requirements
* Installation
* Configuration
* Automatic association to a group
* Adding media to group in bulk
* Maintainers
INTRODUCTION
------------
# Group Media
This module is designed to associate group specific media with a group when
using the [Group](https://www.drupal.org/project/group) module.
......@@ -23,51 +11,59 @@ media with relation from Group Operations.
Media item edit form will also contain the list of the groups it belongs to.
* For a full description of the module visit:
https://www.drupal.org/project/groupmedia
- For a full description of the module, visit the
[project page](https://www.drupal.org/project/groupmedia)
or
https://www.drupal.org/docs/contributed-modules/group-media
[project page](https://www.drupal.org/docs/contributed-modules/group-media).
- Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/groupmedia?categories=All).
## Table of contents
* To submit bug reports and feature suggestions, or to track changes visit:
https://www.drupal.org/project/issues/groupmedia?categories=All
- Requirements
- Installation
- Configuration
- Automatic association to a group
- Adding media to group in bulk
- Maintainers
REQUIREMENTS
------------
## Requirements
- Group module (https://drupal.org/project/group), version greater than
8.x-1.2.
- Media entity module (https://www.drupal.org/project/media_entity) for
8.x-1.x version only.
- Media in core for 8.x-2.x releases.
- [Group module](https://drupal.org/project/group)
version greater than3.0.
- Media module.
INSTALLATION
------------
## Installation
Install the Groupmedia module as you would normally install a contributed
Drupal module. Visit https://www.drupal.org/node/1897420 for further
information.
Drupal module. For further information, see
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).
CONFIGURATION
-------------
## Configuration
1. First you need to create a group type. Read more about this in Group
module documentation.
1. Go to `/admin/group/types`, find group type you want to extend with
2. Go to `/admin/group/types`, find group type you want to extend with
support of media relations.
1. Select "Set available content" in the dropdown button corresponding
3. Select "Set available content" in the dropdown button corresponding
to your group type. You will end up on the plugin overview page with
the list of all relations to the group possible.
1. Enable the plugins you need. Each Media Type has its own plugin.
1. At page `/admin/group/types/manage/<your_group_type>/permissions`
4. Enable the plugins you need. Each Media Type has its own plugin.
5. At page `/admin/group/types/manage/<your_group_type>/permissions`
you can set the permissions for each media relation plugin.
Automatic association to a group
--------------------------------
## Automatic association to a group
Since alpha8 release it is possible to automatically add media items from
group content to the group itself.
#### Which media items will be attached?
1. Items referenced with entity reference fields where target entity type is
......@@ -81,9 +77,9 @@ The feature is enabled by default. You can configure tracking settings here
association. Moreover there are 3 hooks that allows to be flexible when
deciding which items should be attached and which not:
1. `hook_groupmedia_entity_group_alter`: if groups array is empty, the item
will not be attached automatically.
will not be attached automatically.
1. `hook_groupmedia_finder_add_alter`: if at least 1 item of `$result` array is
false, the media will not be attached automatically.
false, the media will not be attached automatically.
1. `hook_groupmedia_attach_group_alter`: if at least 1 item of `$result` array
is false, the media will not be attached automatically.
......@@ -97,8 +93,7 @@ For further details check `groupmedia.api.php` php comments.
**IMPORTANT!** Disabled/enabled feature of automatic associating doesn't
influence the manual group media relation CRUD.
Adding media to group in bulk
--------------------------------
## Adding media to group in bulk
Media items can be added to group in bulk operations. For this one needs to add
action "Assign Media to Group" and/or "Remove media from Group" to view that is
......@@ -114,13 +109,15 @@ group just before the action is applied.
Read more about groupmedia module usage
[here](https://www.drupal.org/docs/contributed-modules/group-media)
and on [official module page](https://drupal.org/project/groupmedia)
and on [official module page](https://drupal.org/project/groupmedia).
MAINTAINERS
-----------
## Maintainers
* Artem Dmitriiev - https://www.drupal.org/u/admitriiev
- Artem Dmitriiev - [a.dmitriiev](https://www.drupal.org/u/admitriiev)
- Nikolay Lobachev - [LOBsTerr](https://www.drupal.org/u/LOBsTerr)
Supporting organization:
* 1xINTERNET GmbH - https://www.drupal.org/1xinternet
- 1xINTERNET GmbH - [1xINTERNET](https://www.drupal.org/1xinternet)
- European Commission - [European Commission](https://www.drupal.org/european-commission)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment