Browse Source

Add installation instructions to README.

8.x-1.x 8.x-1.0-beta8
Alexander O'Neill 4 years ago
parent
commit
8de525542f
  1. 38
      README.md

38
README.md

@ -1,9 +1,18 @@
# Installation
Install as you normally would. This module creates the following entity types:
Use composer to download the module, there is an open issue on Drupal.org
in Paragraphs that prevents this module from working without a patch.
Composer should apply the patch automatically.
composer require drupal/media_attribution
The issue the patch comes from is at https://www.drupal.org/project/paragraphs/issues/2901390
When you install the module, it creates the following configurations:
* Taxonomy vocabulary
* Licences (media_attribution_licenses) - Includes License Link and License Icon fields
* The vocabulary is populated with a set of Creative Commons licenses.
* Paragraphs type
* License Attribution (license_attribution)
* This field is automatically added to the Image media type on install.
@ -14,25 +23,22 @@ The installation script automatically adds the attribution paragraphs field
to the Image media type if it exists. Otherwise adding attribution
can be done at Admin -> Structure -> Media Types.
The attribution paragraph field has the following components
Source Work link, including a title and URL. This title is
usually the title of the original work.
When you click the Embed Media button, the attribution links
fields will show up in the Media along with Title, Alt text, etc.
Alternatively you can edit the media content entity directly.
Original Author link, including name and URL of the author's home page.
The attribution paragraph field has the following components
License type - optional, the license under which the linked work is released.
* Source Work link, including a title and URL. This title is
usually the title of the original work.
Free-form attribution text - optional, arbitrary text to clarify attribution. If no
license is selected, this text can be used to identify copyrighted works with e.g.,
"All rights reserved, used with permisssion."
* Original Author link, including name and URL of the author's home page.
To add an attribution to a media object, you will need
to edit the media entity directly since the text editor
embed form no longer uses the entity form display settings.
* License type - optional, the license under which the linked work is released.
Go to Admin -> Content -> Media to find and edit
the media and add attribution info.
* Free-form attribution text - optional, arbitrary text to clarify attribution. If no
license is selected, this text can be used to identify copyrighted works with e.g.,
"All rights reserved, used with permisssion."
This source and author info will be rendered below an embedded media object
when showing the node, following the format preferred by Creative Commons,
@ -52,7 +58,7 @@ Run `drush help media_attribution:load_licenses` for how to load license data fr
# Authors
Alexander O'Neill ([alxp](https://drupal.org/u/alxp))
Alexander O'Neill https://drupal.org/u/alxp
# Sponsoring Organization

Loading…
Cancel
Save