ORE Specification - Resource Map Profile of Atom

14 April 2008

Note: This document is alpha and subject to change at any time. It is being made available to the public for review and comment. Any implementation of the specifications or recommendations within should be undertaken with recognition of this alpha status. Please comment via the OAI-ORE Google Group.
This version:
http://www.openarchives.org/ore/0.3/atom
Latest version:
http://www.openarchives.org/ore/atom
Previous version:
http://www.openarchives.org/ore/0.2/atom
Editors (OAI Executive)
Carl Lagoze, Cornell University Information Science
Herbert Van de Sompel, Los Alamos National Laboratory
Editors (ORE Technical Committee)
Pete Johnston, Eduserv Foundation
Michael Nelson, Old Dominion University
Robert Sanderson, University of Liverpool
Simeon Warner, Cornell University Information Science

Abstract

Open Archives Initiative Object Reuse and Exchange (OAI-ORE) defines standards for the description and exchange of aggregations of Web resources, named Aggregations. OAI-ORE introduces the notion of Resource Maps that describe an Aggregation. A Resource Map is resource that is a specialization of a named graph. A Resource Map identifies an Aggregation, it asserts the finite set of constituent resources (the Aggregated Resources) of the Aggregation, and it can express types and relationships pertaining to the Aggregation and its Aggregated Resources. Each Aggregation may be described by one or more Resource Maps, each of which must have exactly one representation that is a serialization of the Resource Map according to a specific format. The purpose of this document is to specify a serialization for Resource Maps based on, and compliant with the Atom syndication format. This Atom-based format to serialize Resource Maps may be referred to as the Resource Map Profile of Atom. Atom-based Resource Maps may be appealing to a number of application domain because of their simplicity and reliance on common Web feed technology. This specification is one of several documents comprising the OAI-ORE specification and user guide.


Table of Contents

1. Introduction
    1.1 Notational Conventions
    1.2 Compliance
    1.3 Example
2. Correspondence between the ORE Model and the Atom Model
3. Use of Atom Constructs in the Resource Map Profile of Atom
    3.1 Text Constructs
    3.2 Person Constructs
    3.3 Date Constructs
4. Use of Atom Elements in the Resource Map Profile of Atom
    4.1 Container Elements
         4.1.1 The "atom:feed" Element
         4.1.2 The "atom:entry" Element
         4.1.3 The "atom:content" Element
    4.2 Metadata Elements
         4.2.1 The "atom:author" Element
         4.2.2 The "atom:category" Element
         4.2.3 The "atom:contributor" Element
         4.2.4 The "atom:generator" Element
         4.2.5 The "atom:icon" Element
         4.2.6 The "atom:id" Element
         4.2.7 The "atom:link" Element
         4.2.8 The "atom:logo" Element
         4.2.9 The "atom:published" Element
         4.2.10 The "atom:rights" Element
         4.2.11 The "atom:source" Element
         4.2.12 The "atom:subtitle" Element
         4.2.13 The "atom:summary" Element
         4.2.14 The "atom:title" Element
         4.2.15 The "atom:updated" Element
         4.2.16 Use of Atom Extension Elements in the Resource Map Profile of Atom
             4.2.16.1 Extension Elements for the "atom:feed" Element
             4.2.16.2 Extension Elements for the "atom:entry" Element
5. References

Appendices

A. Acknowledgements
B. Extended Example
C. Schematron Schema for Resource Map Profile of Atom
D. GRDDL crosswalk from Atom XML to RDF/XML
E. Change Log


1. Introduction

Open Archives Initiative Object Reuse and Exchange (OAI-ORE) defines standards for the description and exchange of aggregations of Web resources, named Aggregations. OAI-ORE introduces the notion of Resource Maps that describe an Aggregation. A Resource Map is resource that is a specialization of an RDF Graph known as a Named Graph [Named Graph]. A Resource Map identifies an Aggregation, it asserts the finite set of constituent resources (the Aggregated Resources) of the Aggregation, and it can express types and relationships pertaining to the Aggregation and its Aggregated Resources. Each Aggregation may be described by one or more Resource Maps, each of which must have exactly one representation that is a serialization of the Resource Map according to a specific format. The purpose of this document is to specify a serialization for Resource Maps based on, and compliant with the Atom syndication format [RFC4287]. This Atom-based format to serialize Resource Maps may be referred to as the Resource Map Profile of Atom. Atom-based Resource Maps may be appealing to a number of application domain because of their simplicity and reliance on common Web feed technology.

The ORE Model imposes constraints on the types of triples that can be expressed in the Resource Map RDF Graph. Although the hierarchical structure of Atom Feeds does not naturally accomodate the expression of aribtrary graphs, the Atom-based serialization of the Resource Map RDF Graph described in this document is capable of expressing the entire range of triples allowed by the ORE Abstract Data Model in Atom. Moreover, Atom-based Resource Maps can automatically and losslessly be transformed into the RDF/XML serializations of Resource Maps as described in the ORE User Guide - Representing Resource Maps Using RDF Syntaxes [ORE User Guide RDF Syntax].

This specifcation uses concepts and terms introduced in the following ORE documents:

The Resource Map Profile of Atom is fully compliant with the Atom Syndication Format [RFC4287] but defines a specific profile of it:

The ORE User Guide - Resource Map Implementation in Atom [ORE User Guide Resource Map] provides Atom implementation guidance that supplement this specification.

1.1 Notational Conventions

This specification uses the namespace prefix "atom:" for the Atom Namespace URI "http://www.w3.org/2005/Atom" as defined in Section 1.2 of [RFC4287], and the namespace prefix "rdf:" for the RDF Namespace URI "http://www.w3.org/1999/02/22-rdf-syntax-ns#" as defined is Section 4 of [RDF CONCEPTS]. Note that the choice of namespace prefix is arbitrary and not semantically significant.

This specification uses the same shorthands to terms from the XML Infoset [XML Infoset] as used in [RFC4287]: the phrase "Information Item" is omitted when naming Element Information Items and Attribute Information Items. Therefore, when this specification uses the term "element," it is referring to an Element Information Item in Infoset terms. Likewise, when it uses the term "attribute," it is referring to an Attribute Information Item.

This specification uses the common term URI [RFC3986] to mean both IRI [RFC3987] and URI.

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119].

1.2 Compliance

A Resource Map expressed according to the Resource Map Profile of Atom MUST be compliant with the Atom Syndication Format [RFC4287]. Moreover, it MUST adhere to the semantic mapping between the ORE Model and the Atom model detailed Section 2, as well as to the restrictions and extensions of the Resource Map Profile of Atom detailed in Section 3 and Section 4.

Specifically, a Resource Map expressed according to the Resource Map Profile of Atom MUST be a well-formed XML document that is valid according to the Relax NG Compact Schema of [RFC4287]. Moreover, it MUST be valid according to the more specific Schematron Schema of Appendix C that further restricts the Atom syntax to the Resource Map Profile of Atom.

1.3 Example

Throughout the remainder of this document, the following scenario will be used to illustrate the specifics of the Resource Map Profile of Atom.

D-Lib Magazine <http://www.dlib.org> decides to embrace the OAI-ORE specification by minting Aggregation URIs (URI-A in the ORE Model) for each of its articles, and by making an Atom-based Resource Map available for each of those Aggregations. Each Aggregation consists of all Web resources that make up a D-Lib article, and each Atom-based Resource Map expresses this constituency in an Atom-compliant manner. The scenario zooms in on the following article:

Joan A. Smith, Frank McCown, Michael L. Nelson. Observed Web Robot Behavior on Decaying Web Subsites. D-Lib Magazine, Volume 12, Number 2, February 2006. doi:10.1045/february2006-smith. <http://dx.doi.org/10.1045/february2006-smith>.

When implementing OAI-ORE, D-Lib Magazine mints a new URI for the Aggregation (URI-A of an Aggregation in the ORE Model) that will correspond with the journal article: <http://www.dlib.org/dlib/february06/smith/aggregation>. In addition, it makes the Atom-based Resource Map that describes this Aggregation available at another URI (URI-R of a Resource Map in the ORE Model): <http://www.dlib.org/dlib/february06/smith/aggregation.xml>. Alternative approaches to mint URIs for an Aggregation and its corresponding Resource Maps are described in ORE User Guide - HTTP Implementation and Multiple Serializations. In order to support discovery of its Aggregations, D-Lib Magazine also implements one or more of the Resource Map discovery techniques described in the ORE User Guide - Resource Map Discovery [ORE User Guide Discovery].

A minimal Atom-based Resource Map for the D-Lib Magazine article is shown below. It is also available here. It will be further elaborated throughout this document, and a rich version is provided in Appendix B.

<?xml version="1.0" encoding="UTF-8" ?>
<atom:feed  xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:ore="http://www.openarchives.org/ore/terms/"
    xmlns:grddl="http://www.w3.org/2003/g/data-view#" 
    grddl:transformation="http://www.openarchives.org/ore/atom/atom-grddl.xsl"> 
    <!--  -->
    <!-- About the Aggregation --> 
    <!--  -->
    <atom:id>http://www.dlib.org/dlib/february06/smith/aggregation</atom:id>
    <atom:author>
        <atom:name>Michael Nelson</atom:name>
        <atom:uri>http://www.cs.odu.edu/~mln/</atom:uri>
    </atom:author>
    <atom:author>
        <atom:name>Joan Smith</atom:name>
        <atom:uri>http://www.joanasmith.com/</atom:uri>
    </atom:author>
    <atom:author>
        <atom:name>Frank McCown</atom:name>
        <atom:uri>http://www.cs.odu.edu/~fmccown/</atom:uri>
    </atom:author>
    <atom:title>Observed Web Robot Behavior on Decaying Web Subsites</atom:title>
    <atom:link href="info:doi/10.1045/february2006-smith" 
        rel="related"/>
    <atom:category  scheme="http://www.openarchives.org/ore/terms/" 
        term="http://www.openarchives.org/ore/terms/Aggregation" 
        label="Aggregation" />
    <atom:category  scheme="http://purl.org/eprint/type/" 
        term="http://purl.org/eprint/type/JournalArticle" 
        label="Journal Article" />
    <!--  -->
    <!-- About the Resource Map --> 
    <!--  -->
    <atom:link rel="self" 
        type="application/atom+xml" 
        href="http://www.dlib.org/dlib/february06/smith/aggregation.xml" />
    <atom:link rel="alternate" 
        type="application/rdf+xml" 
        href="http://www.dlib.org/dlib/february06/smith/aggregation.rdf" />
    <atom:generator uri="http://www.dlib.org">D-Lib Magazine</atom:generator>
    <atom:updated>2007-09-22T07:11:09Z</atom:updated>
    <!--  -->
    <!-- Aggregated Resources --> 
    <!--  -->
    <atom:entry>
        <atom:id>urn:uuid:abcefc20-4c4d-11dc-a9c2-0002a5d585c1</atom:id>
        <atom:author>
            <atom:name>Michael Nelson</atom:name>
            <atom:uri>http://www.cs.odu.edu/~mln/</atom:uri>
        </atom:author>
        <atom:author>
            <atom:name>Joan Smith</atom:name>
            <atom:uri>http://www.joanasmith.com/</atom:uri>
        </atom:author>
        <atom:author>
            <atom:name>Frank McCown</atom:name>
            <atom:uri>http://www.cs.odu.edu/~fmccown/</atom:uri>
        </atom:author>
        <atom:title>Observed Web Robot Behavior on Decaying Web Subsites</atom:title>
        <atom:updated>2007-08-17T21:12:44Z</atom:updated>
        <atom:category scheme="http://purl.org/ontology/bibo/" 
            term="http://purl.org/ontology/bibo/WebPage" 
            label="WebPage" />
        <atom:category  scheme="http://purl.org/dc/dcmitype/" 
            term="http://purl.org/dc/dcmitype/Text" 
            label="Text" />
        <atom:category  scheme="info:eu-repo/semantics/" 
            term="info:eu-repo/semantics/humanStartPage" 
            label="Human Start Page" />        
        <atom:link  rel="alternate" type="text/html" 
        href="http://www.dlib.org/dlib/february06/smith/02smith.html" />
    </atom:entry>
    <atom:entry>
        <atom:id>urn:uuid:abcefc20-4c4d-11dc-a9c2-0002a5d585c2</atom:id>
        <atom:title>owenbrauODULPT2 dgrp1 pg1-13-html</atom:title>
        <atom:updated>2007-08-17T21:12:44Z</atom:updated>
        <atom:category scheme="http://purl.org/ontology/bibo/" 
            term="http://purl.org/ontology/bibo/WebPage" 
            label="WebPage" />
        <atom:category  scheme="http://purl.org/dc/dcmitype/" 
            term="http://purl.org/dc/dcmitype/Text" 
            label="Text" />
        <atom:link  rel="alternate" 
            type="text/html" 
            href="http://www.dlib.org/dlib/february06/smith/pg1-13.html" />
    </atom:entry>
    <atom:entry>
        <atom:id>urn:uuid:abcefc20-4c4d-11dc-a9c2-0002a5d585c3</atom:id>
        <atom:title>owenbrauODULPT2 dgrp1 pg1-13-pdf</atom:title>
        <atom:updated>2007-08-17T21:12:44Z</atom:updated>
        <atom:category  scheme="http://purl.org/dc/dcmitype/" 
            term="http://purl.org/dc/dcmitype/Text" 
            label="Text" />
        <atom:link  rel="alternate" 
            type="application/pdf" 
            href="http://www.dlib.org/dlib/february06/smith/pg1-13.pdf" />
    </atom:entry>
    <atom:entry>
        <atom:id>urn:uuid:abcefc20-4c4d-11dc-a9c2-0002a5d585c4</atom:id>
        <atom:title>MLN_Google.png</atom:title>
        <atom:updated>2007-09-22T07:11:09Z</atom:updated>
        <atom:category  scheme="http://purl.org/dc/dcmitype/" 
            term="http://purl.org/dc/dcmitype/Image" 
            label="Image" />
        <atom:link  rel="alternate" 
            type="image/png" 
            href="http://www.dlib.org/dlib/february06/smith/MLN_Google.png" />
    </atom:entry>
    <atom:entry>
        <atom:id>urn:uuid:abcefc20-4c4d-11dc-a9c2-0002a5d585c5</atom:id>
        <atom:title>Bibliographic metadata for info:doi/10.1045/february2006-smith</atom:title>
        <atom:updated>2007-08-17T21:12:44Z</atom:updated>
        <atom:category  scheme="info:eu-repo/semantics/" 
            term="info:eu-repo/semantics/descriptiveMetadata" 
            label="Descriptive Metadata" />  
        <atom:link rel="alternate" 
            type="application/xml" 
            href="http://www.crossref.org/openurl?url_ver=Z39.88-2004&amp;rft_id=info:doi/10.1045/february2006-smith&amp;noredirect=true" />
    </atom:entry>
</atom:feed>

2. Correspondence between the ORE Model and the Atom Model

Table 1 illustrates how entities from the ORE Model map to entities from the Atom model [RFC4287].

In general, the mapping leverages the fact that the Atom model distinguishes between two URIs that pertain to an Atom Feed:

This corresponds nicely to the two crucial URIs of the ORE Model:

The mapping also introduces an Atom Entry for each Aggregated Resource of the Aggregation described by the Resource Map. The Aggregated Resource is conveyed in this Atom Entry as the link target a unique atom:link child element of atom:entry that expresses an "alternate" relationship; the value of the href attribute of this atom:link is the URI of the Aggregated Resource (URI-AR). At the Atom Entry level, the mapping again leverages the distinction between two URI's that pertain to an Atom Entry:

These corresponds to URIs introduced by the ORE Model in relation to the advanced concept of a Proxy for an Aggregated Resource, which indicates the Aggregated Resource not in its own right, but rather as it exists in the context of the Aggregation:

Furthermore, the mapping introduces an unambiguous way to interpret other elements provided in an Atom-based Resource Map in terms of the ORE Model:

Table 1: Correspondence between items from the ORE and Atom models
Entities from the ORE Model Entities from the Atom model
Aggregation Atom Feed
The URI of an Aggregation (URI-A) Permanent, universally unique identifier of an Atom feed; the content of the atom:id child element of atom:feed
URI other than URI-A by which the Aggregation is known; resource that is the object of the ore:similarTo relationship The value of the href attribute of an atom:link child element of atom:feed that has a value of "related" for its rel attribute.
Relationships and types pertaining to the Aggregation Child elements of atom:feed that are in the Atom namespace (other than atom:generator, atom:updated, and atom:rights) as well as an rdf:Description child element of atom:feed with the URI of the Aggregation (URI-A) as the value for its rdf:about attribute.
   
Resource Map (from which an Atom-based representation is retrievable) Atom Feed Document
The URI of a Resource Map (URI-R) from which a representation describing the Aggregation is retrievable The preferred URI for retrieving Atom Feed Documents representing an Atom Feed; the value of the href attribute of an atom:link child element of atom:feed that has a value of "self" for its rel attribute.
Metadata pertaining to the (Atom-based) Resource Map atom:generator, atom:updated, and atom:rights child elements of atom:feed as well as an rdf:Description child element of atom:feed with the URI of the Atom-based Resource Map (URI-R) as the value for its rdf:about attribute.
 
  Atom Entry
The URI (URI-P) that identifies the Proxy for the Aggregated Resource Permanent, universally unique identifier of an Atom entry; the content of the atom:id child element of atom:entry
The URI (URI-AR) that identifies the Aggregated Resource The value of the href attribute of the single atom:link child element of atom:entry that has a value of "alternate" for its rel attribute.
Relationships and types pertaining to the Aggregated Resource Child elements of atom:entry that are in the Atom namespace (other than atom:published, atom:updated, atom:rights and atom:link with a rel attribute value of "via") as well as an rdf:Description child element of atom:entry with the URI of the Aggregated Resource (URI-AR) as the value for its rdf:about attribute.
Another Aggregation in which the Aggregated Resource is also aggregated; resource that is the object of the ore:isAggregatedBy relationship The value of the href attribute of an atom:link child element of atom:entry that has a value of "related" for its rel attribute.
The Aggregated Resource that itself is an Aggregation, indicated by an rdf:type for the Aggregated Resource with a value of ore:Aggregation and/or a ore:isDescribedBy relationship from the Aggregated Resource to a Resource Map. An atom:category child element of atom:entry that has a value of "http://www.openarchives.org/ore/terms/Aggregation" for its term attribute.
Lineage of an Aggregated Resource in another Aggregation, expressed via the ore:lineage relationship among the respective Proxies for the Aggregated Resource in both Aggregations The atom:link child element of atom:entry that has a rel attribute with a value of "via".
 
Proxy Document Atom Entry Document
The URI (URI-PD) from which a Proxy Document describing a subgraph of the Resource Map RDF Graph that pertains to the Aggregated Resource is retrievable The preferred URI for retrieving Atom Entry Documents representing an Atom entry; the value of the href attribute of an atom:link child element of atom:entry that has a value of "self" for its rel attribute.

Table 2 shows the elements of an Atom Feed used to serialize a Resource Map in the Atom format. Elements that are mandatory are highlighted.

Table 2: The elements of an Atom feed used to express an ORE Resource Map
Atom Feed Item Atom representation ORE Abstract Model
Feed ID

/feed/id

[RFC3987] [RFC3986]

URI-A

[URI of the Aggregation described by the Resource Map]

Feed Document "self" Link

/feed/link[@rel="self"]\
[@type="application/atom+xml"]/@href

[RFC3987] [RFC3986]

URI-R

[URI of the Resource Map from which an Atom-based representation describing the Aggregation is retrievable]

 

The relationship between the Feed ID and the Feed Document Link.

The triple:

URI-R ore:describes URI-A

[The Resource Map describes an Aggregation]

Feed Author

/feed/author/name
/feed/author/email

/feed/author/uri

[RFC2822]

It is RECOMMENDED to convey meaningful authorship information for the Aggregation. An example is the author of a journal article for which an Aggregation was minted.

[Relationships to other Resources and Types (pertaining to the Aggregation) ]

Feed Title

/feed/title

It is RECOMMENDED to convey a meaningful title for the Aggregation. An example is the title of a journal article for which an Aggregation was minted.

[Relationships to other Resources and Types (pertaining to the Aggregation) ]
Feed Category

/feed/category/@term

One Category MUST be provided with a value for the term attribute of "http://www.openarchives.org/ore/terms/Aggregation"; see also Feed Category Scheme.

Other Categories MAY be provided to express a type of the Aggregation. An example is using a Category to type the Aggregation as a journal article.

The triple:

URI-A rdf:type ore:Aggregation

[Relationships to other Resources and Types (pertaining to the Aggregation) ]

Feed Category Scheme

/feed/category/@scheme

One Category MUST be provided with a value for the scheme attribute of"http://www.openarchives.org/ore/terms/". See also Feed Category.

It is RECOMMENDED to provide a value for the scheme attribute.

[Relationships to other Resources and Types (pertaining to the Aggregation) ]
Feed "related" Link

/feed/link[@rel="related"]/@href

[RFC3987] [RFC3986]

It is RECOMMENDED to convey other identifiers by which the Aggregation described by the Resource Map is known. Examples are info:doi/... , http://dx.doi.org/... , etc.

Object of the triple:

URI-A ore:similarTo URI-object

[Relationships between the Aggregation and Similar Resources]

Feed "alternate" Link

/feed/link[@rel="alternate"]/@href

[RFC3987] [RFC3986]

If a Resource Map exists that describes the Aggregation using serialization format other than Atom, it is RECOMMENDED to convey the URI (URI-R) of this other Resource Map. An example is a link to a Resource Map expressed in RDF/XML.

Object of the triple:

URI-A ore:isDescribedBy URI-R-other

[Relationship between a Resource Map and an Aggregation]

Feed "license" Link

/feed/link[@rel="license"]/@href

[RFC3987] [RFC3986][RFC4946]

This link element is used to provide the URI of a rights description that pertains to the Aggregation. It is RECOMMENDED that the rights description is machine-readable. An example is the URI of a Creative Common licsnese that dereferences to an RDF/XML rights description.

[ Relationships to other Resources and Types (pertaining to the Aggregation) ]
Feed Icon

/feed/icon

[Relationships to other Resources and Types (pertaining to the Aggregation) ]
Feed Logo

/feed/logo

[Relationships to other Resources and Types (pertaining to the Aggregation) ]
Feed Contributor /feed/contributor [Relationships to other Resources and Types (pertaining to the Aggregation) ]
Feed Description /feed/subtitle [Relationships to other Resources and Types (pertaining to the Aggregation) ]
Feed Extension Elements /atom:feed/rdf:Description[@rdf:about="URI-A"]

 

Types and properties pertaining to the Aggregation that can not be expressed using elements of the Atom namespace SHOULD be provided in an rdf:Description child element of atom:feed that has the URI of the Aggregation (URI-A) as the value of its rdf:about attribute.

[Relationships to other Resources and Types (pertaining to the Aggregation) ]
Feed Last Update Date-time

/feed/updated

[RFC3339]

Format SHOULD be "YYYY-MM-DDThh:mm:ssZ"

Object of the triple:

URI-R dcterms:modified "datetime"

[Metadata about the Atom-based Resource Map]

Feed Generator

/feed/generator/@uri

[RFC3987] [RFC3986]

Object of the triple:

URI-R dc:creator URI-author

[Metadata about the Atom-based Resource Map]

Feed Generator

/feed/generator/

 

Object of the triple:

URI-R dc:creator "author"

[Metadata about the Atom-based Resource Map]

Feed Copyright

/feed/rights

It is RECOMMENDED to convey a human readable rights statement pertaining for the Atom-based Resource Map.

Object of the triple:

URI-R dc:rights "rights"

[Metadata about the Atom-based Resource Map]

Feed Extension Elements /feed/rdf:Description[@rdf:about="URI-R"]

 

Types and properties pertaining to the Atom-based Resource Map that can not be expressed using elements of the Atom namespace SHOULD be provided in an rdf:Description child element of atom:feed that has the URI of the Resource Map (URI-R) as the value of its rdf:about attribute.

[Relationships to other Resources and Types (pertaining to the Atom-based Resource Map) ]

Feed Extension Elements /feed/rdf:Description[@rdf:about="URI-other"]

 

Types and properties pertaining to the a resource that has a direct or indirect relationship to the Aggregation or the Atom-based Resource Map SHOULD be provided in an rdf:Description child element of atom:feed that has the URI of the resource as the value of its rdf:about attribute.

[Relationships to other Resources and Types (pertaining to the resources related to the Aggregation or Resource Map) ]

Table 3 shows the elements of an Atom Entry used when expressing a Resource Map as an Atom Feed. Elements that are mandatory are highlighted.

Table 3: The elements of an Atom entry used when expressing an ORE Resource Map as an Atom feed
Atom Entry Item Atom representation ORE Abstract Model
Entry ID

/feed/entry/id

[RFC3987] [RFC3986]

The nature of the URIs used for the identification of Proxy resources is the subject of ongoing discussions.

URI-P

[URI of the Proxy for an Aggregated Resource]

Entry "alternate" Link

/feed/entry/link[@rel="alternate"]/@href

[RFC3987] [RFC3986]

Object of the triple:

URI-A ore:aggregates URI-AR

[URI-AR of the Aggregated Resource]

Entry Title /feed/entry/title [Relationships to other Resources and Types (pertaining to the Aggregated Resource) ]
Entry Category

/feed/entry/category/@term

Categories MAY be provided to express a type of the Aggregated Resource. An example is using a Category to type the Aggregated Resource as an image.

[Relationships to other Resources and Types (pertaining to the Aggregated Resource) ]
Entry Category Scheme

/feed/entry/category/@scheme

It is RECOMMENDED to provide a value for the scheme attribute.

[Relationships to other Resources and Types (pertaining to the Aggregated Resource) ]
Entry Contributor /feed/entry/contributor [Relationships to other Resources and Types (pertaining to the Aggregated Resource) ]
Entry Description /feed/entry/summary [Relationships to other Resources and Types (pertaining to the Aggregated Resource) ]
Entry Source

/feed/entry/source

No correspondence in the ORE Model
Entry "related" Link

/feed/entry/link[@rel="related"]/@href

[RFC3987] [RFC3986]

It is RECOMMENDED to use this link element to support discovery of other Aggregations. The link points to another Aggregation in which the Aggregated Resource is also aggregated.

Object of the triple:

URI-AR ore:isAggregatedBy URI-A-other

[Asserting that an Aggregated Resource is a Constituent of another Aggregation]

Entry Extension Elements

/feed/entry/rdf:Description[@rdf:about="URI-AR"]

Types and properties pertaining to the Aggregated Resource that can not be expressed using elements of the Atom namespace SHOULD be provided in an rdf:Description child element of atom:entry that has the URI of the Aggregated Resource (URI-AR) as the value of its rdf:about attribute.

[Relationships to other Resources and Types (pertaining to the Aggregated Resource) ]
Entry Last Update Date-time

/feed/entry/updated

[RFC3339]

Format SHOULD be "YYYY-MM-DDThh:mm:ssZ"

[Using Proxies as the Target of other Relationships]

Entry Publication Date-Time

/feed/entry/published

[RFC3339]

Format SHOULD be "YYYY-MM-DDThh:mm:ssZ"

[Using Proxies as the Target of other Relationships]
Entry "via" Link

/feed/entry/link[@rel="via"]/@href

[RFC3987] [RFC3986]

It is RECOMMENDED to use this link to express the advanced notion of lineage of an Aggregated Resource in another Aggregation as defined in the ORE Model. This ore:lineage relationship is expressed among the respective Proxies for the Aggregated Resource in both Aggregations.

The object of the triple:

URI-P ore:lineage URI-P-other

whereby:

URI-P ore:proxyFor URI-AR

URI-P ore:proxyIn URI-A

URI-P-other ore:proxyFor URI-AR

URI-P-other ore:proxyIn URI-A-other

[Expressing the Lineage of an Aggregated Resource]

Entry Document "self" Link

/feed/entry/link[@rel="self"]\
[@type="application/atom+xml"]/@href

[RFC3987] [RFC3986]

The URI from which a Proxy Document is retrievable that describes a sub-graph of the Resource Map RDF Graph that pertains specifically to the Aggregated Resource

[Proxy Document]

Entry Extension Elements

/feed/entry/rdf:Description[@rdf:about="URI-P"]

Types and properties pertaining to the Proxy for the Aggregated Resource that can not be expressed using elements of the Atom namespace SHOULD be provided in an rdf:Description child element of atom:entry that has the URI of the Proxy (URI-P) as the value of its rdf:about attribute.

[Using Proxies as the Target of other Relationships]

Entry Extension Elements

/feed/entry/rdf:Description[@rdf:about="URI-other"]

Types and properties pertaining to a resource that has a direct or indirect relationship to the Aggregated Resource or to its Proxy that can not be expressed using elements of the Atom namespace SHOULD be provided in an rdf:Description child element of atom:entry that has the URI of the resource as the value of its rdf:about attribute.

[Using Proxies as the Target of other Relationships]

[Relationships to other Resources and Types (pertaining to the Aggregated Resource) ]

 

 

3. Use of Atom Constructs in the Resource Map Profile of Atom

This Section specifies the use of common Atom Constructs in the Resource Map Profile of Atom. When, in the remainder of this document, an Atom element is identified as being a particular kind of construct, it inherits the corresponding requirements from that construct's definition in this Section 3.

3.1 Text Constructs

In the Resource Map Profile of Atom:

3.2 Person Constructs

In the Resource Map Profile of Atom:

3.3 Date Constructs

In the Resource Map Profile of Atom:

4. Use of Atom Elements in the Resource Map Profile of Atom

4.1 Container Elements

4.1.1 The "atom:feed" Element

In the Resource Map Profile of Atom:

4.1.2 The "atom:entry" Element

In the Resource Map Profile of Atom:

4.1.3 The "atom:content" Element

In the Resource Map Profile of Atom:

4.2 Metadata Elements

4.2.1 The "atom:author" Element

In the Resource Map Profile of Atom:

In the D-Lib Magazine example, Michael Nelson, Joan Smith, and Frank McCown are authors of the journal article for which the Aggregation is created. In order to convey meaningful authorship information for the Aggregation, they are conveyed as authors of the Aggregation.

<?xml version="1.0" encoding="UTF-8" ?>
<atom:feed  xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:ore="http://www.openarchives.org/ore/terms/"> 
    <!--  -->
    <!-- About the Aggregation --> 
    <!--  -->
    <!-- ... -->
    <atom:author>
        <atom:name>Michael Nelson</atom:name>
        <atom:uri>http://www.cs.odu.edu/~mln/</atom:uri>
    </atom:author>
    <atom:author>
        <atom:name>Joan Smith</atom:name>
        <atom:uri>http://www.joanasmith.com/</atom:uri>
    </atom:author>
    <atom:author>
        <atom:name>Frank McCown</atom:name>
        <atom:uri>http://www.cs.odu.edu/~fmccown/</atom:uri>
    </atom:author>
 <!-- ... -->
</atom:feed>

4.2.2 The "atom:category" Element

In the Resource Map Profile of Atom:

<?xml version="1.0" encoding="UTF-8" ?>
<atom:feed  xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:ore="http://www.openarchives.org/ore/terms/"> 
    <!--  -->
    <!-- About the Aggregation --> 
    <!--  -->
    <!-- ... -->
    <atom:category  scheme="http://www.openarchives.org/ore/terms/" 
        term="http://www.openarchives.org/ore/terms/Aggregation" 
        label="Aggregation" />
    <atom:category  scheme="http://purl.org/eprint/type/" 
        term="http://purl.org/eprint/type/JournalArticle" 
        label="Journal Article" />
 <!-- ... -->
</atom:feed>

4.2.3 The "atom:contributor" Element

In the Resource Map Profile of Atom:

4.2.4 The "atom:generator" Element

In the Resource Map Profile of Atom:

In the D-Lib Magazine example, D-Lib Magazine itself is the creator of the Resource Map. This information is conveyed in the atom:generator element.

<?xml version="1.0" encoding="UTF-8" ?>
<atom:feed  xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:ore="http://www.openarchives.org/ore/terms/"> 
    <!--  -->
    <!-- About the Resource Map --> 
    <!--  -->
    <atom:generator uri="http://www.dlib.org">D-Lib Magazine</atom:generator>
 <!-- ... -->
</atom:feed>

4.2.5 The "atom:icon" Element

In the Resource Map Profile of Atom:

<?xml version="1.0" encoding="UTF-8" ?>
<atom:feed  xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:ore="http://www.openarchives.org/ore/terms/"> 
    <!--  -->
    <!-- About the Aggregation --> 
    <!--  -->
    <atom:icon>http://www.openarchives.org/ore/logos/ore_icon.png</atom:icon>
 <!-- ... -->
</atom:feed>

4.2.6 The "atom:id" Element

In the Resource Map Profile of Atom:

In the D-Lib Magazine example, <http://www.dlib.org/dlib/february06/smith/aggregation> is the URI of the Aggregation (URI-A); it is conveyed as the content of the Feed-level atom:id element. Note that the URI of the Atom-based Resource Map (URI-R) that describes this Aggregation is provided in a Feed-level atom:link element that has a value of "self" for its rel attribute: <http://www.dlib.org/dlib/february06/smith/aggregation.xml>. The example also shows an Aggregated Resource of this Aggregation. Its URI (URI-AR) is provided in an Entry-level atom:link element that has a value of "alternate" for its rel attribute: <http://www.dlib.org/dlib/february06/smith/02smith.html>. The URI provided as the content of the Entry-level atom:id element <urn:uuid:abcefc20-4c4d-11dc-a9c2-0002a5d585c1> uniquely identifies the Atom Entry, and is the URI of the Proxy (URI-P) for the Aggregated Resource.

<?xml version="1.0" encoding="UTF-8" ?>
<atom:feed  xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:ore="http://www.openarchives.org/ore/terms/"> 
    <!--  -->
    <!-- About the Aggregation --> 
    <!--  -->
    <atom:id>http://www.dlib.org/dlib/february06/smith/aggregation</atom:id>
    <!--  -->
    <!-- About the Resource Map  --> 
    <!--  -->
    <atom:link rel="self" 
        type="application/atom+xml" 
        href="http://www.dlib.org/dlib/february06/smith/aggregation.xml" />
    <!--  -->
    <!-- Aggregated Resource --> 
    <!--  -->
    <atom:entry>
        <atom:id>urn:uuid:abcefc20-4c4d-11dc-a9c2-0002a5d585c1</atom:id>
        <atom:link  rel="alternate" type="text/html" 
            href="http://www.dlib.org/dlib/february06/smith/02smith.html" />
        <!-- ... -->
    </atom:entry>
</atom:feed>

4.2.7 The "atom:link" Element

In the Resource Map Profile of Atom:

In the D-Lib Magazine example, the URI of the Atom-based Resource Map (URI-R) that describes the Aggregation is provided in a Feed-level atom:link element that has a value of "self" for its rel attribute: <http://www.dlib.org/dlib/february06/smith/aggregation.xml>. Note that the URI of the Aggregation (URI-A) itself is conveyed as the content of the Feed-level atom:id element: <http://www.dlib.org/dlib/february06/smith/aggregation>. Other URIs (e.g. a DOI) that are associated with the Aggregation are provided using an atom:link element with a rel attribute value of "related" and a href attribute value set to another URI associated with the Aggregation: <info:doi/10.1045/february2006-smith>. A pointer to a Resource Map that describes the Aggregation in a format other than Atom is provided in a Feed-level atom:link element that has a value of "alternate" for its rel attribute: <http://www.dlib.org/dlib/february06/smith/aggregation.rdf> is the URI of a Resasource Map (URI-R) that describes the Aggregation in an RDF/XML serialization. An additional Feed-level atom:link element conveys the rights pertaining to the Aggregation: the URI <http://creativecommons.org/licenses/by-nc/2.5/rdf> references a machine-readable rights description that pertains to the Aggregation. This URI is provided as the value of the href attribute of a Feed-level atom:link element that has a value of "license" for its rel attribute.

The atom:entry shown in the example conveys the Aggregated Resource with URI <http://www.dlib.org/dlib/february06/smith/MLN_Google.png>. This URI is provided as the value of the href attribute of the Entry-level atom:link element that has a value of "alternate" for its rel attribute. The content of the atom:id element for this atom:entry is the URI of the Proxy for the Aggregated Resource: <urn:uuid:abcefc20-4c4d-11dc-a9c2-0002a5d585c4>. This URI provides a means to reference the Aggregated Resource in the context of this Aggregation. This Aggregated Resource is also aggregated in another Aggregation. This URI of that other Aggregation is provided as the value of the href attribute of the Entry-level atom:link element that has a value of "related" for its rel attribute: <http://www.example.org/aggregation/45887>. An additional Entry-level atom:link element that has a value of "via" for its rel attribute expresses the lineage of the Aggregated Resource in another Aggregation. The value of the href attribute of this atom:link is the URI of the Proxy for the Aggregated Resource in another Aggregation: <tag:example.org,2008:aggregation:45887:entry8>.

<?xml version="1.0" encoding="UTF-8" ?>
<atom:feed  xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:ore="http://www.openarchives.org/ore/terms/"
    xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> 
    <!--  -->
    <!-- About the Aggregation --> 
    <!--  -->
    <atom:id>http://www.dlib.org/dlib/february06/smith/aggregation</atom:id>
    <atom:link href="info:doi/10.1045/february2006-smith" 
        rel="related"/>
    <atom:link href="http://creativecommons.org/licenses/by-nc/2.5/rdf" 
        rel="license" 
        type="application/rdf+xml" />
    <!-- ... -->
    <!--  -->
    <!-- About the Resource Map --> 
    <!--  -->
    <atom:link rel="self" 
        type="application/atom+xml" 
        href="http://www.dlib.org/dlib/february06/smith/aggregation.xml" />
    <atom:link rel="alternate" 
        type="application/rdf+xml" 
        href="http://www.dlib.org/dlib/february06/smith/aggregation.rdf" />
    <!-- ... -->
    <!--  -->
    <!-- Aggregated Resources --> 
    <!--  -->
    <!-- ... -->
    <atom:entry>
        <atom:id>urn:uuid:abcefc20-4c4d-11dc-a9c2-0002a5d585c4</atom:id>
        <atom:title>MLN_Google.png</atom:title>
        <atom:updated>2007-09-22T07:11:09Z</atom:updated>
        <atom:category  scheme="http://purl.org/dc/dcmitype/" 
            term="http://purl.org/dc/dcmitype/Image" 
            label="Image" />
        <atom:link  rel="alternate" 
            type="image/png" 
            href="http://www.dlib.org/dlib/february06/smith/MLN_Google.png" />
        <atom:link  rel="related" 
            href="http://www.example.org/aggregation/45887" />
        <atom:link  rel="via" 
            href="tag:example.org,2008:aggregation:45887:entry8" />
        <rdf:Description rdf:about="http://www.dlib.org/dlib/february06/smith/MLN_Google.png">
            <dc:format xmlns:dc="http://purl.org/dc/elements/1.1/" rdf:resource="info:pronom/fmt/13"/>
        </rdf:Description>
    </atom:entry>
    <!-- ... -->
</atom:feed>

4.2.8 The "atom:logo" Element

In the Resource Map Profile of Atom:

<?xml version="1.0" encoding="UTF-8" ?>
<atom:feed  xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:ore="http://www.openarchives.org/ore/terms/"> 
    <!--  -->
    <!-- About the Aggregation --> 
    <!--  -->
    <atom:logo>http://www.openarchives.org/ore/logos/ore_logo.png</atom:logo>
 <!-- ... -->
</atom:feed>

4.2.9 The "atom:published" Element

In the Resource Map Profile of Atom:

In the D-Lib Magazine example, the shown entry was first published on 2007-08-17T21:12:44Z as a means to aggregate the resource <http://www.dlib.org/dlib/february06/smith/pg1-13.html>. Note that this resource existed a long time before the entry was first published, as it is part of the D-Lib Magazine paper that was published in February 2006.

<?xml version="1.0" encoding="UTF-8" ?>
<atom:feed  xmlns:atom="http://www.w3.org/2005/Atom"
    xmlns:ore="http://www.openarchives.org/ore/terms/"> 
 <!-- ... -->
    <atom:entry>
        <!-- ... -->
        <atom:published>2007-08-17T21:12:44Z</atom:published>
        <atom:link  rel="alternate" 
            type="text/html" 
            href="http://www.dlib.org/dlib/february06/smith/pg1-13.html" />
    </atom:entry>
    <!-- ... -->
</atom:feed>

4.2.10 The "atom:rights" Element

In the Resource Map Profile of Atom: