SEARCH
TOOLBOX
LANGUAGES
Create a book
Syndication/formats/feed

Syndication/formats/feed

From Steeple

Jump to: navigation, search

Contents

[edit] 1 Full version

This page provides a longer description of the feed <item>, with a number of additonal elements for more elaborate uses.

[edit] 2 The rss:item (or <atom:entry>) 

<item>
<!--

[edit] 2.1 Basic title, description, pubDate, id

A number of standard elements. 

-->
 
<title>The title of this media item</title>
<media:title s:type="subtitle">How to set up an item in steeple</media:title>
<media:title s:type="short">The title</media:title>
 
<!--
The description. (In atom, this would be <summary>)
-->
<description>Description ....</description>
<media:description s:type="short">Shorter description.</media:description>
<!--
The standard rss:pubDate or atom:updated is used for the date on which the rss item was changed.
Not for creation/first publication - see more dates below.
 
CHECK THIS
-->
 
<pubDate></pubDate>
<atom:updated />
<!--
rss:guid, or atom:id
If you have the content in several places, the guid needs to identify the item irrespective of url
-->
<guid isPermaLink="false"></guid>
 
<atom:link rel="self" href="....." />
 
<!--
id provided for aggregator.
Bjoern is still not quite sure how to do that.
<atom:link rel="http://purl.org/steeple/id" href="..." /> 
<atom:category scheme="http://purl.org/steeple/id" term="" />
-->
 
<media:category domain="http://purl.org/steeple/id" label="" >cam.ac.uk/sms/2342340923</media:category>
 
<atom:category scheme="http://purl.org/steeple/feedtype"  term="media" />
 
<!--

[edit] 2.2 Institutional classification

"Organisation" is mandatory (if not given at feed level), others are not mandatory. Institutional or departmental classification: not needed here if included in the feed head. See http://purl.org/steeple/institutional classification 

-->
 <atom:category scheme="http://purl.org/steeple/organisation" term="http://www.ox.ac.uk" label="Oxford University" />
 <atom:category scheme="http://purl.org/steeple/division" term="<e.g. via LDAP>" label="Section of Physical Sciences" />
 <atom:category scheme="http://purl.org/steeple/department" term="<e.g. via LDAP>" label="Physics Department" />
 <atom:category scheme="http://purl.org/steeple/group" term="" label="" />
 
<!--
For 'term' e.g. can use LDAP identifier.
terms needs to be identified at http://purl.org/steeple/department
-->
 <atom:category scheme="http://purl.org/steeple/department" term="CARET" label="Centre for Applied Research in Educational Technologies" />
<--

[edit] 2.3 Subject classification

Need to adopt a classification.

  • Library of congress? British Library?
  • Laurian to look at existing mappings
  • Apple list of labels needs to be agreed regarding human readable terms. 
-->
 <atom:category scheme="...british library..." term="..." label="..." />
 
<!-- additional classification into iTunes subjects -->
 <atom:category scheme="http://purl.org/steeple/category/itunesu" term="101" label="Engineering" />
 <atom:category scheme="http://purl.org/steeple/category/itunesu" term="104101" label="..." />
 <atom:category scheme="http://purl.org/steeple/category/itunesu" term="108" label="..." />
 
<!-- local classifications can also be added -->
 <atom:category scheme="http://www.open.ac.uk/.../bluelist" term="..." label="..." />
 
<!--

[edit] 2.4 credit-type description for this piece.

One of the key things missing from rss/atom is a description of people appearing in the video, appropriate for academic contexts. The closet we can get to re-using existing structures is to use the media:credit construct, with a new scheme. See http://purl.org/steeple/credit 

-->
 
<media:credit role="presenter" scheme="http://purl.org/steeple/credit">Prof. Dr. A. B. C. Smith-Jones (University of Oxford)</media:credit>
<media:credit role="presenter" scheme="http://purl.org/steeple/credit">Prof. Dr. D. E. F. Taylor (University of Cambridge)</media:credit>
<media:credit role="interviewer" scheme="http://purl.org/steeple/credit"></media:credit>
<media:credit role="producer" scheme="http://purl.org/steeple/credit"></media:credit>
<media:credit role="producer institution" scheme="http://purl.org/steeple/credit"></media:credit>
<media:credit role="creator" scheme="http://purl.org/steeple/credit"></media:credit>
 
<!--
Agree that <author> is not used by the aggregator, because it's ambivalent.
-->
<author>Not Used</author>
 
<!--

[edit] 2.5 media related information starts

Note: For detailed information on media:content, see media:content. 

-->
 
<!--
Add enclosure, to ensure compatibility with broadest range of feedreaders.
Enclosure content is duplicated in one media:content item below (with isDefault="true"),
having the same url/size in bytes/mime type.
-->
<enclosure ... />
 
<s:duration>5:31</s:duration>
 
<!-- 
Optional: The primary mediatype:
- audio
- video
- screencast
- learningobject
- document
-->
 <atom:category scheme="http://purl.org/steeple/mediatype" term="video" />
<!--
It can also be used inside a <media:group> or inside a <media:content> element. In that case
 <media:category scheme="http://purl.org/steeple/mediatype">term</media:category>
can be used.
-->
 
<media:group>
 
<!--
optional: 
<media:title>lecture recording</media:title>
-->
 
 <media:content
              url="url"
              fileSize="length"
              type="type"
              medium="video"
              isDefault="true"
              expression="full"
              bitrate="128"
              height="200"
              width="300"
              duration="185"
              s:FlashCompatible="9.0.115.0"
              s:transport="streaming,progressive,seekable,download"
              s:version="..."
              lang="en" />
 
<!--
If there are alternative versions of the same media item, they can follow in the same media:group, by adding media:content items. 
Those items are structured the same as the above item, but we omit most attributes for brevity.
 
  If items are available via P2P, add the <media:peerLink> element to <media:content>
 <media:content ...><media:peerLink type="application/x-bittorrent " href="http://www.example.org/sampleFile.torrent"  /></media:content>
-->
 
 <media:content
              url="url2"
              fileSize="length"
              type="type"
              medium="video"
              isDefault="false"
              expression="full"
              bitrate="1024"
              height="600"
              width="900"
              duration="185"
              ...
              lang="en" >
                    <media:peerLink type="application/x-bittorrent " href="http://www.example.org/sampleFile.torrent"  />
                    <media:hash algo="...">....</media:hash>
   </media:content>
 
<!-- 
         Audio versions, and audio descriptions should also be put into the same media:group, if they relate to the same media item. 
-->
 
 <media:content  url="url3"  s:rel="audio track" .... />
 <media:content  url="url4"  s:rel="audio description" .... />
 <media:content  url="url4"  s:rel="commentary" .... />
 
 <media:content  url="url5"  s:rel="transcript" url="....pdf" />
 
 <media:thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="" s:type="keyframe|slide|thumb|cover" s:attribution="" />
 <!-- Attribution for images? E.g. where the image is CC-By -->
 
<!-- representation of subtitles -->
 <media:text start="00:00:00.000" xml:lang="en" s:type="subtitles">content for close captions / subtitles</media:text>
 <media:text start="00:01:00.000" xml:lang="en" s:type="subtitles">content for close captions / subtitles</media:text>
 <media:text start="00:01:20.000" xml:lang="en" s:type="subtitles">content for close captions / subtitles</media:text>
 <media:text start="00:02:10.000" xml:lang="en" s:type="subtitles">content for close captions / subtitles</media:text>
 
<!-- representation of close captions -->
 <media:text start="00:00:00.000" xml:lang="en" s:type="cc">content for close captions / subtitles</media:text>
 
<!-- where subtitles are in an external file, the <media:subTitle> is used -->
 <media:subTitle type="application/smil" lang="en-us"  href="http://www.example.org/subtitle.smil"  />
 
<!-- additional timed information -->
 <media:text start="00:00:00.000" xml:lang="en" s:type="chapter">chapter</media:text>
 <media:text start="00:00:00.000" xml:lang="en" s:type="keywords">timed keywords</media:text>
 <media:text start="00:00:00.000" xml:lang="en" s:type="description">additional description</media:text>
 
</media:group>
 
<media:group> 
<!--
        More media groups might follow, or other media:content items if there is only one version
-->
</media:group>
 
<media:content  url="url5.pdf"  expression="full" .... ><media:title>Lecture slides as pdf</media:title></media:content>
 
<media:content  url="url6.mp3"  expression="full" .... ><media:title>Further reflections on the main media item</media:title></media:content>
 
 
<!--
             media related information ends
-->
 
<!--

[edit] 2.6 additional information 

-->
 
<!-- 
rss:link, treated the same as first <atom:link rel="related"> 
-->
<link></link>
 
<!--
 
-->
<atom:link rel="http://purl.org/steeple/context" href="" title="View this item in the original context at Oxford University">View this item in the original context at Oxford University</atom:link>
 
<!-- 
 
To specify keywords, we use media:keywords.
 
* Comma separation vs. multipl instances?
* Ease of use with parsers
-->
<media:keywords>a, b, c</media:keywords>
 
<atom:category scheme="http://purl.org/steeple/keyword" term="a"/>
<atom:category scheme="http://purl.org/steeple/keyword" term="b"/>
<atom:category scheme="http://purl.org/steeple/keyword" term="c"/>
 
<!-- 
spacetime related information 
Laurian to look up.
- creation of media (i.e. the date of the event) -> use "ev" namespace
- first publishing of media item rss:pubDate
- updated is covered in atom:created
 
-->
<ev:startdate />
 
<!--
To do:
* http://www.georss.org/georss as "<georss:point>45.256 -71.92</georss:point>" ?
<georss:where><gml:Point><gml:pos>45.256 -110.45</gml:pos></gml:Point></georss:where>
 
c.f. also YouTube.
 
<georss:point>45.256 -71.92</georss:point>
 
-->
 
<geo:lat></geo:lat>
<geo:lon></geo:lon>
 
<!-- ideally we would want to be able to describe several points ...., see media: .-->
 
<!--
optional:
 
Purpose: Aggregator knows when things expire.
 
The absence of dcterms:valid doesn't mean indefinite valid.
-->
<dcterms:valid>
    start=2002-10-13T09:00+01:00;
    end=2002-10-17T17:00+01:00;
    scheme=W3C-DTF
</dcterms:valid>
 
<!--

[edit] 2.7 Licensing 

-->
<!--
Copyright holder and license needs to be indicated.
 
WRITE NOTES!!
 
We recommended this:
-->
<media:copyright url=".......">Oxford University</media:copyright>
<media:license type="text/html" href="http://creativecommons.org/licenses/by/3.0/us/">
 Creative Commons Attribution 3.0 United States License.
 Add attribution here: This item was produced by <a href="...">Dr. A. Smith</a>.
</media:license>
 
<!--
using this contstruct has several advantages: It allows the specification of any license, and we can specify the url and text in the same element.
 
However, if the license is CC, add <cc:license> for compatibility with other feedreaders.
-->
<cc:license>http://www.creativecommons.org/licenses/by-nc/1.0</cc:license>
<!--
but this is not mandatory for the Steeple aggregation.
 
Note also 
<cc:attributionName/>
<cc:attributionURL/>
-->
</item>


[edit] 2.8 Additional pieces

These elements assume that ev and geo are declared using the namespace declarations: 

 xmlns:ev="http://purl.org/rss/1.0/modules/event/"
 xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#"

These two XML modules are defined at: 

 http://web.resource.org/rss/1.0/modules/event/
 http://www.w3.org/2003/01/geo/wgs84_pos#

  <ev:startdate>2009-12-03T14:00:00+00:00</ev:startdate>
  <ev:enddate>2009-12-03T15:00:00+00:00</ev:enddate>
  <ev:location>OX1 3QU (Main Meeting Room, New Biochemistry Building, Department of Biochemistry, South Parks Road, Oxford)</ev:location>
  <geo:lat>51.759091</geo:lat>
  <geo:long>-1.255121</geo:long>

[edit] 3 Notes

[edit] 3.1 media:credit

Usage for media:credit is described here: http://purl.org/steeple/media:credit.

[edit] 3.2 media:content 

 <media:content ....
              s:FlashCompatible="9.0.115.0"
              s:transport="streaming,progressive,seekable,download"
              s:version="<timestamp of file or other identifier>"
 />

For further notes, see http://purl.org/steeple/media:content

[edit] 3.3 atom:category vs. media:category vs. rss:category

Why do we use both atom:category and media:category?

  • We use atom:category where
    • the category cannot appear within a <media:group> element.
    • where the terms can be validated (i.e. where there is a limited set of terms)
  • We use media:category where
    • the category can also to appear within a <media:group> element.
    • where the terms are arbitrary (such as ids)

We do not use rss:category, because (unlike atom:category and media:category) there is only a 'term', but no 'label'.

[edit] 3.4 Licenses and copyright

[edit] 3.4.1 Adding copyright and license statements.

Copyright is added like this: 

 <media:copyright url="... url to copyright statement ...">Copyright holder</media:copyright>

[edit] 3.4.2 How do I add a license?

Separately from the copyright, a license can be added, e.g. 

 <media:license type="text/html" href="http://creativecommons.org/licenses/by/3.0/us/">Creative Commons Attribution 3.0 United States</media:license>

The CC licenses state that "You must attribute the work in the manner specified by the author or licensor (but not in any way that suggests that they endorse you or your use of the work).", and so we have to make provision for this. We suggest that if a special form of attribution is required, that htis is added as follows: 

 <media:license type="text/html" href="http://creativecommons.org/licenses/by/3.0/us/">
        Creative Commons Attribution 3.0 United States.
        Attribution: This item was produced by <a href="...">Dr. A. Smith</a>.
 </media:license>

[edit] 3.4.3 Can I provide my own license?

It is highly recommended to use a recognised license (that has been thoroughly checked by lawyers), so for that reason alone it's worth considering a CC license. However, the <media:license> element can be used to indicate any license 

 <media:license type="text/html" href="http://.... link to my license ....">My license title</media:license>

[edit] 3.4.4 I'm in the UK (England/Wales), which CC licenses should I use?

The following assumes that you are the copyright holder, as indicated by <media:copyright> above.

The six CC licenses available in the UK (see http://creativecommons.org/international/uk/ http://creativecommons.org/choose/?jurisdiction=uk) should be expressed as follows: 

 <media:license type="text/html" href="http://creativecommons.org/licenses/by/2.0/uk/">Creative Commons Attribution 2.0 UK: England &amp; Wales</media:license>
 <media:license type="text/html" href="http://creativecommons.org/licenses/by-nc/2.0/uk/">Creative Commons Attribution-Noncommercial 2.0 UK: England &amp; Wales</media:license>
 <media:license type="text/html" href="http://creativecommons.org/licenses/by-nc-nd/2.0/uk/">Creative Commons Attribution-Noncommercial-No Derivative Works 2.0 UK: England &amp; Wales</media:license>
 <media:license type="text/html" href="http://creativecommons.org/licenses/by-nc-sa/2.0/uk/">Creative Commons Attribution-Noncommercial-Share Alike 2.0 UK: England &amp; Wales</media:license>
 <media:license type="text/html" href="http://creativecommons.org/licenses/by-nd/2.0/uk/">Creative Commons Attribution-No Derivative Works 2.0 UK: England &amp; Wales</media:license>
 <media:license type="text/html" href="http://creativecommons.org/licenses/by-sa/2.0/uk/">Creative Commons Attribution-Share Alike 2.0 UK: England &amp; Wales</media:license>

To waive copyright to the fullest extent the law permits, you can use the CC0 license. 

 <media:license type="text/html" href="http://creativecommons.org/publicdomain/zero/1.0/">Creative Commons Zero</media:license>

[edit] 3.4.5 I've got a work which is owned by somebody else

Assuming that you have obtained suitable permissions from the copyright holder, you should use the same constructs as above. Copyright is a tricky area, and you need to make sure that you know what you are doing.

[edit] 3.4.6 I've got a work which I know to be in the public domain

You should do a public domain certification using http://creativecommons.org/licenses/publicdomain/ and then indicate this by stating 

<media:copyright url="http://.... link to your public domain certification of the work ....">Public Domain</media:copyright>

Note that public domain is linked to US law, and you need to be clear about how this would work in the UK.


[edit] 3.5 Where do I find the Category Codes that are used with iTunes U?

The Category Codes used with iTunes U are listed in a section entitled Category Codes in the manual at http://deimos.apple.com/rsrc/doc/iTunesUAdministratorsGuide

I'm not sure whether to include the next paragraph.

There is an Atom 1.0 file containing this information at http://rss.oucs.ox.ac.uk/metafeeds/applecategorycodes.atom10

Page imported from here.

Retrieved from "http://www.steeple.org.uk/wiki/Syndication/formats/feed"