To give users some idea about how this format looks like when specifying attributions, below are some examples of use:
The first example shows how to use this format to specify that the
repo includes an third party unadapted work. In this case, it is an
image file that can be found on the path
images/griffin_head.jpg in the project repo. This image
is available for reuse under the Creative Commons Attribitution 2.0 lisense.
To document its providence, there are URLS pointing to the source (on Flickr)
and the author's home page.
# Creative Commons (unadapted work) images/griffin_head.jpg: type: asset approved: allowed license title: Griffin Head attributionText: Paul Keller attributionUrl: http://flickr.com/people/paulk/ license: CC BY 2.0 rights: http://creativecommons.org/licenses/by/2.0/deed.no source: http://flickr.com/photos/paulk/2062848161/
The second example show how a developer named “Kari Aas” includes an adapted version of this image in the repo. Because the work is adapted, there are field that specifies metadata for the original work, as well as the adapted version.
# Creative Commons (adapted work) images/fantasy.jpg: type: asset approved: allowed license title: Fantasy attributionText: Kari Aaas license: CC BY 3.0 rights: http://creativecommons.org/licenses/by-sa/3.0/no/ source: http://flickr.com/photos/paulk/2062848161/ originalTitle: Griffin Head orginalAttributionText: Paul Keller orginalattributionUrl: http://flickr.com/people/paulk/ originalLicicense: CC BY 2.0 originalRights: http://creativecommons.org/licenses/by/2.0/deed.no
In the third example, the assets included in the repo is a set of protected logos owned by the Creative Commons organization, and used in compliance with the the Creative Commons Trademark Policy:
# Creative Commons Icons (custom policy) images/buttons: type: asset approved: https://www.drupal.org/node/2314301 title: Creative Commons Icons source: http://cgit.drupalcode.org/creativecommons/tree/images license: the Creative Commons Trademark Policy rights: https://creativecommons.org/policies
The fourth example show how a set how documentation source files
resident in a directory named source are documented.
These files are made available for reuse under a Creative Commons
Attribution Share-Alike 2.0 license. In this case, there are multiple
contributors so the field copyrightNotice are used to
point downstream recipents to the files with details about copyright
and attributions. Since this project takes care of its attribution
requirements by other means that the attributions module, the field
hide is set TRUE. This will stop the
attributions module from displaying the attribution.
# Example of use in the a documentation project.
source:
type: asset
approved: allowed license
title: Guide source
license: CC BY‐SA 2.0
copyrightNotice: >
The copyright notices for this directory are located in files
source/[LANG]/copyright.txt, for each language subdirectory [LANG]. They
reference attributions in files source/[LANG]/attributions.txt.
hide: TRUE
The final example show how a specific third party library, adopted
to work with Drupal, and re-licensed (with permission from the
original authors) from Apache 2.0 to GPLv2+, is documented. The
background about the re-licensing can be found by looking up the issue
that is linked to from the approved key.
# Bootstrap agency (code). js/bootstrap_agency.js: type: code approved: https://www.drupal.org/node/2448043 title: Bootstrap Agency JS license: 'GPLv2+' rights: http://www.gnu.org/licenses/old-licenses/gpl-2.0.html source: http://startbootstrap.com/template-overviews/agency/ originalLicense: Apache 2.0 orginalCopyrightNotice: © 2013-2015 Iron Summit Media Strategies, LLC originalTitle: Agency
For even more examples of use of this format for attributions, see
the demo/ASSETS.yml.
To see the full syntax available for specifying attributions, see: Attributions YAML format.