RSS-CB 1.2 Specification

From cbwiki.net

(Redirected from Specification 1.2 Draft)
Jump to: navigation, search

Contents

[edit]

RSS-CB 1.2

[edit]

Abstract

RSS-CB 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.

[edit]

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
Steven Bagshaw, Bank for International Settlements
Nik Ahmad Rozaidi bin Nik Abdul Rashid, Bank Negara Malaysia

[edit]

Version

Latest Stable Version: http://www.cbwiki.net/wiki/index.php/Specification_1.1

Latest Draft Version: http://www.cbwiki.net/wiki/index.php/Specification_1.2_Draft : this version

[edit]

Status

Draft

[edit]

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."

[edit]

Syntax

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

[edit]

XML declaration

An RSS-CB document begins with an XML declaration.

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

<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. Declaration of the RSS-CB namespace is expected but not required. 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.cbwiki.net/wiki/index.php/Specification_1.2/"
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
[edit]

Custom namespaces

RSS-CB 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.

[edit]

<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
[edit]

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
[edit]

<title>

The value of <title> is free text.

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

<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
[edit]

<description>

The value of <description> is free text.

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

<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.
[edit]

<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
[edit]

<dcterms:license>

The value of <dcterms:license> is a URI. If the website has a landing page that contains the usage license, the value is the URL of that landing page.

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

More information: User Guide.

[edit]

<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.

[edit]

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
[edit]

<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
[edit]

<url>

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

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

<link>

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

Syntax: 
<link>http://yoursite/RSSpage/</link>
Requirement: Required
[edit]

<item>

The <item> element has four required child elements and one required attribute, about. It also has recommended child elements from the Dublin Core, and an optional choice of an RSS-CB defined application type. (The application types are parent elements for RSS-CB defined elements specific to those applications.) The child elements must appear in the order shown below, with any additional Dublin Core or custom elements following them.

[edit]

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
[edit]

<title>

The value of <title> is free text.

Syntax: 
<title>title of press release </title>
Requirement: Required
[edit]

<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
[edit]

<description>

The value of <description> is free text.

Syntax: 
<description>the description of the resource</description>
Requirement: Required
[edit]

<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
[edit]

<dc:language>

The value of <dc:language> is a language code from RFC 4646.

Syntax: 
<dc:language>en</dc:language>
Requirement: Recommended
[edit]

<georss:point>

The value of <georss:point> is a single latitude-longitude pair, separated by whitespace. For formatting information see GeoRSS Simple.

Syntax: 
<georss:point>45.256 -71.92</georss:point>
Requirement: Optional
[edit]

<cb:event> | <cb:news> | <cb:paper> | <cb:speech> | <cb:statistics>

A choice of RSS-CB defined application types, each of which has sub-elements, a required attribute rdf:parseType="Resource", and an element declaring the RSS-CB type.

Syntax: 
<cb:event rdf:parseType="Resource">
    <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Event"/>
    <cb:...
    <cb:...
    <cb:...
</cb:event>
Requirement: Optional. A choice is necessary to specify a defined RSS-CB application type.
[edit]

<cb:event>

The <cb:event> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type, 
<rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Event"/>
This element is followed by two required, four recommended, and seven optional child elements, which must appear in the order given below. Any additional elements, including custom elements, must follow them.
[edit]

<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: Required.
[edit]

<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: Required.
[edit]

<cb:institutionAbbrev>

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

Syntax: 
<cb:institutionAbbrev>NYFed</cb:institutionAbbrev>
Requirement: Optional.
[edit]

<cb:audience>

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

Syntax: 
<cb:audience>Economic Club of New York</cb:audience>
Requirement: Optional.
[edit]

<cb:keyword>

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

Syntax: 
<cb:keyword>financial stability</cb:keyword>
Requirement: Optional.
[edit]

<cb:resource>

The <cb:resource> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by three recommended elements, each free text, which must appear in the order shown below.

Syntax: 
<cb:resource rdf:parseType="Resource">
    <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#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
[edit]

<cb:person>

The <cb:person> element has a required attribute rdf:parseType="Resource", and an element declaring the RSS-CB type followed by four optional elements, cb:givenName, cb:surname, cb:personalTitle, cb:nameAsWritten, which are all free text and must appear in the order shown below. These elements are followed by the optional element cb:role, which has the the required attribute rdf:parseType="Resource", and an element declaring the RSS-CB type followed by two optional elements cb:jobTitle and cb:affiliation.

Syntax: 
<cb:person rdf:parseType="Resource">
  <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Person"/>
  <cb:givenName>Toshiro</cb:givenName>
  <cb:surname>Muto</cb:surname>
  <cb:personalTitle>Mr</cb:personalTitle>
  <cb:nameAsWritten>Toshiro Muto</cb:nameAsWritten>
  <cb:role rdf:parseType="Resource">
    <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Role"/>
    <cb:jobTitle>Deputy Governor</cb:jobTitle>
    <cb:affiliation>Bank of Japan</cb:affiliation>
  </cb:role>
</cb:person>
Requirement: Optional.
[edit]

<cb:venue>

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

Syntax: 
<cb:venue>Mariton Hotel</cb:venue>
Requirement: Recommended
[edit]

<cb:locationAsWritten>

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

Syntax: 
<cb:locationAsWritten>Rome, Italy</cb:locationAsWritten>
Requirement: Recommended
[edit]

<cb:locationCountry>

The value of <cb:locationCountry> is based on values of the ISO 3166 alpha-2 standards.

Syntax: 
<cb:locationCountry>IT</cb:locationCountry>
Requirement: Recommended
[edit]

<cb:locationState>

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

Syntax: 
<cb:locationState>NY</cb:locationState>
Requirement: Optional
[edit]

<cb:locationCity>

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

Syntax: 
<cb:locationCity>Rome</cb:locationCity>
Requirement: Recommended
[edit]

<cb:eventDateEnd>

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

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

<cb:news>

The <cb:news> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type, 
<rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Announcement"/>
This element is followed by two required and four optional child elements, which must appear in the order given below. Any additional elements, including custom elements, must follow them.
[edit]

<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: Required.
[edit]

<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: Required.
[edit]

<cb:institutionAbbrev>

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

Syntax: 
<cb:institutionAbbrev>NYFed</cb:institutionAbbrev>
Requirement: Optional.
[edit]

<cb:keyword>

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

Syntax: 
<cb:keyword>financial stability</cb:keyword>
Requirement: Optional.
[edit]

<cb:resource>

The <cb:resource> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by three recommended elements, each free text, which must appear in the order shown below.

Syntax: 
<cb:resource rdf:parseType="Resource">
    <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#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
[edit]

<cb:person>

The <cb:person> element has a required attribute rdf:parseType="Resource", and an element declaring the RSS-CB type followed by four optional elements, cb:givenName, cb:surname, cb:personalTitle, cb:nameAsWritten, which are all free text and must appear in the order shown below. These elements are followed by the optional element cb:role, which has the the required attribute rdf:parseType="Resource", and an element declaring the RSS-CB type followed by two optional elements cb:jobTitle and cb:affiliation.

Syntax: 
<cb:person rdf:parseType="Resource">
  <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Person"/>
  <cb:givenName>Toshiro</cb:givenName>
  <cb:surname>Muto</cb:surname>
  <cb:personalTitle>Mr</cb:personalTitle>
  <cb:nameAsWritten>Toshiro Muto</cb:nameAsWritten>
  <cb:role rdf:parseType="Resource">
    <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Role"/>
    <cb:jobTitle>Deputy Governor</cb:jobTitle>
    <cb:affiliation>Bank of Japan</cb:affiliation>
  </cb:role>
</cb:person>
Requirement: Optional.
[edit]

<cb:paper>

The <cb:paper> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type, 
<rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Paper"/>
This element is followed by two required, five recommended, and four optional child elements, which must appear in the order given below. Any additional elements, including custom elements, must follow them.
[edit]

<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: Required.
[edit]

<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: Recommended.
[edit]

<cb:institutionAbbrev>

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

Syntax: 
<cb:institutionAbbrev>NYFed</cb:institutionAbbrev>
Requirement: Optional.
[edit]

<cb:keyword>

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

Syntax: 
<cb:keyword>financial stability</cb:keyword>
Requirement: Recommended.
[edit]

<cb:resource>

The <cb:resource> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by three recommended elements, each free text, which must appear in the order shown below.

Syntax: 
<cb:resource rdf:parseType="Resource">
    <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#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
[edit]

<cb:person>

The <cb:person> element has a required attribute rdf:parseType="Resource", and an element declaring the RSS-CB type followed by four optional elements, cb:givenName, cb:surname, cb:personalTitle, cb:nameAsWritten, which are all free text and must appear in the order shown below. These elements are followed by the optional element cb:role, which has the the required attribute rdf:parseType="Resource", and an element declaring the RSS-CB type followed by two optional elements cb:jobTitle and cb:affiliation.

Syntax: 
<cb:person rdf:parseType="Resource">
  <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Person"/>
  <cb:givenName>Toshiro</cb:givenName>
  <cb:surname>Muto</cb:surname>
  <cb:personalTitle>Mr</cb:personalTitle>
  <cb:nameAsWritten>Toshiro Muto</cb:nameAsWritten>
  <cb:role rdf:parseType="Resource">
    <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Role"/>
    <cb:jobTitle>Deputy Governor</cb:jobTitle>
    <cb:affiliation>Bank of Japan</cb:affiliation>
  </cb:role>
</cb:person>
Requirement: Recommended.
[edit]

<cb:byline>

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

Syntax: 
<cb:byline>Gonzalez, Arturo and di Taranto, Mario</cb:byline>
Requirement: Recommended.
[edit]

<cb:publicationDate>

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

Syntax: 
<cb:publicationDate>Spring, 2007</cb:publicationDate>
Requirement: Recommended.
[edit]

<cb:publication>

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

Syntax: 
<cb:publication>Financial discussion papers</cb:publication>
Requirement: Recommended.
[edit]

<cb:issue>

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

Syntax: 
<cb:issue>11</cb:issue>
Requirement: Recommended.
[edit]

<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: Recommended.
[edit]

<cb:speech>

The <cb:speech> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type, 
<rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#LocatedAnnouncement"/>
This element is followed by two required, four recommended, and six optional child elements, which must appear in the order given below. Any additional elements, including custom elements, must follow them.
[edit]

<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: Required.
[edit]

<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: Required.
[edit]

<cb:institutionAbbrev>

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

Syntax: 
<cb:institutionAbbrev>NYFed</cb:institutionAbbrev>
Requirement: Optional.
[edit]

<cb:audience>

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

Syntax: 
<cb:audience>Economic Club of New York</cb:audience>
Requirement: Optional.
[edit]

<cb:keyword>

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

Syntax: 
<cb:keyword>financial stability</cb:keyword>
Requirement: Optional.


[edit]

<cb:resource>

The <cb:resource> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by three recommended elements, each free text, which must appear in the order shown below.

Syntax: 
<cb:resource rdf:parseType="Resource">
    <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#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: Required
[edit]

<cb:person>

The <cb:person> element has a required attribute rdf:parseType="Resource", and an element declaring the RSS-CB type followed by four optional elements, cb:givenName, cb:surname, cb:personalTitle, cb:nameAsWritten, which are all free text and must appear in the order shown below. These elements are followed by the optional element cb:role, which has the the required attribute rdf:parseType="Resource", and an element declaring the RSS-CB type followed by two elements, the recommended cb:jobTitle and the required cb:affiliation.

Syntax: 
<cb:person rdf:parseType="Resource">
  <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Person"/>
  <cb:givenName>Toshiro</cb:givenName>
  <cb:surname>Muto</cb:surname>
  <cb:personalTitle>Mr</cb:personalTitle>
  <cb:nameAsWritten>Toshiro Muto</cb:nameAsWritten>
  <cb:role rdf:parseType="Resource">
    <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Role"/>
    <cb:jobTitle>Deputy Governor</cb:jobTitle>
    <cb:affiliation>Bank of Japan</cb:affiliation>
  </cb:role>
</cb:person>
Requirement: Required.
[edit]

<cb:venue>

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

Syntax: 
<cb:venue>Mariton Hotel, La Paz, Bolivia</cb:venue>
Requirement: Recommended.
[edit]

<cb:locationAsWritten>

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

Syntax: 
<cb:locationAsWritten>Rome, Italy</cb:locationAsWritten>
Requirement: Recommended
[edit]

<cb:locationCountry>

The value of <cb:locationCountry> is based on values of the ISO 3166 alpha-2 standards.

Syntax: 
<cb:locationCountry>IT</cb:locationCountry>
Requirement: Recommended
[edit]

<cb:locationState>

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

Syntax: 
<cb:locationState>NY</cb:locationState>
Requirement: Optional
[edit]

<cb:locationCity>

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

Syntax: 
<cb:locationCity>Rome</cb:locationCity>
Requirement: Recommended
[edit]

<cb:statistics>

The <cb:statistics> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type, 
<rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Statistics"/>
This element is followed by three required child elements, the third of which is a choice among statistics application subtypes. The child elements must appear in the order given below, and any additional elements, including custom elements, must follow them.
[edit]

<cb:country>

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

Syntax: 
<cb:country>DZ</cb:country>
Requirement: Required.
[edit]

<cb:institutionAbbrev>

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

Syntax: 
<cb:institutionAbbrev>NYFed</cb:institutionAbbrev>
Requirement: Required.
[edit]

<cb:exchangeRate> | <cb:interestRate> | <cb:transaction> | <cb:otherStatistic>

A choice of RSS-CB defined statistics application subtypes, each of which has a required attribute, rdf:parseType="Resource" and sub-elements, the first of which is an element declaring the RSS-CB type.

Syntax: 
<cb:exchangeRate rdf:parseType="Resource">
  <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#ExchangeRate"/>
  <cb:...
  <cb:...
  <cb:...
</cb:exchangeRate>
Requirement: Required.
[edit]

<cb:exchangeRate>

The <cb:exchangeRate> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type, 
<rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#ExchangeRate"/>
This element is followed by five required child elements, which must appear in the order given below. Any additional elements, including custom elements, must follow them.
[edit]

<cb:exchangeRate><cb:observation>

The <cb:observation> child element of the <cb:exchangeRate> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by two required and two optional elements, which must appear in the order given below.

The required <cb:value> child element has a decimal value. Three examples of valid values: -1.23 / 12678967.5432 / 675

The required <cb:unit> child element has a currency code value. It must match the currency code specified in the <cb:baseCurrency> element.

The optional <cb:unit_mult> has an integer value. The value 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 is 0, for stating the baseCurrency in terms of 1 unit.

The optional <cb:decimals> child element has an integer value. The default value is 0, for stating the baseCurrency without decimals.

Syntax: 
<cb:observation rdf:parseType="Resource">
   <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Observation"/>
   <cb:value>1.1240</cb:value>
   <cb:unit>CNY</cb:unit>
   <cb:unit_mult>0</cb:unit_mult>
   <cb:decimals>4</cb:decimals>
</cb:observation>
Requirement: Required.
[edit]

<cb:exchangeRate><cb:baseCurrency>

Code from the ISO 4217 currency codes.

Syntax: 
<cb:baseCurrency>CNY</cb:baseCurrency>
Requirement: Required.
[edit]

<cb:exchangeRate><cb:targetCurrency>

Code from the ISO 4217 currency codes.

Syntax: 
<cb:targetCurrency>CHF</cb:targetCurrency>
Requirement: Required.
[edit]

<cb:exchangeRate><cb:rateType>

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

Syntax: 
<cb:rateType>noon buying</cb:rateType>
Requirement: Required.
[edit]

<cb:exchangeRate><cb:observationPeriod>

The <cb:observationPeriod> child element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by two required elements, which must appear in the order given below.

The <cb:frequency> child element has an text value that can be limited to the values of a code list. See the relevant application guides for more information.

The <cb:period> child element has a text value.

Syntax: 
<cb:observationPeriod rdf:parseType="Resource">
   <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#ObservationPeriod"/>
   <cb:frequency>quarterly</cb:frequency>
   <cb:period>Q4 2008</cb:period>
</cb:observationPeriod>
Requirement: Required.
[edit]

<cb:interestRate>

The <cb:interestRate> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type, 
<rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#InterestRate"/>
This element is followed by four required child elements, which must appear in the order given below. Any additional elements, including custom elements, must follow them.
[edit]

<cb:interestRate><cb:observation>

The <cb:observation> child element of the <cb:interestRate> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by three required and one optional elements, which must appear in the order given below.

The required <cb:value> child element has a decimal value. Three examples of valid values: -1.23 / 12678967.5432 / 675

The required <cb:unit> child element has a text value.

The optional <cb:unit_mult> has an integer value. The value 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 is 0, for stating the baseCurrency in terms of 1 unit.

The required <cb:decimals> child element has an integer value.

Syntax: 
<cb:observation rdf:parseType="Resource">
   <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Observation"/>
   <cb:value>1.1240</cb:value>
   <cb:unit>percent</cb:unit>
   <cb:decimals>4</cb:decimals>
</cb:observation>
Requirement: Required.
[edit]

<cb:interestRate><cb:rateName>

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

Syntax: 
<cb:rateName>FedFunds</cb:rateName>
Requirement: Required.
[edit]

<cb:interestRate><cb:rateType>

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

Syntax: 
<cb:rateType>noon buying</cb:rateType>
Requirement: Required.
[edit]

<cb:interestRate><cb:observationPeriod>

The <cb:observationPeriod> child element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by two required elements, which must appear in the order given below.

The <cb:frequency> child element has an text value that can be limited to the values of a code list. See the relevant application guides for more information.

The <cb:period> child element has a text value.

Syntax: 
<cb:observationPeriod rdf:parseType="Resource">
   <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#ObservationPeriod"/>
   <cb:frequency>weekly</cb:frequency>
   <cb:period>2008-01-02</cb:period>
</cb:observationPeriod>
Requirement: Required.
[edit]

<cb:transaction>

The <cb:transaction> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type, 
<rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Transaction"/>
This element is followed by four required and one optional child elements, which must appear in the order given below. Any additional elements, including custom elements, must follow them.
[edit]

<cb:transaction><cb:observation>

The <cb:observation> child element of the <cb:transaction> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by four required elements, which must appear in the order given below.

The <cb:value> child element has a decimal value. Three examples of valid values: -1.23 / 12678967.5432 / 675

The <cb:unit> child element has a text value.

The <cb:unit_mult> child element has an integer value. The value is an exponent of 10. A unit_mult of 2, for example, indicates that the value is multiplied by 100.

The <cb:decimals> child element has an integer value.

div style="border:1px dashed #c0c0c0;">

Syntax: 
<cb:observation rdf:parseType="Resource">
   <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Observation"/>
   <cb:value>1.781</cb:value>
   <cb:unit>USD</cb:unit>
   <cb:unit_mult>9</cb:unit_mult>
   <cb:decimals>3</cb:decimals>
</cb:observation>
Requirement: Required.
[edit]

<cb:transaction><cb:transactionName>

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

Syntax: 
<cb:transactionName>couponPurchase</cb:transactionName>
Requirement: Required.
[edit]

<cb:transaction><cb:transactionType>

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

Syntax: 
<cb:transactionType>permanent open market operations</cb:transactionType>
Requirement: Required.
[edit]

<cb:transaction><cb:observationPeriod>

The <cb:observationPeriod> child element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by two required elements, which must appear in the order given below.

The <cb:frequency> child element has an text value that can be limited to the values of a code list. See the relevant application guides for more information.

The <cb:period> child element has a text value.

Syntax: 
<cb:observationPeriod rdf:parseType="Resource">
   <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#ObservationPeriod"/>
   <cb:frequency>quarterly</cb:frequency>
   <cb:period>Q4 2008</cb:period>
</cb:observationPeriod>
Requirement: Required.
[edit]

<cb:transaction><cb:transactionTerm>

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

Syntax: 
<cb:transactionTerm>1day</cb:transactionTerm>
Requirement: Optional. Recommended for transactions that have a term.
[edit]

<cb:otherStatistic>

The <cb:otherStatistic> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type, 
<rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#OtherStatistic"/>
This element is followed by four required and one recommended child elements, which must appear in the order given below. Any additional elements, including custom elements, must follow them.
[edit]

<cb:otherStatistic><cb:observation>

The <cb:observation> child element of the <cb:otherStatistic> element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by four required elements, which must appear in the order given below.

The <cb:value> child element has a decimal value. Three examples of valid values: -1.23 / 12678967.5432 / 675

The <cb:unit> child element has an text value.

The <cb:unit_mult> child element has an integer value. The value is an exponent of 10. A unit_mult of 2, for example, indicates that the value is multiplied by 100.

The <cb:decimals> child element has an integer value.

Syntax: 
<cb:observation rdf:parseType="Resource">
   <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#Observation"/>
   <cb:value>241.6</cb:value>
   <cb:unit>USD</cb:unit>
   <cb:unit_mult>9</cb:unit_mult>
   <cb:decimals>1</cb:decimals>
</cb:observation>
Requirement: Required.
[edit]

<cb:otherStatistic><cb:topic>

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

Syntax: 
<cb:topic>CP</cb:topic>
Requirement: Required.
[edit]

<cb:otherStatistic><cb:coverage>

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

Syntax: 
<cb:topic>Manufacturing</cb:topic>
Requirement: Required.
[edit]

<cb:otherStatistic><cb:observationPeriod>

The <cb:observationPeriod> child element has a required attribute, rdf:parseType="Resource", and an element declaring the RSS-CB type followed by two required elements, which must appear in the order given below.

The <cb:frequency> child element has an text value that can be limited to the values of a code list. See the relevant application guides for more information.

The <cb:period> child element has a text value.

Syntax: 
<cb:observationPeriod rdf:parseType="Resource">
   <rdf:type rdf:resource="http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_RDF_Schema#ObservationPeriod"/>
   <cb:frequency>quarterly</cb:frequency>
   <cb:period>Q4 2008</cb:period>
</cb:observationPeriod>
Requirement: Required.
[edit]

<cb:otherStatistic><cb:dataType>

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

Syntax: 
<cb:dataType>seasonally adjusted index, 1997 = 100 </cb:dataType>
Requirement: Recommended.
[edit]

Dublin Core and/or custom namespace elements

If desired, add Dublin Core metadata before the cb element and after the <title>, <link> and <description>. Custom metadata not otherwise included in the RSS-CB specifications must appear within the <cb:custom> element after the <cb> namespace element for the application. The <cb:custom> has a required attribute rdf:parseType="Resource"

Syntax: 
<item>  
  <title>Your title</title>
  ...
  <dc:creator>Your Institution, Public Affairs Department</dc:creator>
  <dc:publisher>Your Institution</dc:publisher> 
  <dc:format>application/pdf</dc:format>
  <cb:speech rdf:parseType="Resource">
    ...    
  </cb:speech>
  <cb:custom rdf:parseType="Resource">  
    <yourinstitution:contact>Paul Roberts</yourinstitution:contact>
  </cb:custom>  
</item>
Requirement: Optional
Retrieved from "http://www.cbwiki.net/wiki/index.php/RSS-CB_1.2_Specification"
Personal tools