Network Working GroupG. Sneddon
Internet-DraftMay 23, 2009
Intended status: Experimental 
Expires: November 24, 2009 


Atom Export Format
draft-sneddon-atom-export-01

Status of this Memo

This Internet-Draft is submitted to IETF in full conformance with the provisions of BCP 78 and BCP 79.

Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts.

Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as “work in progress.”

The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt.

The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html.

This Internet-Draft will expire on November 24, 2009.

Copyright Notice

Copyright (c) 2009 IETF Trust and the persons identified as the document authors. All rights reserved.

This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents in effect on the date of publication of this document (http://trustee.ietf.org/license-info). Please review these documents carefully, as they describe your rights and restrictions with respect to this document.

Abstract

This document specifies a method of using the Atom Syndication Format as an export format.



1.  Introduction

[anchor2] (This section is yet to be written.)



2.  Conformance Requirements

The key words "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] (Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels,” March 1997.).



3.  Atom Export Documents

An Atom Export Document is an Atom Feed Document [RFC4287] (Nottingham, M., Ed. and R. Sayre, Ed., “The Atom Syndication Format,” December 2005.).

atom:entry elements are given purpose within the document by an atom:category element whose the scheme attribute is equal to "XXX-to-be-decided" and whose term attribute matches one of the below:

  1. "post" signifies the entry represents a blog post. Furthermore, an atom:category with scheme "http://schemas.google.com/g/2005#kind" and term "http://schemas.google.com/blogger/2008/kind#post" SHOULD be treated as equivalent.
  2. "comment" signifies the entry represents a reply to a post which MUST be in the same Atom Export Document and which MUST be specified by an thr:in-reply-to element [RFC4685] (Snell, J., “Atom Threading Extensions,” September 2006.) within the entry. Furthermore, an atom:category with scheme "http://schemas.google.com/g/2005#kind" and term "http://schemas.google.com/blogger/2008/kind#comment" SHOULD be treated as equivalent.

Such an atom:category element MUST be the first element child of the atom:entry. If it is not, implementations MUST NOT incur any meaning from it.

Any atom:entry which does not have such an atom:category element is assigned absolutely no meaning by this specification.



4.  Further Recommendations

This section is informative.

If an implementation wishes to store data beyond what is easily representable within Atom for importing/exporting state, it is recommended that a namespace is created to contain this extra metadata, and it is not coerced in an over-engineered manner into Atom.



5.  Security Considerations

As Atom Export Documents are just Atom Feed Documents, please see the "Security Considerations" section of [RFC4287] (Nottingham, M., Ed. and R. Sayre, Ed., “The Atom Syndication Format,” December 2005.).

Furthermore, as they can contain extensions from [RFC4685] (Snell, J., “Atom Threading Extensions,” September 2006.), please see that document too.



6.  IANA Considerations

This document has no IANA considerations.



7. Normative References

[RFC2119] Bradner, S., “Key words for use in RFCs to Indicate Requirement Levels,” BCP 14, RFC 2119, March 1997 (TXT, HTML, XML).
[RFC4287] Nottingham, M., Ed. and R. Sayre, Ed., “The Atom Syndication Format,” RFC 4287, December 2005 (TXT, HTML, XML).
[RFC4685] Snell, J., “Atom Threading Extensions,” RFC 4685, September 2006 (TXT).


Author's Address

  Geoffrey Sneddon
Email:  me@gsnedders.com
URI:  http://gsnedders.com/