Specification

From cbwiki.net
Revision as of 08:12, 4 October 2007 by Admin (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
Please note that this page relates to a deprecated version of RSS-CB. Please find links to the current version via the RSS-CB home page

Contents

RSS-CB 1.0

Abstract

RSS-CB 1.0 is an extensible metadata description and syndication format, tailored to the needs of central banks and related organizations. RSS-CB conforms to the RSS 1.0 specification, and therefore to the RDF and XML specifications as well. It also uses elements from the Dublin Core and qualified Dublin Core specifications.

Authors/Contributors

Paul Asman, Federal Reserve Bank of New York
Christine Sommo, Federal Reserve Bank of New York
Dan Chall, Federal Reserve Bank of New York
Elena Atayeva, Federal Reserve Bank of New York
Mike Eltsufin, Federal Reserve Bank of New York
San Cannon, Federal Reserve Board of Governors
Butch Easton, Federal Reserve Board of Governors
Julie Jackson, Federal Reserve Board of Governors
Noé Palmerin, Banco de México
Timo Laurmaa, Bank for International Settlements
Brent Eades, Bank of Canada
Suzanne LeBlanc, Bank of Canada

Version

Latest Version: http://www.bis.org/rss-cb/1.0/ : this version

Status

Release

Rights

This specification is derivative upon the RSS 1.0 specification. That specification includes the following notice, which we quote in compliance with it:

"Copyright © 2000 by the Authors.

"Permission to use, copy, modify and distribute the RDF Site Summary 1.0 Specification and its accompanying documentation for any purpose and without fee is hereby granted in perpetuity, provided that the above copyright notice and this paragraph appear in all copies. The copyright holders make no representation about the suitability of the specification for any purpose. It is provided "as is" without expressed or implied warranty."

Syntax

Following is a description of the elements and attributes that constitute a valid RSS-CB document:

XML declaration

An RSS-CB document begins with an XML declaration.

Syntax:
<?xml version="1.0"?>
Requirement: Required

<rdf:RDF>

The RDF element is the root element, and immediately follows the XML declaration. This element includes the declaration of required and optional custom namespaces. Required namespaces are RDF, RSS, Dublin Core elements, and Dublin Core terms. Both individual institutions and groups of institutions may promote custom namespaces.

Syntax:
<rdf:RDF
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns="http://purl.org/rss/1.0/"
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:dcterms="http://purl.org/dc/terms/"
xmlns:cb="http://www.bis.org/rss-cb/1.0/"
xmlns:onecb="http://www.particularcentralbank.gov/rss/">
Requirement: Required


The RDF element in RSS 1.0 has four child elements. In RSS-CB, two are required, one is optional, and one is prohibited. The permitted child elements must appear in the order shown below.

<channel> Required; one occurrence only
<image> Optional; at most one occurrence
<item> Required; at least one occurrence
<textinput> Prohibited

Custom namespaces

RSS-CB 1.0 is extensible through custom XML namespaces. This permits institutions to employ elements and attributes that are specific to their own dissemination needs or to dissemination needs held in common by a group of institutions.

<channel>

In RSS 1.0, the <channel> element has six child elements. In RSS-CB, four are required, one is optional, and one is prohibited. The permitted child elements must appear in the order shown below. There is also one required attribute, about.

<title> Required; one occurrence only
<link> Required; one occurrence only
<description> Required; one occurrence only
<image> Optional; at most one occurrence
<items> Required; one occurrence only
<textinput> Prohibited

rdf:about

The value of rdf:about is the URL of the RSS feed. It is unique in respect to any other rdf:about attributes in the document.

Syntax:
<channel rdf:about="http://yoursite.rss">
Requirement: Required

<title>

The value of <title> is free text.

Syntax:
<title>The title of your channel</title>
Requirement: Required

<link>

The value of <link> is a URL. If the website has a landing page corresponding to the channel, the value is the URL of that landing page. In the absence of a landing page, the value is the URL of the next landing page higher in the site hierarchy. The home page is the highest landing page for a site. More information: User Guide.

Syntax:
<link>http://yoursite/RSSpage/</link>
Requirement: Required

<description>

The value of <description> is free text.

Syntax:
<description>Press releases issued by Your Institution.</description>
Requirement: Required

<image>

The <image> child element, if present, contains an rdf:resource attribute holding a URI that matches the URI held by the rdf:about attribute of the <image> element one level higher.

Syntax:
<image rdf:resource="http://yoursite/your_image.gif" />
Requirement: Optional, but required if higher-level image element is present.

<items>

The <items> element contains a sequential list of URIs, which must match those of the <item> elements contained in the RSS-CB file. The match is between rdf:about attribute of an <item> and the rdf:resource attribute in the list of <items>.

Syntax:
  <items>
    <rdf:Seq>
      <rdf:li rdf:resource="http://yoursite/press_release1.html" />
      <rdf:li rdf:resource="http://yoursite/press_release2.html" />
    </rdf:Seq>
  </items>
Requirement: Required

<dcterms:license>

The value of <dcterms:license> is normally a URL. If the website has a landing page that contains the usage license, the value is the URL of that landing page. In the absence of a such a landing page, the text of the license may appear. More information: User Guide.

Syntax:
<link>http://yoursite/licensepage/</link>
Requirement: Recommended

<image>

The <image> element has three child elements, all required, and one required attribute, about. The <image> element itself is optional, but required if an <image> child element of <channel> is present. The child elements must appear in the order shown below.

rdf:about

The value of rdf:about is the URL of the image, and matches the value of rdf:resource of the image child element of <channel>. It is unique in respect to any other rdf:about attributes in the document.

Syntax:
<image rdf:about="http://yoursite/your_image.gif">
Requirement: Required

<title>

The value of <title> is free text. It corresponds to the contents of an HTML alt attribute.

Syntax:
<title>an alt tag</title>
Requirement: Required

<url>

The value of <url> corresponds to the contents of an HTML src attribute.

Syntax:
<url>http://yoursite/your_image.gif</url>
Requirement: Required

<link>

The value of <link> matches the value of the <link> child element of <channel>.

Syntax:
<link>http://yoursite/RSSpage/</link>
Requirement: Required

<item>

The <item> element has four required child elements and one required attribute, about. There are a number of other child elements here specified that are either recommended, recommended for some application types, or optional. The child elements must appear in the order shown below, with any additional Dublin Core or custom elements following them.

rdf:about

The value of rdf:about matches the value of rdf:resource of a list item in the <items> child element of <channel>. It is unique in respect to any other rdf:about attributes in the document.

Syntax:
<item rdf:about="http://yoursite/press_release1.html">
Requirement: Required

<title>

The value of <title> is free text.

Syntax:
<title>title of press release </title>
Requirement: Required

<link>

The value of <link> is the URL of the resource that is the subject of the item. It matches the URL of the about attribute when there is only one item for a given resource.

Syntax:
<link>http://yoursite/press_release1.html</link>
Requirement: Required

<description>

The value of <description> is free text.

Syntax:
<description>the description of the resource</description>
Requirement: Required

<dc:language>

The value of <dc:language> is a language code from ISO 3066.

Syntax:
<dc:language>en</dc:language>
Requirement: Recommended

<dc:date>

The value of <dc:date> is a valid date format. For date formatting information see W3 specs.

Syntax:
<dc:date>2006-12-19T19:20+01:00</dc:date>
Requirement: Required

<dcterms:audience>

The value of <dcterms:audience> is free text.

Syntax:
<dcterms:audience>Financial supervisory body managers</dcterms:audience>
Requirement: Optional. Recommended for some application types (events and speeches)

<cb:application>

The value of <cb:application> is text to be selected from the set event, news, paper, speech, statistics.

Syntax:
<cb:application>speech</cb:application>
Requirement: Optional. Required when item belongs to one of the defined RSS-CB application types.
Note:

<cb:simpleTitle>

The value of <cb:simpleTitle> is free text.

Syntax:
<cb:simpleTitle>"clean" version of the title, without any publisher-specific prefixes or suffixes</cb:simpleTitle>
Requirement: Optional. Recommended for application types Event, Speech, News, and Research Paper.
Note: More structure may be added to the specification to make this Required when the item belongs to one of the defined RSS-CB application types Event, Speech, News, or Research Paper.

<cb:occurrenceDate>

The value of <cb:occurrenceDate> is a valid date format. For date formatting information see W3 specs

Syntax:
<cb:occurrenceDate>2006-12-19</cb:occurrenceDate>
Requirement: Optional. Recommended for application types Event, Speech, News, and Research Paper.
Note: More structure may be added to the specification to make this Required when the item belongs to one of the defined RSS-CB application types Event, Speech, or News.

<cb:keyword>

The value of <cb:keyword> is free text.

Syntax:
<cb:keyword>financial stability</cb:keyword>
Requirement: Optional. Recommended for application type Research Paper.

<cb:resource>

The value of <cb:resource> consists of the elements cb:title, cb:link and cb:description, each of which consist of free text.

Syntax:
  <cb:resource>
    <cb:title>Powerpoint presentation</cb:title>
    <cb:link>http://yoursite.org/speeches/20061219a.ppt</cb:link>
    <cb:description>What the speech and the PPT file is about</cb:description>
  </cb:resource>
Requirement: Optional

<cb:person>

The value of <cb:person> consists of the attribute type, and then elements cb:givenName, cb:surname, cb:personalTitle, cb:nameAsWritten, which are all free text, and the element cb:role, which has the child elements cb:jobTitle (required) and cb:body (optional).

Syntax:
  <cb:person type="Author">
    <cb:givenName>Toshiro</cb:givenName>
    <cb:surname>Muto</cb:surname>
    <cb:personalTitle>Mr</cb:personalTitle>
    <cb:nameAsWritten>Toshiro Muto</cb:nameAsWritten>
    <cb:role>
      <cb:jobTitle>Deputy Governor</cb:jobTitle>
      <cb:body>Bank of Japan</cb:body>
    </cb:role>
  </cb:person>
Requirement: Optional. Recommended for application types Speech and Research Paper.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Speech.

<cb:venue>

The value of <cb:venue> is free text.

Syntax:
<cb:venue>Mariton Hotel, La Paz, Bolivia</cb:venue>
Requirement: Optional. Recommended for application types Event and Speech.

<cb:eventDateEnd>

The value of <cb:venue> is a valid date format. For date formatting information see W3 specs.

Syntax:
<cb:eventDateEnd>2007-03-13</cb:eventDateEnd>
Requirement: Optional

<cb:byline>

The value of <cb:byline> is free text.

Syntax:
<cb:byline>Gonzalez, Arturo and di Taranto, Mario</cb:byline>
Requirement: Optional. Recommended for application type Research Paper.

<cb:publicationDate>

The value of <cb:publicationDate> is free text.

Syntax:
<cb:publicationDate>Spring, 2007</cb:publicationDate>
Requirement: Optional. Recommended for application type Research Paper.

<cb:publication>

The value of <cb:publication> is free text.

Syntax:
<cb:publication>Financial discussion papers</cb:publication>
Requirement: Optional. Recommended for application type Research Paper.

<cb:issue>

The value of <cb:publication> is an alpha-numeric ordinal value.

Syntax:
<cb:issue>11</cb:issue>
Requirement: Optional. Recommended for application type Research Paper.

<cb:JELCode>

Codes from a controlled vocabulary list corresponding to the official subject listing used by the Journal of Economic Literature.

Syntax:
<cb:JELCode>E11</cb:JELCode>
Requirement: Optional. Recommended for application type Research Paper.

<cb:institutionAbbrev>

The value of <cb:institutionAbbrev> is text without spaces.

Syntax:
<cb:institutionAbbrev>NYFed</cb:insitutionAbbrev>
Requirement: Optional. Recommended for application type Statistics.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics.

<cb:country>

Codes from a controlled vocabulary list from ISO 3166-1.

Syntax:
<cb:country>DZ</cb:country>
Requirement: Optional. Recommended for application type Statistics and subtype Exchange Rate.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtype Exchange Rate.

<cb:baseCurrency>

Code from the ISO 4217 currency codes. There is one optional attribute, unit_mult.

unit_mult is an exponent of 10. A unit_mult of 2, for example, indicates that the baseCurrency is stated in terms of 100 units. The default value for this attribute is 0, for stating the baseCurrency in terms of 1 unit.

Syntax:
<cb:baseCurrency>CNY</cb:baseCurrency>
Requirement: Optional. Recommended for application type Statistics and subtype Exchange Rate.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtype Exchange Rate.

<cb:targetCurrency>

Code from the ISO 4217 currency codes.

Syntax:
<cb:targetCurrency>CHF</cb:targetCurrency>
Requirement: Optional. Recommended for application type Statistics and subtype Exchange Rate.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtype Exchange Rate.

<cb:value>

This is a numeric value, with one required attribute for all statistics - decimals and three additional attributes - frequency (required for subtypes Exchange Rates, Interest Rates, and Other, unit_mult (required for subtype Transactions), and units (required for subtypes Other).

frequency may be limited to the values of a code list. See the relevant application guides for more information. decimals and unit_mult are integer values. units is a string but may be limited to the values of a code list. See the relevant application guides for more information.

Syntax:
<cb:value frequency="daily" decimals="4">1.1240</cb:value>
<cb:value unit_mult="9" decimals="3">1.781</cb:value>
<cb:value frequency="weekly" unit_mult="9" units="USD" decimals="3">241.6</cb:value>
Requirement: Optional. Recommended for application type Statistics.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics.

<cb:rateType>

The value of <cb:rateType> is free text.

Syntax:
<cb:rateType>noon buying</cb:rateType>
Requirement: Optional. Recommended for application type Statistics and subtypes Exchange Rate and Interest Rate.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtypes Exchange Rate or Interest Rate.

<cb:rateName>

The value of <cb:rateName> is text without spaces.

Syntax:
<cb:rateName>FedFunds</cb:rateName>
Requirement: Optional. Recommended for application type Statistics and subtype Interest Rate.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtype Interest Rate.

<cb:transactionName>

The value of <cb:transactionName> is text without spaces.

Syntax:
<cb:transactionName>couponPurchase</cb:transactionName>
Requirement: Optional. Recommended for application type Statistics and subtype Transactions.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtype Transactions.

<cb:transactionType>

The value of <cb:transactionType> is free text.

Syntax:
<cb:transactionType>permanent open market operations</cb:transactionType>
Requirement: Optional. Recommended for application type Statistics and subtype Transactions.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtype Transactions.


<cb:transactionTerm>

The value of <cb:transactionTerm> is text without spaces.

Syntax:
<cb:transactionTerm>1day</cb:transactionTerm>
Requirement: Optional. Recommended for application type Statistics and subtype Transactions.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtype Transactions.

<cb:topic>

The value of <cb:topic> is a code or text without spaces.

Syntax:
<cb:topic>CP</cb:topic>
Requirement: Optional. Recommended for application type Statistics and subtype Other.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtype Other.

The value of rdf:about matches the value of rdf:resource of a list item in the <items> child element of <channel>. It is unique in respect to any other rdf:about attributes in the document.

Syntax:
<item rdf:about="http://yoursite/press_release1.html">
Requirement: Required


<cb:coverage>

The value of <cb:coverage> is a code or text without spaces.

Syntax:
<cb:topic>Manufacturing</cb:topic>
Requirement: Optional. Recommended for application type Statistics and subtype Other.
Note: More structure may be added to the specification to make this Required when the item belongs to the defined RSS-CB application type Statistics and the subtype Other.

Dublin Core and/or custom namespace elements

If desired, add Dublin Core and/or custom namespace metadata after the specified fields of the channel or an item. Custom metadata not otherwise included in the RSS-CB specifications, must appear within the <cb:custom> element.

Syntax:
  <dc:creator>Your Institution, Public Affairs Department</dc:creator>
  <dc:publisher>Your Institution</dc:publisher> 
  <dc:format>application/pdf</dc:format>
  <cb:custom>  
    <yourinstitution:contact>Paul Roberts</yourinstitution:contact>
  </cb:custom>  
Requirement: Optional