Browse Source

Update README.

8.x-1.x
Alexander O'Neill 4 years ago
parent
commit
c0a17036dc
  1. 32
      README.md

32
README.md

@ -1,31 +1,18 @@
# Installation # Installation
## Patch requirement
In order to properly use the license attribution form items with the inline
media browser CKEditor button (the 'star' button), the following patch is required:
https://www.drupal.org/files/issues/paragraphs-missing-langcode-2901390-9.patch
From this Paragraphs issue: Integrity constraint violation: 1048 Column 'langcode' cannot be null
https://www.drupal.org/project/paragraphs/issues/2901390
## Enabling the module
Install as you normally would. This module creates the following entity types: Install as you normally would. This module creates the following entity types:
* Taxonomy vocabulary * Taxonomy vocabulary
* Licences (media_attribution_licenses) - Includes License Link and License Icon fields * Licences (media_attribution_licenses) - Includes License Link and License Icon fields
* Paragraphs type * Paragraphs type
* License Attribution (license_attribution) * License Attribution (license_attribution)
* This field is automatically added to the Image media type on install.
# Use # Use
The installation script automatically adds teh attribution paragraphs field The installation script automatically adds the attribution paragraphs field
to the Image media type if it exists. This is installed by default to the Image media type if it exists. Otherwise adding attribution
by the Lightning distribution. Otherwise adding attribution can be done at Admin -> Structure -> Media Types.
can be one at Admin -> Structure -> Media Types.
The attribution paragraph field has the following components The attribution paragraph field has the following components
@ -40,8 +27,15 @@ Free-form attribution text - optional, arbitrary text to clarify attribution. If
license is selected, this text can be used to identify copyrighted works with e.g., license is selected, this text can be used to identify copyrighted works with e.g.,
"All rights reserved, used with permisssion." "All rights reserved, used with permisssion."
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.
Go to Admin -> Content -> Media to find and edit
the media and add attribution info.
This source and author info will be rendered below an embedded media object This source and author info will be rendered below an embedded media object
when showing the node, following teh format preferred by Creative Commons, when showing the node, following the format preferred by Creative Commons,
outlined at Best Practices for Attribution: outlined at Best Practices for Attribution:
https://wiki.creativecommons.org/wiki/best_practices_for_attribution https://wiki.creativecommons.org/wiki/best_practices_for_attribution
@ -50,7 +44,7 @@ https://wiki.creativecommons.org/wiki/best_practices_for_attribution
Installing the module creates License taxonomy term entries for all of the use Installing the module creates License taxonomy term entries for all of the use
variations of the international Creative Commons licenses. These can be variations of the international Creative Commons licenses. These can be
edited, and other license types can be added as needed. edited, and other licenses can be added as needed.
## Bulk-loading Licenses via Drush ## Bulk-loading Licenses via Drush

Loading…
Cancel
Save