Implementation Guidelines for the Open Archives Initiative Protocol for Metadata Harvesting

- XML schema to hold branding information for collections

Protocol Version 2.0 of 2002-06-14
Document Version 2002/06/09T16:43:00Z
http://www.openarchives.org/OAI/2.0/guidelines-branding.htm

Editors

The OAI Executive:
Carl Lagoze <lagoze@cs.cornell.edu> -- Cornell University - Computer Science
Herbert Van de Sompel <herbertv@lanl.gov> -- Los Alamos National Laboratory - Research Library

From the OAI Technical Committee:
Michael Nelson <m.l.nelson@larc.nasa.gov> -- NASA - Langley Research Center
Simeon Warner <simeon@cs.cornell.edu> -- Cornell University - Computer Science

This document is one part of the Implementation Guidelines that accompany the Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH).

XML schema to hold branding information for collections

The branding container may be used to include information relating to presentation of harvested data that will identify it as originating from a particular repository, collection or organization -- providing a `brand' identity. This container may be used within a description block in the Identify response, or within setDescription blocks in the ListSets response. The inclusion of this information does not guarantee that any service provider will choose to use it.

The branding information is split into two parts: an optional collectionIcon container, and optional and repeatable metadataRendering elements.

The `collectionIcon` container

This collectionIcon container is used to provide the location of an icon that may be associated with the collection, and a link to information about that collection. The elements of the collectionIcon container are similar to those of the image container in the RSS specification (though the width and height elements were dropped in the 1.0 RSS specification). The elements are:

url - the URL of the icon image. The icon should be in PNG or GIF format.
link - the URL of a link that may be associated with the icon.
title - a title for the icon that may be used in an HTML ALT tag or as a text alternative to the icon.
width - the width in pixels of the icon at url.
height - the height in pixels of the icon at url.

It is recommended that the icon be 88 pixels wide by 31 pixels as is standard practice within the RSS community.

The `metadataRendering` element

Each metadataRendering element must have a metadataNamespace attribute and a mimeType attribute. The content must be the URL of a style sheet document that may be used to render metadata in the format specified by the metadataNamespace.

The mimeType attribute must be the MIME type of the style sheet at the specified URL. Possible MIME types include: text/dsssl, text/css and text/xsl. Harvesters should ignore style sheets for which they do no recognize the MIME type. The metadataNamespace attribute must be the namespace URI of the XML elements that can be rendered using the style sheet. The style sheet must be able to render the metadata part of a GetRecord response for the specific metadata format.

<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://www.openarchives.org/OAI/2.0/branding/"
  xmlns="http://www.w3.org/2001/XMLSchema" 
  xmlns:branding="http://www.openarchives.org/OAI/2.0/branding/" 
  elementFormDefault="qualified" attributeFormDefault="unqualified">

  <annotation>
    <documentation>
      Schema for collection branding within OAI
      [Simeon Warner - $Date: 2002/05/13 18:48:52 $]
      Validated at http://www.w3.org/2001/03/webdata/xsv on 13May2002.
    </documentation>
  </annotation>

  <element name="branding">
    <complexType>
      <sequence>
        <element name="collectionIcon" minOccurs="0" maxOccurs="1" 
                 type="branding:collectionIconType"/>
        <element name="metadataRendering" minOccurs="0" maxOccurs="unbounded" 
                 type="branding:metadataRenderingType"/>
      </sequence>
    </complexType>
  </element>

  <complexType name="collectionIconType">
    <sequence>
      <element name="url" minOccurs="1" maxOccurs="1" type="anyURI"/>
      <element name="link" minOccurs="0" maxOccurs="1" type="anyURI"/>
      <element name="title" minOccurs="0" maxOccurs="1" type="string"/>
      <element name="width" minOccurs="0" maxOccurs="1" type="integer"/>
      <element name="height" minOccurs="0" maxOccurs="1" type="integer"/>
    </sequence>
  </complexType>

  <complexType name="metadataRenderingType">
    <simpleContent>
      <extension base="anyURI">
        <attribute name="metadataNamespace" type="anyURI" 
                   use="required"/>
        <attribute name="mimeType" type="branding:mimeType" 
                   use="required"/>
      </extension>
    </simpleContent>
  </complexType>

  <!-- Style sheet mime type.                  -->
  <!-- Left open-ended, current types include: -->
  <!--   text/dsssl, text/css, text/xsl        --> 
  <simpleType name="mimeType">
    <restriction base="string">
      <pattern value="[a-z]+/[a-z]+"/>
    </restriction>
  </simpleType>

</schema>

This Schema is available at http://www.openarchives.org/OAI/2.0/branding.xsd

Examples

The following example shows the a branding that may be returned in either a description block in the response to an Identify request, or in a setDescription block in the response to a listMetadataFormats request.

<branding xmlns="http://www.openarchives.org/OAI/2.0/branding/"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/branding/
                      http://www.openarchives.org/OAI/2.0/branding.xsd">
  <collectionIcon>
    <url>http://my.site/icon.png</url>
    <link>http://my.site/homepage.html</link>
    <title>MySite(tm)</title>
    <width>88</width>
    <height>31</height>
  </collectionIcon>
  <metadataRendering 
    metadataNamespace="http://www.openarchives.org/OAI/2.0/oai_dc/" 
    mimeType="text/xsl">http://some.where/DCrender.xsl</metadataRendering>
  <metadataRendering
    metadataNamespace="http://another.place/MARC" 
    mimeType="text/css">http://another.place/MARCrender.css</metadataRendering>
</branding>

Acknowledgements

Support for the development of the OAI-PMH and for other Open Archives Initiative activities comes from the Digital Library Federation, the Coalition for Networked Information, and from the National Science Foundation through Grant No. IIS-9817416. Individuals who have played a significant role in the development of OAI-PMH version 2.0 are acknowledged in the protocol document.

Document History

2002-06-14: Release of this document, combined with the release of OAI-PMH version 2.0.