Attribution

The Attribution object is designed to make it as easy as possible to comply with attribution guidelines when using assets licensed under Creative Commons Attribution or other licenses where attribution is required.

An attribution object contains all the necessary information about a single asset to create a compliant attribution message as well as fully formatted helpers.

Properties

.

assetName

: string readonly

assetName

The name of the asset.

.

assetUrl

: string? readonly

assetUrl

A URL to the asset (e.g., a page on an asset sharing platform or library).

.

authorName

: string readonly

authorName

The name of the asset's author.

.

authorUrl

: string? readonly

authorUrl

A URL to the author's page (e.g., a website, social media page or author profile on an asset sharing platform or library).

.

licenseName

: string readonly

licenseName

The lame of the license under which the asset is being used.

.

licenseUrl

: string readonly

licenseUrl

A URL to the full license (e.g., a page on the Create Commons site describing the license).

.

modified

: boolean readonly

modified

A boolean flag indicating whether or not the asset has been modified.

.

sourceName

: string? readonly

sourceName

The name of the source of the asset (e.g., the name of an asset sharing platform or library).

.

sourceUrl

: string? readonly

sourceUrl

The URL of the homepage of the source of the asset (e.g., the homepage of an asset sharing platform or library).

.

assetHtml

: string readonly

assetHtml

A formatted HTML string that shows the asset name as a link to the asset if assetUrl is available or as plain text if not.

.

authorHtml

: string readonly

authorHtml

A formatted HTML string that shows the asset author name as a link to the author's website / profile if authorUrl is available or as plain text if not.

.

html

: string readonly

html

A formatted HTML string that combines all available elements into a compliant attribution message.

.

licenseHtml

: string readonly

licenseHtml

A formatted HTML string that shows the license name as a link to the license page.

.

sourceHtml

: string readonly

sourceHtml

A formatted HTML string that presents the source name as a link to the source if sourceUrl is available or as plain text if not. If the sourceName is not available, it will return an empty string.