Difference between revisions of "Web Integration/HowTo"

From Creative Commons
Jump to: navigation, search
(→‎Assistance)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
= '''How To Incorporate Creative Commons License Metadata into Your Web Application''' =
+
<div style="font-size:125%; line-height:1.75em; margin-bottom:1.75em;">
 +
The goal of this HowTo is to provide a basic step-by-step guide to the technical concerns when incorporating CC license metadata functionality into your web application.  This guide has been generalized from various plans for video, audio, or image sharing sites.
 +
 
 +
Below are 5 areas where integration can occur in your web application.  While each web application may not need each of the 5 integrations, Creative Commons recommends that as many as practical are implemented.
 +
</div>
  
−
The goal of this HowTo is to provide a basic step-by-step guide to the technical concerns when incorporating CC license metadata functionality into your web application.  This guide has been generalized from various plans for video, audio, or image sharing sites.
+
<div style="padding:1.25em 1em; margin-left:-1em; margin-right:-1em; -moz-border-radius:5px; -webkit-border-radius:5px; background-color: #eaeaea; overflow: auto;">
 +
{{PageColumn|
 +
== [[Web Integration/FileUploadExample|License Choice on file upload]] ==
 +
Users should be able to choose which license they want for each file they upload.
  
−
Below are 4 areas where integration can occur in your web application.  While each web application may not need each of the 4 integrations, Creative Commons recommends that as many as practical are implemented.
+
This will allow users to make fine-grain decisions about their works (so that some are CC and some are still All Rights Reserved)
  
−
== 1. License Choice on file upload ==
+
: '''Tools to use''':
−
* Users should be able to choose which license they want for each file they upload.
 
−
* This will allow users to make fine-grain decisions about their works (so that some are CC and some are still All Rights Reserved)
 
  
−
: Tools to use:
 
 
:: [[LicenseChooser.js]] or [[Web Services]]
 
:: [[LicenseChooser.js]] or [[Web Services]]
  
−
: '''[[Web Integration/FileUploadExample|Example Implementation]] (Pictures)'''
+
: '''Best Practices Example''': [[SoundCloud]]
  
−
== 2. Default License choice in account settings ==
+
: [[File:Sound Cloud License Choice on Upload.png|thumb|260px|border|
−
* In account settings, users should be able to specify a default license for their content they create on the site.
+
<br>
−
** Ex: A user licenses chooses CC-BY for all of their work.
+
[[SoundCloud]]'s [http://soundcloud.com/upload#old-skool license chooser] on upload is a good way to let users choose a CC license.]]
−
* This can be combined with License Choice on File Upload to allow users to have the default license be, for example, CC:BY and in special cases some others be CC:BY-SA, or even All Rights Reserved.
+
 
 +
== [[Web Integration/DefaultLicenseExample|Default License choice in account settings]] ==
 +
In account settings, users should be able to specify a default license for their content they create on the site.
 +
 
 +
This can be combined with License Choice on File Upload to allow users to have the default license be, for example, CC:BY and in special cases some others be CC:BY-SA, or even All Rights Reserved.
 +
 
 +
: '''Tools to use''':
  
−
: Tools to use:
 
 
:: [[LicenseChooser.js]] or [[Web Services]]
 
:: [[LicenseChooser.js]] or [[Web Services]]
  
−
: '''[[Web Integration/DefaultLicenseExample|Example Implementation]] (Pictures)'''
+
: '''Best Practices Example''': [[Flickr]]
  
−
== 3. Include license RDFa on content pages ==
+
: [[File:Flickr Default License Choice.png|thumb|260px|border|<br>[[Flickr]]'s account settings provide a default license for users to apply to all of their uploaded works.]]
−
* Including RDFa code signals to machines (search engines, browsers, etc) exactly how a specific work is licensed.
+
 
−
* This allows works to be scraped by search engines and other automatic content discovery services with associated license metadata.
+
== [[Web Integration/RDFaExample|Include license RDFa on content pages]] ==
 +
Including RDFa code signals to machines (search engines, browsers, etc) exactly how a specific work is licensed.
 +
 
 +
This allows works to be scraped by search engines and other automatic content discovery services with associated license metadata.
 +
 
 +
: '''Tools to use''':
  
−
: Tools to use:
 
 
:: [[RDFa]] and [[CcREL|ccREL]]
 
:: [[RDFa]] and [[CcREL|ccREL]]
  
−
: '''[[Web Integration/RDFaExample|Example Implementation]] (Pictures)'''
+
: '''Best Practices Example''': [[Thingiverse]]
 +
 
 +
: [[File:RDFa-Explanation.png|thumb|260px|border|<br>Read more about how CC uses [[RDFa]] and [[ccREL]] to signal to machines that a work is CC licensed.]]
 +
 
 +
}}
  
−
== 4. Include "copyable" attribution language with RDFa ==
+
{{PageColumn|
−
* This is similar to practice to video embed code from services such as YouTUBE. However, this HTML is for bloggers and other republishers easily attribute a work fully and correctly.
+
== [[Web Integration/CopyableExample|Include copyable attribution language with RDFa]] ==
 +
This is similar to practice to video embed code from services such as YouTUBE. However, this HTML is for bloggers and other republishers easily attribute a work fully and correctly.
 +
 
 +
: '''Tools to use''':
  
−
: Tools to use:
 
 
:: [[Web Services]], [[RDFa]], and [[CcREL|ccREL]]
 
:: [[Web Services]], [[RDFa]], and [[CcREL|ccREL]]
  
−
: '''[[Web Integration/CopyableExample|Example Implementation]] (Pictures)'''
+
: '''Best Practices Example''': CC license deeds
 +
 
 +
: [[File:Attribution box via RDFa and Javascript.png|thumb|260px|border|<br>CC license deeds will automatically generate Attribution HTML if the referring page contains relevant RDFa.]]
 +
 
 +
== [[Web Integration/InterfaceExample|License aware user interfaces]] ==
 +
Utilize all of the license metadata to provide new and interesting interfaces to view content based on the license data.
 +
 
 +
: '''Tools to use''':
 +
 
 +
:: [[RDFa]], and [[CcREL|ccREL]]
 +
 
 +
: '''Best Practices Example''': [[Flickr]]
 +
 
 +
: [[File:Flickr Creative Commons Exploration portal.png|thumb|260px|border|[[Flickr]]'s CC portal represents a good way to break down CC content for end users.]]
 +
 
 +
}}
 +
 
 +
== Adopters ==
 +
 
 +
We have a long list of [[Content Directories]] which are basically sites, projects and people who have implemented CC licensing and/or have some type of CC licensing. This is the best list of high level CC license adopters, all generated from the community. NOTE: CC does not have a database of content or keep a defacto list of all those who use CC licenses. The list above is used to provide examples.
 +
 
 +
== Assistance ==
 +
 
 +
If you are hoping to adopt this, please use the community support venues and direct contact information at http://creativecommons.org/contact
 +
 
 +
<br clear="all"/>
 +
</div>
 +
 
 +
=== See also ===
  
−
note: example of the cool use of the deeds
+
: Back to '''[[Web Integration]]'''
 +
: '''[[Desktop Integration]]'''
 +
: '''[[Developers]]'''

Latest revision as of 16:39, 17 March 2011

The goal of this HowTo is to provide a basic step-by-step guide to the technical concerns when incorporating CC license metadata functionality into your web application. This guide has been generalized from various plans for video, audio, or image sharing sites.

Below are 5 areas where integration can occur in your web application. While each web application may not need each of the 5 integrations, Creative Commons recommends that as many as practical are implemented.

License Choice on file upload

Users should be able to choose which license they want for each file they upload.

This will allow users to make fine-grain decisions about their works (so that some are CC and some are still All Rights Reserved)

Tools to use:
LicenseChooser.js or Web Services
Best Practices Example: SoundCloud

SoundCloud's license chooser on upload is a good way to let users choose a CC license.

Default License choice in account settings

In account settings, users should be able to specify a default license for their content they create on the site.

This can be combined with License Choice on File Upload to allow users to have the default license be, for example, CC:BY and in special cases some others be CC:BY-SA, or even All Rights Reserved.

Tools to use:
LicenseChooser.js or Web Services
Best Practices Example: Flickr

Flickr's account settings provide a default license for users to apply to all of their uploaded works.

Include license RDFa on content pages

Including RDFa code signals to machines (search engines, browsers, etc) exactly how a specific work is licensed.

This allows works to be scraped by search engines and other automatic content discovery services with associated license metadata.

Tools to use:
RDFa and ccREL
Best Practices Example: Thingiverse

Read more about how CC uses RDFa and ccREL to signal to machines that a work is CC licensed.


Include copyable attribution language with RDFa

This is similar to practice to video embed code from services such as YouTUBE. However, this HTML is for bloggers and other republishers easily attribute a work fully and correctly.

Tools to use:
Web Services, RDFa, and ccREL
Best Practices Example: CC license deeds

CC license deeds will automatically generate Attribution HTML if the referring page contains relevant RDFa.

License aware user interfaces

Utilize all of the license metadata to provide new and interesting interfaces to view content based on the license data.

Tools to use:
RDFa, and ccREL
Best Practices Example: Flickr
Flickr's CC portal represents a good way to break down CC content for end users.


Adopters

We have a long list of Content Directories which are basically sites, projects and people who have implemented CC licensing and/or have some type of CC licensing. This is the best list of high level CC license adopters, all generated from the community. NOTE: CC does not have a database of content or keep a defacto list of all those who use CC licenses. The list above is used to provide examples.

Assistance

If you are hoping to adopt this, please use the community support venues and direct contact information at http://creativecommons.org/contact


See also

Back to Web Integration
Desktop Integration
Developers
Retrieved from "https://wiki.creativecommons.org/index.php?title=Web_Integration/HowTo&oldid=47940"