Difference between revisions of "DiscoverEd Metadata"

From Creative Commons
Jump to: navigation, search
(→‎Specifying Language)
Line 11: Line 11:
 
* Summary: A relatively short summary/synopsis of the resource.
 
* Summary: A relatively short summary/synopsis of the resource.
 
* License: This should be a URL to the license; e.g., http://creativecommons.org/licenses/by/3.0/.
 
* License: This should be a URL to the license; e.g., http://creativecommons.org/licenses/by/3.0/.
−
* Grade level (cc:gradelevel): What grade(s) or age-level(s) this material is suitable for.
+
* Grade level (dc:educationLevel): What grade(s) or age-level(s) this material is suitable for.
−
* Language (cc:lang): The language(s) of the referenced resource (not of your site).
+
* Language (xml:lang): The language(s) of the referenced resource (not of your site).
 
* Subject (cc:subject): The subject(s) of the resource; e.g., math.
 
* Subject (cc:subject): The subject(s) of the resource; e.g., math.
  
Line 25: Line 25:
 
<pre>cc:<field>:<data></pre>
 
<pre>cc:<field>:<data></pre>
  
−
For example, the <code><category></code> content for Language would become something like:
+
For example, the <code><category></code> content for Subject would become something like:
  
−
<pre>cc:lang:es</pre>
+
<pre>cc:subject:Math</pre>
−
 
 
−
Examples for Grade level could be:
 
−
 
 
−
<pre>cc:gradelevel:3
 
−
cc:gradelevel:primary</pre>
 
  
 
The Creative Commons-specific fields build upon existing category/tag support in feeds.  Therefore any <code>cc:</code> field may be specified multiple times if needed.  The fields we currently use for refining search results include:
 
The Creative Commons-specific fields build upon existing category/tag support in feeds.  Therefore any <code>cc:</code> field may be specified multiple times if needed.  The fields we currently use for refining search results include:
  
 
* Subject: cc:subject:<data>
 
* Subject: cc:subject:<data>
−
* Grade level: cc:gradelevel:<data>
 
−
* Language: cc:lang:<data>
 
  
 
=== Specifying Subject ===
 
=== Specifying Subject ===
Line 44: Line 37:
 
The subject refers to the actual content in the resource; i.e., what is this resource ''about''? For many resources, more than one subject will be necessary; in this case, specify multiple subject <category> elements.  We ask that you try to limit the number of elements to only those subjects that are objectively reflective of the entire resource. If you want to include other types of categories (opinions, metrics, etc), please add those as normal (un-prefixed) <category> elements instead.
 
The subject refers to the actual content in the resource; i.e., what is this resource ''about''? For many resources, more than one subject will be necessary; in this case, specify multiple subject <category> elements.  We ask that you try to limit the number of elements to only those subjects that are objectively reflective of the entire resource. If you want to include other types of categories (opinions, metrics, etc), please add those as normal (un-prefixed) <category> elements instead.
  
−
=== Specifying Grade level ===
+
== Specifying Education level ==
 +
 
 +
The education level should indicate all levels (student ages) for which the resource is deemed appropriate. The education level should be labeled using the [http://dublincore.org/documents/dcmi-terms/#terms-educationLevel dc:educationLevel] term. 
  
−
The grade level should indicate all grade levels (student ages) for which the resource is deemed appropriate. Though we will accept any descriptions that seem appropriate to you, please consider using one of the following schemas:  
+
Though we will accept any descriptions that seem appropriate to you, please consider using one of the following schemas:  
  
 
* primary, secondary, tertiary, adult;  
 
* primary, secondary, tertiary, adult;  
 
* K,1,2,3,...,20 (where the number refers to the actual grade-level).  
 
* K,1,2,3,...,20 (where the number refers to the actual grade-level).  
  
−
You may include equivalent terms as well by specifying more than one <code>cc:gradelevel</code> <category>.  For example, you might include a <code>cc:gradelevel</code> for <code>9</code>, <code>10</code>, and <code>secondary</code>.
+
You may include equivalent terms as well by specifying more than one <code>dc:educationLevel</code> <category>.  For example, you might include a <code>dc:educationLevel</code> for <code>9</code>, <code>10</code>, and <code>secondary</code>.
  
−
=== Specifying Language ===
+
== Specifying Language ==
  
−
When specifying the language for a resource, the value should be specified as the [http://en.wikipedia.org/wiki/ISO_639-1 ISO-639-1] code.  For example, <code>en</code> for English.  When specifying a national dialect, the [http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 ISO-3166 alpha-2] code should be appended.  For example, to distinguish English (United States) from English (United Kindgom), the language would be specified as <code>en-US</code> and <code>en-GB</code>, respectively.
+
When specifying the language for a resource, the value should be specified as described by [http://www.ietf.org/rfc/rfc3066.txt RFC-3066].  For example, <code>en</code> for English.  To distinguish English (United States) from English (United Kindgom), the language would be specified as <code>en-US</code> and <code>en-GB</code>, respectively.
  
−
In general, we are expecting that most resources will consist of a single language, but if more than one language is present, provide a <code>cc:lang</code> <category> for each.
+
In an Atom 1.0 feed, the language is specified as the <code>xml:lang</code> attribute of the <code>content</code> element.  Multiple languages in a single entry is not supported.
  
−
=== Embedding license data ===
+
== Embedding license data ==
  
 
Since the licensing of a resource is expected to be conveyed via URL, we can leverage the Atom &lt;link&gt; element.  However we must markup the link element so as to identify it as a license URL.  This is accomplished with adding the attribute rel="license" to the &lt;link&gt; element.  For example:
 
Since the licensing of a resource is expected to be conveyed via URL, we can leverage the Atom &lt;link&gt; element.  However we must markup the link element so as to identify it as a license URL.  This is accomplished with adding the attribute rel="license" to the &lt;link&gt; element.  For example:
Line 90: Line 85:
 
     <link rel="license" href="http://creativecommons.org/licenses/by/3.0/" />
 
     <link rel="license" href="http://creativecommons.org/licenses/by/3.0/" />
 
     <category term="cc:subject:Math" />
 
     <category term="cc:subject:Math" />
−
     <category term="cc:gradelevel:5" />
+
     <category term="dc:educationLevel:5" />
−
     <category term="cc:lang:en" />
+
     <content type="xhtml" xml:lang="en">The content</content>
 
   </entry>
 
   </entry>
 
</feed>
 
</feed>
−
</pre>
 
−
 
−
=== RSS 2.0 example ===
 
−
Here is a sample, one entry RSS 2.0 feed which implements the guidelines above.
 
−
 
−
<pre>
 
−
<?xml version="1.0"?>
 
−
<rss version="2.0"
 
−
  xmlns:atom="http://www.w3.org/2005/Atom"
 
−
  xmlns:creativeCommons="http://backend.userland.com/creativeCommonsRssModule"
 
−
>
 
−
  <channel>
 
−
    <title>OER Web Site</title>
 
−
    <link>http://oersite.org/</link>
 
−
    <atom:link rel="self" href="http://oersite.org/cc/rss20.xml" type="application/atom+xml" />
 
−
    <description>OER Aggregation Web Site</description>
 
−
    <lastBuildDate>Wed, 16 Jan 2008 15:00:00 -0800</lastBuildDate>
 
−
    <webMaster>webmaster@oersite.org (John Q. Public)</webMaster>
 
−
    <item>
 
−
      <guid isPermaLink="false">tag:ocw.org,2007-10-15:/math/101</guid>
 
−
      <pubDate>Mon, 12 Nov 2007 09:15:00 -0800</pubDate>
 
−
      <link>http://ocw.org/math/101</link>
 
−
      <title>Math 101</title>
 
−
      <description>Basic mathematics for 5th graders</description>
 
−
      <creativeCommons:license>http://creativecommons.org/licenses/by/3.0/</creativeCommons:license>
 
−
      <category>cc:subject:Math</category>
 
−
      <category>cc:gradelevel:5</category>
 
−
      <category>cc:lang:en</category>
 
−
    </item>
 
−
  </channel>
 
−
</rss>
 
−
 
 
</pre>
 
</pre>

Revision as of 22:37, 7 February 2008

Overview

This document outlines the format in which ccLearn would like to receive syndication feeds for the data that will go into our OER database.

The data must be supplied in an Atom or RSS format. Both of these standards are in widespread use on the Internet for content syndication.

Presently, ccLearn is looking for the following data:

  • Link: Full URL of the referenced resource.
  • Title: A brief descriptive title for the resource.
  • Summary: A relatively short summary/synopsis of the resource.
  • License: This should be a URL to the license; e.g., http://creativecommons.org/licenses/by/3.0/.
  • Grade level (dc:educationLevel): What grade(s) or age-level(s) this material is suitable for.
  • Language (xml:lang): The language(s) of the referenced resource (not of your site).
  • Subject (cc:subject): The subject(s) of the resource; e.g., math.

CC-specific categories (tags/fields)

The CC Specific fields do not have native Atom or RSS element definitions. For these fields we suggest that they be embedded as category or tag specifications (<category> in Atom) with a specific prefix. These have the general format of:

cc:<field>:<data>

For example, the <category> content for Subject would become something like:

cc:subject:Math

The Creative Commons-specific fields build upon existing category/tag support in feeds. Therefore any cc: field may be specified multiple times if needed. The fields we currently use for refining search results include:

  • Subject: cc:subject:

Specifying Subject

The subject refers to the actual content in the resource; i.e., what is this resource about? For many resources, more than one subject will be necessary; in this case, specify multiple subject <category> elements. We ask that you try to limit the number of elements to only those subjects that are objectively reflective of the entire resource. If you want to include other types of categories (opinions, metrics, etc), please add those as normal (un-prefixed) <category> elements instead.

Specifying Education level

The education level should indicate all levels (student ages) for which the resource is deemed appropriate. The education level should be labeled using the dc:educationLevel term.

Though we will accept any descriptions that seem appropriate to you, please consider using one of the following schemas:

  • primary, secondary, tertiary, adult;
  • K,1,2,3,...,20 (where the number refers to the actual grade-level).

You may include equivalent terms as well by specifying more than one dc:educationLevel <category>. For example, you might include a dc:educationLevel for 9, 10, and secondary.

Specifying Language

When specifying the language for a resource, the value should be specified as described by RFC-3066. For example, en for English. To distinguish English (United States) from English (United Kindgom), the language would be specified as en-US and en-GB, respectively.

In an Atom 1.0 feed, the language is specified as the xml:lang attribute of the content element. Multiple languages in a single entry is not supported.

Embedding license data

Since the licensing of a resource is expected to be conveyed via URL, we can leverage the Atom <link> element. However we must markup the link element so as to identify it as a license URL. This is accomplished with adding the attribute rel="license" to the <link> element. For example:

<link rel="license" href="http://creativecommons.org/licenses/by/3.0/" />

See the complete CC with syndication formats documentation for more information.

Examples

Atom 1.0 example

Here is a sample, one entry Atom 1.0 feed which implements the guidelines above.


<feed xmlns="http://www.w3.org/2005/Atom">
  <id>http://oersite.org/cc/</id>
  <title>OER Aggregation Web Site</title>
  <updated>2008-01-16T12:00:00Z</updated>
  <link rel="self" href="http://oersite.org/cc/atom.xml" type="application/atom+xml" />
  <author>
    <name>John Q. Public</name>
    <email>webmaster@oersite.org</email>
  </author>
  <entry>
    <id>tag:ocw.org,2007-10-15:/math/101</id>
    <updated>2007-10-15T12:00:00Z</updated>
    <link href="http://ocw.org/math/101" />
    <title>Math 101</title>
    <summary>Basic mathematics for 5th graders</summary>
    <link rel="license" href="http://creativecommons.org/licenses/by/3.0/" />
    <category term="cc:subject:Math" />
    <category term="dc:educationLevel:5" />
    <content type="xhtml" xml:lang="en">The content</content>
  </entry>
</feed>
Retrieved from "https://wiki.creativecommons.org/index.php?title=DiscoverEd_Metadata&oldid=10862"