Difference between revisions of "Scholars Copyright Integration"

From Creative Commons
Jump to: navigation, search
Line 10: Line 10:
  
 
The value supplied for <code>partner_id</code> should be a short, descriptive name for your site.  For example, Big Example University might supply <code>partner_id=example_u</code>.
 
The value supplied for <code>partner_id</code> should be a short, descriptive name for your site.  For example, Big Example University might supply <code>partner_id=example_u</code>.
 +
 +
== Default Agreement Selection ==
 +
 +
You may specify the default agreement selection by providing a <code>default</code> parameter in the query string.  The value of the <code>default</code> parameter is the agreement identifier.  For example, to display the generator with the '''Access-Reuse''' agreement selected:
 +
 +
<code>
 +
  <iframe src="http://scholars.sciencecommons.org/iframe?partner_id=example&default=retaincc" />
 +
</code>
 +
 +
The following agreements are available:
 +
 +
* '''noembargo''' OpenAccess-Pubish
 +
* '''embargo''' OpenAccess-Embargo
 +
* '''retaincc''' Access-Reuse
 +
* '''mit''' MIT Amendment
  
 
== Styling the Generator ==
 
== Styling the Generator ==

Revision as of 11:55, 28 March 2007

This document describes integrating the Scholars Copyright Addendum Generator into your website. For general information on the Scholars Copyright project, see the project page at Science Commons.

Basic Integration

The generator can be integrated with your site using a link or an <iframe> tag. For example:

  <iframe src="http://scholars.sciencecommons.org/iframe?partner_id=example" />

The value supplied for partner_id should be a short, descriptive name for your site. For example, Big Example University might supply partner_id=example_u.

Default Agreement Selection

You may specify the default agreement selection by providing a default parameter in the query string. The value of the default parameter is the agreement identifier. For example, to display the generator with the Access-Reuse agreement selected:

  <iframe src="http://scholars.sciencecommons.org/iframe?partner_id=example&default=retaincc" />

The following agreements are available:

  • noembargo OpenAccess-Pubish
  • embargo OpenAccess-Embargo
  • retaincc Access-Reuse
  • mit MIT Amendment

Styling the Generator

In addition to the partner_id, you may also supply an optional stylesheet URL. For example:

  <iframe src="http://scholars.sciencecommons.org/iframe?partner_id=example&stylesheet=http://example.com/scicom.css" />

Valid style classes/ids include:


  • .logo This class is used to style the header; you can insert your own header image by providing it as the background.
  • #content The content div surrounds the entire selector; you can use this to set sizing, etc.
  • body Style the body tag to set the background color, etc.


Note that if no stylesheet is specified, only the basic styling will be applied.

Examples

An example of using an iframe to integrate the Addendum Generator is included with the source code. You can find the HTML in Subversion here, or see it online here.