atom

atom provides the means to read RFC 4287 conforming Atom 1.0 documents, which are either feeds or single entries. Procedures are provided to access child elements of feeds and entries, such as the feed author, and also to access the child elements and contents of these children, such as author name and email.

Elements themselves are returned as plain SXML documents, which are for the most part verbatim copies of the XML input elements. This is true even for the Atom document itself, which is the SXML representation of the original XML document. This means that if desired, you can access elements or the entire document using standard list deconstructors or sxpath rather than the provided accessors.

For example, accessing the feed author returns an atom:author child:

> (feed-author feed)
  ;=> (atom:author (atom:name "A. Hacker")
                   (atom:uri "http://www.hacker.dim")
                   (atom:email "buzz+off@hacker.dim"))

and you can either use the accessors, or deconstruct the result manually:

> (author-name (feed-author feed))
  ;=> "A. Hacker"
> (cadr (assq 'atom:name (cdr (feed-author G))))
  ;=> "A. Hacker"

Or for a list of all people (authors, contributors, etc.) mentioned in atom:name elements anywhere in the feed:

> (delete-duplicates ((sxpath '(// atom:name *text*)) feed))
  ;=> ("A. Hacker" "A. Contributor" "A. Groupie")

Element contents and element attributes are generally returned as text strings. This includes HTML contents, which will be unescaped for you. It also includes RFC3339 datetime strings, which can be deconstructed using the rfc3339 egg, and URIs, which can be manipulated with uri-common. Certain elements may contain XHTML or XML documents; special accessors for these elements are provided, which return their contents as SXML.

The same rules apply when creating a document; elements may be generated using their constructors or created directly in SXML if you understand the format. For example, these two excerpts are equivalent:

> (make-feed authors: (list (make-author name: "Jim" 
                                         email: "himmy@pimmy.dim"))
             ...)
> (make-feed authors: (list '(atom:author (atom:name "Jim")
                                          (atom:email "himmy@pimmy.dim")))
             ...)

except that make-author checks its input, ensuring the required name element is present and that all arguments are strings. Other constructors may do more complicated constraint checking or simplify element creation.

Read interface

Atom document

read-atom-doc portprocedure: Reads an Atom Feed Document or Atom Entry Document from PORT and returns an SXML document representing the entire XML document, including any processing instructions. If the document is not readable as XML or does not contain a single atom:feed or atom:entry root element, an error is thrown.

atom-doc-root docprocedure: Return the root element of the document, which will be an atom:feed or atom:entry node.

atom-doc-encoding docprocedure: Return XML document encoding as provided in the document; defaults to "utf-8".

read-atom-feed portprocedure: Convenience function which reads an Atom Feed Document and returns the root atom:feed element. If this fails, an error is thrown.

read-atom-entry portprocedure: Convenience function which reads an Atom Entry Document and returns the root atom:entry element. If this fails, an error is thrown.

Feeds

atom:feedrecord

An atom:feed element, which represents an Atom feed. Records such as atom:feed are just SXML documents (list structures) like

(atom:feed (atom:author ...) (atom:title ...) ...)

and can be queried either via the provided accessors, or directly via list destructuring if desired.

feed? Fprocedure: Returns true if F is an atom:feed element.

feed-authors Fprocedure

feed-author Fprocedure

feed-authors returns a list of feed authors; that is, atom:author children of the feed. A null list designates no authors.

feed-author returns the first feed author, or #f if none.

Feeds must contain at least one author element unless every feed entry contains one, as the default authorship for entries is that of the feed.

feed-categories Fprocedure: Returns a list of feed categories (atom:category children), or null.

feed-contributors Fprocedure: Returns a list of feed contributors (atom:contributor children), or null.

feed-generator Fprocedure: Returns the feed generator (the atom:generator child), or #f if none.

feed-icon Fprocedure: Returns the feed icon (the atom:icon child), or #f if none.

feed-id Fprocedure: Returns the feed ID as a string (the text contents of the atom:id child), or the empty string if no ID. The ID is required in an Atom feed.

feed-links Fprocedure: Returns a list of feed links (atom:link children), or null.

feed-logo Fprocedure: Returns the feed logo (atom:logo child), or #f if none.

feed-rights Fprocedure: Returns the feed rights (atom:rights child), or #f if none.

feed-subtitle Fprocedure: Returns the feed subtitle (atom:subtitle child), or #f if none.

feed-title Fprocedure: Returns the feed title (atom:title child), or #f if none. The Atom spec requires a feed title.

feed-updated Fprocedure: Returns an rfc3339 string representing the last time the feed was updated. The Atom spec requires this field to be present.

feed-entries Fprocedure: Return a list of feed entries (atom:entry children), or null.

Entries

atom:entryrecord

An atom:entry element, which represents an Atom entry. Records such as atom:entry are just SXML documents (list structures) like

(atom:entry (atom:author ...) (atom:id ...) ...)

and can be queried either via the provided accessors, or directly if desired.

entry? Eprocedure: Returns true if E is an atom:entry.

entry=? E1 E2procedure: Returns true if E1 and E2 represent the same atom:entry. This tests the entry IDs for equivalence.

entry-authors Eprocedure

entry-author Eprocedure

entry-authors returns a list of entry authors; that is, atom:author children of the entry. A null list designates no authors.

entry-author returns the first entry author, or #f if none.

Each entry must have at least one author. If not present as a child of the entry, it must be present in the entry's source feed element (for aggregated content), or in the feed element itself.

Currently, you must handle this manually. One possibility is:

(or (entry-author E)
    (feed-author F))

entry-categories Eprocedure: Returns a list of entry categories (atom:category children), or null.

entry-contributors Eprocedure: Returns a list of entry contributors (atom:contributor children), or null.

entry-content Eprocedure: Returns the entry content (the atom:content child), or #f if none. Entries need not contain a content element, but if not, they must contain an atom:link with a link-relation of "alternate".

entry-id Eprocedure: Returns the entry ID as a string (the text contents of the atom:id child), or the empty string if no ID. Atom entries must contain exactly one atom:id element.

entry-links Eprocedure: Returns a list of entry links (atom:link children), or null.

entry-published Eprocedure: Returns an rfc3339 datetime string, typically representing the entry's initial creation time or first availability.

entry-rights Eprocedure

Returns the entry rights (atom:rights child), or #f if none.

If no entry rights are present, the feed's rights are considered to apply. Currently, you must do this manually:

(or (entry-rights E)
    (feed-rights F))

entry-source Eprocedure

Returns the entry's source feed information (atom:source child), or #f if none.

The entry's source feed is used by Atom content aggregators to record information on where the entry came from.

entry-summary Eprocedure: Returns the entry summary (atom:summary child), or #f if none. The summary must be present if the entry's content is of kind 'external or 'binary.

entry-title Eprocedure: Returns the entry title (atom:title child), or #f if none. Atom entries must contain exactly one atom:title element.

entry-updated Eprocedure: Returns an rfc3339 string representing the last time the entry was updated. Atom entries must contain exactly one atom:updated element.

Persons

atom:authorrecord

author? Aprocedure

author-name Aprocedure

author-uri Aprocedure

author-email Aprocedure

Predicate and accessors for atom:author elements, representing the authors of the feed or entry.

name: (required by spec) the author's name, a string
uri: a URI associated with the author, a string
email: the author's email address, a string conforming to RFC2822

Accessors return the empty string if the field is not present.

atom:contributorrecord

contributor? Aprocedure

contributor-name Aprocedure

contributor-uri Aprocedure

contributor-email Aprocedure

Predicate and accessors for atom:contributor elements, representing contributors to the feed or entry.

name: (required by spec) the contributor's name, a string
uri: a URI associated with the contributor, a string
email: the contributor's email address, a string conforming to RFC2822

Accessors return the empty string if the field is not present.

Rights, Summary, Title, Subtitle

atom:rightsrecord

rights? Aprocedure

rights-type Aprocedure

rights-text Aprocedure

rights-xhtml Aprocedure

Predicate and accessors for atom:rights elements, which represent human-readable rights information for the feed. This element is an atomtextConstruct, so it may contain either text (here meaning either plain text or HTML), or XHTML content.

rights-type will return the type of content as a symbol:

'text: text content
'html: html content (considered to be text)
'xhtml: XHTML content

rights-text returns the contents of the element as a string, and is what you should use for 'text or 'html types. HTML will be unescaped for you, but is still returned as a string. It returns the empty string if no text is present.

rights-xhtml returns the XHTML contents of the element as an SXML document. The root element inside the contents must be an XHTML div (xhtml:div). If such an element is not found, it returns #f. Note that we return the div as the root of the SXML document, but the Atom spec says you must not consider the div itself part of the content.

atom:summaryrecord
summary? Aprocedure
summary-type Aprocedure
summary-text Aprocedure
summary-xhtml Aprocedure: Predicate and accessors for atom:summary elements, representing an excerpt or abstract for an entry. For meaning, see atom:rights.

atom:subtitlerecord
subtitle? Aprocedure
subtitle-type Aprocedure
subtitle-text Aprocedure
subtitle-xhtml Aprocedure: Predicate and accessors for atom:subtitle elements, representing a subtitle for the feed. For meaning, see atom:rights.

atom:titlerecord
title? Aprocedure
title-type Aprocedure
title-text Aprocedure
title-xhtml Aprocedure: Predicate and accessors for atom:title elements, representing a title for the feed or entry. For meaning, see atom:rights.

Generators

atom:generatorrecord

generator? Gprocedure

generator-agent Gprocedure

generator-uri Gprocedure

generator-version Gprocedure

Predicate and accessors for atom:generator elements, which represent the (machine) agent that generated the feed.

agent: a human-readable, plain-text name for the generating agent, as a string
uri: URI relevant to the agent, as a string
version: version of the generating agent, as a string

Icons & Logos

atom:iconrecord
icon? Iprocedure
icon-uri Iprocedure: Predicate and accessors for atom:icon elements, which represent iconic visual identification for the feed. icon-uri returns a URI string which points to the icon image.

atom:logorecord
logo? Iprocedure
logo-uri Iprocedure: Predicate and accessors for atom:logo elements, which represent visual identification for the feed. logo-uri returns a URI string which points to the logo image.

Source feeds

source? Srecord

source-authors Sprocedure

source-author Sprocedure

source-categories Sprocedure

source-contributors Sprocedure

source-generator Sprocedure

source-icon Sprocedure

source-id Sprocedure

source-links Sprocedure

source-logo Sprocedure

source-rights Sprocedure

source-subtitle Sprocedure

source-title Sprocedure

source-updated Sprocedure

Predicate and accessors for atom:source elements, which represent metadata about the source feed from which the containing entry was taken, and are used for feed aggregators.

Accessors have the same meaning as the corresponding accessors for feeds.

Content

atom:contentrecord

content?procedure

content-kind Cprocedure

content-type Cprocedure

content-source Cprocedure

content-text Cprocedure

content-xhtml Cprocedure

content-xml Cprocedure

content-contents Cprocedure

Predicate and accessors for atom:content elements, which represent feed or entry content.

Atom content types may be one of "text", "html", "xhtml", or any valid MIME type; further, the structure and meaning of the content itself depends on the MIME type. To simplify this, we normalize the MIME type and we categorize it by kind:

type: The indicated MIME media type of the contents. If the type in the source document is text, html, or xhtml, we normalize this to text/plain, text/html, or application/xhtml+xml respectively. If no type is explicitly indicated, it defaults to text/plain.
kind: The computed "kind" of the contents, as a symbol. This determines how you should handle the content.

kind may be one of the following symbols, which represent

text: plain text (text/plain), the default
html: HTML text (text/html)
xhtml: an XHTML div element (application/xhtml+xml)
xml: XML; any MIME type string ending with /xml or +xml, or one of the RFC3023 XML media types
textual: text data; any other MIME type starting with text/
binary: base64-encoded binary data; any other MIME type other than those mentioned above
external: external data pointed to by a URI

To obtain the content, you should use the proper accessor based on the kind:

text: content-text, returning a string (or empty string, if no content)
html: content-text, returning an unescaped HTML string (or empty string)
xhtml: content-xhtml, returning the XHTML div element as SXML, or #f
xml: content-xml, returning the root element (whatever it is) as SXML, or #f [*]
textual: content-text, returning a string (or empty string)
binary: content-text, returning a base64-encoded string; use base64 to decode it
external: content-source, returning the external URI as a string, or #f

[*] XML contents conventionally consist of a single root element with no siblings, which is returned directly as (node ...). If more than one such element is found, they are all returned wrapped in a *TOP* node, like (*TOP* (node1 ...) (node2 ...) ...).

For xml, textual, binary and external kinds, you will then need to refer to the content media type to actually process it.

And finally the raw content accessor, just in case:

contents: Contents of the atom:contents element as a raw list of nodes. Does not try to process the content.

IDs

atom:idrecord
id=? id1 id2procedure: Atom IDs are represented by plain strings in this egg, rather than atom:id elements. ID equality should be tested using id=?, which is aliased to string=?.

Write interface

Producing an Atom document

(write-atom-doc doc #!optional (port (current-output-port)))procedure: Write the Atom Feed or Atom Entry Document DOC, an SXML document typically created by make-atom-doc, to PORT.

make-atom-doc root #!key (declare-xml? #t) (encoding utf-8) (headers '())procedure

Create an Atom Feed Document or Atom Entry Document. ROOT is the atom:feed or atom:entry SXML root node, usually created by make-feed or make-entry. Returns a SXML document representing the entire Atom document, which can be written out using write-atom-doc.

declare-xml?: Whether to add an XML declaration to the document, as a boolean value.
encoding: The encoding to declare in the (optional) XML declaration, as a string.
headers: A list of headers to include in the output document; see below.

Arbitrary headers may be added to the output document. These headers should, generally, be XML processing instructions or comments, since the document must consist of only one root node. For example, you can prepend some stylesheet instructions:

(write-atom-doc
 (make-atom-doc feed
  headers: '((*PI* xml-stylesheet
              "type=\"text/xsl\" href=\"http://3e8.org/styles/atom.xsl\"")
             (*PI* xml-stylesheet
              "type=\"text/css\" href=\"http://3e8.org/styles/atom.css\"")))

<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="http://3e8.org/styles/atom.xsl"?>
<?xml-stylesheet type="text/css" href="http://3e8.org/styles/atom.css"?>
<atom:feed xmlns:atom="http://www.w3.org/2005/Atom">
 ...

Since this procedure just returns a complete SXML document beginning with a *TOP* node, you could instead modify the returned document and add any processing instructions yourself. headers is just a convenient way of doing so.

Feed constructor

make-feed #!key KEYSprocedure

Make a new atom:feed element, with KEYS corresponding to child elements. Raises an error if any required elements are missing.

Required elements:

authors: a list of atom:author elements, the authors of the feed
id: an atom:id string, a permanent, unique absolute IRI identifier
title: an atom:title element, a human-readable title for the feed
updated: an atom:updated element, an RFC3339 timestamp indicating last update time

Optional elements:

categories: a list of atom:category elements, the feed categories
contributors: a list of atom:contributor elements, the contributors to the feed
generator: an atom:generator element, the feed generator
icon: an atom:icon element, the feed icon
links: a list of atom:link elements, the feed links
logo: an atom:logo element, the feed logo
rights: an atom:rights element, a human-readable description of rights held over the feed
subtitle: an atom:subtitle element, a human-readable subtitle for the feed
entries: a list of atom:entry elements, the feed entries

Notes:

It's a good idea to provide an "alternate" link for your feed and for each entry, pointing to the source document. See make-link.
authors may be omitted if all entries contain authorship information (meaning, atom:author elements as direct children). make-feed will detect this case.
If you omit generator, it defaults to describing this egg. To completely omit the generator element, which would make me sad, pass #f.

Entry constructor

make-entry #!key KEYSprocedure

Make a new atom:entry element, with KEYS corresponding to child elements. Raises an error if any required elements are missing.

Required elements:

id: an atom:id string, a permanent, unique absolute IRI identifier for the entry
title: an atom:title element, a human-readable title for the entry
updated: an atom:updated element, an RFC3339 timestamp indicating last update time

Optional elements:

authors: a list of atom:author elements, the authors of the entry
categories: a list of atom:category elements, the entry categories
contributors: a list of atom:contributor elements, the contributors to the entry
content: an atom:content element, the entry content
links: a list of atom:link elements, the entry links
published: an atom:published element, an RFC3339 timestamp indicating initial creation time
rights: an atom:rights element, a human-readable description of rights held over the entry
source: an atom:source element, information about the feed source for content aggregators
summary: an atom:summary element, a human-readable summary, abstract or excerpt of the entry

Additional notes:

Entry author elements are optional as long as the containing feed contains authorship information. If the feed does not, the entry must contain least one author element. This will be checked in make-feed.

Entry elements without a atom:content element must contain an atom:link with link-relation "alternate". This is checked in make-entry.

Entry summary elements are optional unless an atom:content element is present and its content kind is 'external or 'binary. This is checked in make-entry.

It is illegal for entries to contain more than one atom:link element with a link-relation of "alternate" and the same type and uri-language values. This is not checked in make-entry.

Person constructors

make-author #!key name uri emailprocedure

Create an atom:author element.

name: (required) the author's name, a string
uri: a URI associated with the author, a string
email: the author's email address, a string conforming to RFC2822

make-contributor #!key name uri emailprocedure

Create an atom:contributor element.

name: (required) the contributor's name, a string
uri: a URI associated with the contributor, a string
email: the contributor's email address, a string conforming to RFC2822

Text constructors

make-rights contents #!key (type 'text)procedure

make-subtitle contents #!key (type 'text)procedure

make-summary contents #!key (type 'text)procedure

make-title contents #!key (type 'text)procedure

Create a new atom:rights, atom:subtitle, atom:summary, or atom:title element with CONTENTS of type TYPE. The accepted value for CONTENT varies according to TYPE:

'text: (default) a plain text string
'html: an HTML string (it will be escaped for you when written to XML)
'xhtml: an XHTML div element as SXML

> (make-title "Mesoamerican Deities and You")
  ; => (atom:title (@ (type "text")) "Mesoamerican Deities and You")
> (make-rights '(xhtml:div "Copyright (c) 2012 the feathered serpent, "
                           (xhtml:b "Quetzlcoatl"))
               type: 'xhtml)
  ; => (atom:rights (@ (type "xhtml"))
        (xhtml:div "Copyright (c) 2012 the feathered serpent, "
                   (xhtml:b "Quetzlcoatl")))
> (make-summary
   "<p>Coping strategies for when your best friend is a 
   <a href='http://en.wikipedia.org/wiki/Quetzalcoatl'>mythical god</a>
   and just <i>won't move out</i> of your cramped apartment</p>"
   type: 'html)
  ; => (atom:summary (@ (type "html"))
        "<p>Coping strategies for when your best friend is a
         <a href='http://en.wikipedia.org/wiki/Quetzalcoatl'>mythical god</a>
         and just <i>won't move out</i> of your cramped apartment</p>")

Generator constructor

make-generator agent #!key uri versionprocedure

Create an atom:generator element representing the feed generator.

agent: a human-readable, plain-text name for the generating agent, as a string
uri: URI relevant to the agent, as a string
version: version of the generating agent, as a string

Icon & Logo constructors

make-icon uriprocedure: Create an atom:icon element, which represents iconic visual identification for the feed. URI should be a URI string pointing to the icon image.

make-logo uriprocedure: Create an atom:logo element, which represents visual identification for the feed. URI should be a URI string pointing to the logo image. Compare to make-icon.

ID constructor

IDs are plain strings, and will be automatically converted to atom:id elements when passed to make-feed or make-entry. No constructors are currently provided.

Each unique entry and feed must contain a unique atom:id, which must be an absolute URI. One option is to use the permalink of your entry or feed in this field. Another is to use a tag URI, which is generally considered more robust. An example tag URI for an entry might look like:

tag:domain.org,2012-12-21:/blog/the-mayans-are-coming

Also see The "atom:id" Element in RFC 4287 for details on atom:id and e.g. these tutorials for ideas on ID creation. Note that tag URIs have some important restrictions on which characters are valid.

Category constructor

make-category #!key term scheme labelprocedure

Create an atom:category element representing the feed or entry category.

term: (required) category name, as a string
scheme: URI that identifies a categorization scheme, as a string
label: human-readable plain-text label for the category, as a string

Link constructor

make-link #!key uri relation title ...procedure

Create an atom:link element representing a reference from an entry or feed to a Web resource.

uri: (required) the URI (@href) of the link
relation: (default "alternate") the link relation type (@rel) as a string; see below
title: human-readable, plain-text title for the link, as a string
type: advisory MIME media type for the referenced resource, as a string or MIME-type symbol
length: advisory length in octets for the referenced resource, as an exact integer
uri-language: an RFC3066 language tag (@hreflang) for the referenced resource, as a string

The five common link relations are:

"alternate": an alternate version of this resource. For a feed, it might be a link to your webpage; for an entry, it might be a permalink to your blog entry, with type: 'html. Feed readers work better when you include such a link.
"self": a link to this Atom document, usually the URI to your Atom feed with type: 'atom.
"related": a related link
"enclosure": identifies a "potentially large" external resource; you should provide length:
"via": a link to the source of the information

For type:, the currently known MIME-type symbol shortcuts are 'text, 'html, 'xhtml, and 'atom. Otherwise, use the full type name as a string.

Source constructor

make-source #!key authors categories contributors ...procedure

Create an atom:source element representing the source feed from which the containing entry was taken. This is used by content aggregators to preserve metadata about their source feeds.

See the feed constructor make-feed for the meaning of these elements, and then see RFC 4287 for what metadata you would typically preserve.

Content constructor

make-content content #!key (type 'text) sourceprocedure

Create an atom:content element representing the content of an entry. Acceptable values for CONTENT vary according to the value of TYPE.

type: (default 'text) the MIME media type of the content as a string, or one of the shorthand symbols 'text, 'html or 'xhtml. See below.
source: a source URI the client must dereference to obtain the content, as a string. In this case, CONTENT is ignored and the element content will be empty. Use a dummy value for content such as #f or the empty string.

The content type may be:

'text or "text/plain": a human-readable, plain text string
'html or "text/html": a string containing HTML markup (which will be escaped for you)
'xhtml or "application/xhtml+xml": an xhtml:div element
an XML MIME type: an SXML document consisting of a single root node. An XML MIME type is any MIME type string ending with "/xml" or "+xml", or one of the RFC3023 XML media types
a textual MIME type: a text string; a textual MIME type is any MIME type string starting with "text/"
any other MIME type: the content is considered binary, and the user must pass a base64 encoded string as the content.

Miscellany

atom-ns-prefixesparameter

An alist of XML namespace prefixes used when reading or writing feeds. Most known namespaces relevant to Atom are included, so it is normally not necessary to touch this unless you come across an unusual namespace.

A symptom of a missing namespace is that on read, some feed elements are qualified with a full URI instead of a prefix abbreviation, and on write that some are qualified with namespace 'prfx1:' or the like.

Examples

Creating the "extensive" example feed from RFC4287:

(use atom rfc3339)
(write-atom-doc
 (make-atom-doc
  (make-feed
   title: (make-title "dive into mark")
   subtitle: (make-subtitle "A <em>lot</em> of effort went into making this effortless"
			    type: 'html)
   updated: "2005-07-31T12:29:29Z"
   id: "tag:example.org,2003:3"
   links: (list (make-link type: 'html
			   uri-language: "en"
			   uri: "http://example.org")
		(make-link relation: "self"
			   type: "application/atom+xml"
			   uri: "http://example.org/feed.atom"))
   rights: (make-rights "Copyright (c) 2003, Mark Pilgrim")
   generator: (make-generator "Example Toolkit"
			      uri: "http://www.example.com"
			      version: "1.0")
   entries: (list
	     (make-entry
	      title: (make-title "Atom draft-07 snapshot")
	      links: (list (make-link type: 'html
				      uri: "http://example.org/2005/04/02/atom")
			   (make-link relation: "enclosure"
				      type: "audio/mpeg"
				      length: 1337
				      uri: "http://example.org/audio/ph34r_my_podcast.mp3"))
	      id: "tag:example.org,2003:3.2397"
	      updated: (rfc3339->string (make-rfc3339 2005 07 31 12 29 29 0 0))
	      published: (rfc3339->string (make-rfc3339 2003 12 13 08 29 29 0 (* 3600 4)))
	      authors: (list (make-author name: "Mark Pilgrim"
					  uri: "http://example.org"
					  email: "f8dy@example.com"))
	      contributors: (list (make-contributor
				   name: "Sam Ruby")
				  (make-contributor
				   name: "Joe Gregorio"))
	      ;; xml:base, xml:lang cannot be handled yet
	      content: (make-content
			'(xhtml:div
			  (xhtml:p (xhtml:i "[Update: The Atom draft is finished.]")))
			type: 'xhtml))))))

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <generator uri="http://www.example.com" 
             version="1.0">Example Toolkit</generator>
  <id>tag:example.org,2003:3</id>
  <link href="http://example.org" rel="alternate" 
        type="text/html" hreflang="en" />
  <link href="http://example.org/feed.atom" 
        rel="self" type="application/atom+xml" />
  <rights type="text">Copyright (c) 2003, Mark Pilgrim</rights>
  <subtitle type="html">A &lt;em&gt;lot&lt;/em&gt; of effort
    went into making this effortless</subtitle>
  <title type="text">dive into mark</title>
  <updated>2005-07-31T12:29:29Z</updated>
  <entry>
    <author>
      <name>Mark Pilgrim</name>
      <uri>http://example.org</uri>
      <email>f8dy@example.com</email>
    </author>
    <contributor>
      <name>Sam Ruby</name>
    </contributor>
    <contributor>
      <name>Joe Gregorio</name>
    </contributor>
    <content type="xhtml">
      <div xmlns="http://www.w3.org/1999/xhtml">
        <p>
          <i>[Update: The Atom draft is finished.]</i>
        </p>
      </div>
    </content>
    <id>tag:example.org,2003:3.2397</id>
    <published>2003-12-13T08:29:29-04:00</published>
    <title type="text">Atom draft-07 snapshot</title>
    <updated>2005-07-31T12:29:29Z</updated>
    <link href="http://example.org/2005/04/02/atom" 
          rel="alternate" type="text/html" />
    <link href="http://example.org/audio/ph34r_my_podcast.mp3" 
          rel="enclosure" type="audio/mpeg" length="1337" />
  </entry>
</feed>

Known Issues

xml:base and xml:lang are not supported, either on reading or writing. You can add these attributes manually to the output document for writing, but for reading the parser will not understand them and relative URLs will not be resolved.
Elements outside the atom: namespace, such as feedburner:, will repeatedly declare their prefix mapping in the element itself instead of in the root element, leading to a large amount of redundant verbosity.
Dealing with extension elements and attributes is a bit painful as you must manipulate the SXML directly.

0.1.4: Fix failing test due to incorrect version in text (Peter Bex).
0.1.3: Add Chicken 5 support. Convert test examples to real tests.
0.1.2: Fix missing regex dependency
0.1.1: Use default namespace for atom and xhtml
0.1: Initial release

License

BSD.

chickadee » atom

Identifier search

TOC »

Overview