view Side-By-Side changes
Network Working Group M. Nottingham, Ed. Internet-Draft Expires:July 27,September 13, 2005 R. Sayre, Ed. Boswijck Memex ConsultingJanuary 26,March 12, 2005 The Atom Syndication Formatdraft-ietf-atompub-format-05draft-ietf-atompub-format-06 Status of this Memo This document is an Internet-Draft and is subject to all provisions of Section 3 of RFC 3667. By submitting this Internet-Draft,I certifyeach author represents that any applicable patent or other IPR claims of whichI amhe or she is aware have been or will be disclosed, and any of whichIhe or she become aware will be disclosed, in accordance with RFC 3668. 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 onJuly 27,September 13, 2005. Copyright Notice Copyright (C) The Internet Society (2005).All Rights Reserved.Abstract This document specifies Atom, an XML-based Web content and metadata syndication format. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 1] Internet-Draft Atom FormatJanuaryMarch 2005 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1 Editorial Notes . . . . . . . . . . . . . . . . . . . . . 4 1.2 Example . . . . . . . . . . . . . . . . . . . . . . . . . 5 1.3Conformance . . . . . . . . . . . . . . . . . . . . . . . 5 1.4Notational Conventions . . . . . . . . . . . . . . . . . . 5 2. Atom Documents . . . . . . . . . . . . . . . . . . . . . . . 7 3. Common Atom Constructs . . . . . . . . . . . . . . . . . . . 9 3.1 Text Constructs . . . . . . . . . . . . . . . . . . . . . 9 3.1.1 "type" Attribute . . . . . . . . . . . . . . . . . . . 9 3.2 Person Constructs . . . . . . . . . . . . . . . . . . . .1011 3.2.1 The "atom:name" Element . . . . . . . . . . . . . . .1011 3.2.2 The "atom:uri" Element . . . . . . . . . . . . . . . .1011 3.2.3 The "atom:email" Element . . . . . . . . . . . . . . . 11 3.3 Date Constructs . . . . . . . . . . . . . . . . . . . . . 113.4 Service Constructs .4. Atom Element Definitions . . . . . . . . . . . . . . . . . . 13 4.1 Container Elements .11 3.4.1 The "href" Attribute. . . . . . . . . . . . . . . . .11 3.5 Identity Constructs. . 13 4.1.1 The "atom:feed" Element . . . . . . . . . . . . . . . 13 4.1.2 The "atom:entry" Element . .11 3.5.1 Dereferencing Identity Constructs. . . . . . . . . .12 3.5.2 Comparing Identity Constructs. . . 14 4.1.3 The "atom:content" Element . . . . . . . . .12 4. Element Definitions. . . . . 16 4.2 Metadata Elements . . . . . . . . . . . . . . .14 4.1 The "atom:feed" Element. . . . . 19 4.2.1 The "atom:author" Element . . . . . . . . . . . .14 4.1.1 The "version" Attribute. . 19 4.2.2 The "atom:category" Element . . . . . . . . . . . . .14 4.220 4.2.3 The"atom:head""atom:contributor" Element . . . . . . . . . . . . 20 4.2.4 The "atom:copyright Element . . . . .14 4.2.1 Usage of "atom:head" within "atom:entry". . . . . . .16 4.3. 20 4.2.5 The"atom:entry""atom:generator" Element . . . . . . . . . . . . .. . . . 16 4.421 4.2.6 The"atom:title""atom:icon" Element . . . . . . . . . . . . . . .. . 18 4.521 4.2.7 The "atom:id" Element . . . . . . . . . . . . . . . .. . 18 4.621 4.2.8 The"atom:link""atom:image" Element . . . . . . . . . . . . . . .. . 18 4.6.123 4.2.9 The"href" Attribute . ."atom:link" Element . . . . . . . . . . . . . . .19 4.6.223 4.2.10 The"rel" Attribute ."atom:published" Element . . . . . . . . . . . . 26 4.2.11 The "atom:source-feed" Element . . . .19 4.6.3 The "type" Attribute. . . . . . . 26 4.2.12 The "atom:subtitle" Element . . . . . . . . . .20 4.6.4 The "hreflang" Attribute. . 26 4.2.13 The "atom:summary" Element . . . . . . . . . . . . .20 4.6.527 4.2.14 The"title" Attribute . ."atom:title" Element . . . . . . . . . . . . . .20 4.6.627 4.2.15 The"length" Attribute ."atom:updated" Element . . . . . . . . . . . . . 27 5. Securing Atom Documents . .20 4.7 The "atom:updated" Element. . . . . . . . . . . . . . . .20 4.8 The "atom:published" Element28 5.1 Digital Signatures . . . . . . . . . . . . . . .21 4.9 The "atom:author" Element. . . . . 28 5.2 Encryption . . . . . . . . . . .21 4.10 The "atom:contributor" Element. . . . . . . . . . . . .21 4.11 The "atom:host" Element28 6. Extending Atom . . . . . . . . . . . . . . . .21 4.12 The "atom:copyright" Element. . . . . . . 29 6.1 Extensions From Non-Atom Vocabularies . . . . . . .21 4.13 The "atom:category" Element. . . 29 6.2 Extensions To the Atom Vocabulary . . . . . . . . . . .22 4.13.1 The "term" Attribute .. 29 6.3 Software Processing of Foreign Markup . . . . . . . . . . 29 6.4 Extension Elements . . . .22 4.13.2 The "scheme" Attribute. . . . . . . . . . . . . . .22 4.13.3 The "label" attribute. 29 6.4.1 Simple Extension Elements . . . . . . . . . . . . . .22 4.14 The "atom:summary" Element30 6.4.2 Structured Extension Elements . . . . . . . . . . . . 30 7. IANA Considerations . . .22 4.15 The "atom:content" Element. . . . . . . . . . . . . . .23 Nottingham & Sayre Expires July 27, 2005 [Page 2] Internet-Draft Atom Format January 2005 4.15.1 The "type" attribute. . 31 7.1 Registry of Link Relations . . . . . . . . . . . . . .23 4.15.2 The "src" attribute. . 31 Nottingham & Sayre Expires September 13, 2005 [Page 2] Internet-Draft Atom Format March 2005 8. Security Considerations . . . . . . . . . . . . . .23 4.15.3 Processing Model. . . . 33 8.1 HTML and XHTML Content . . . . . . . . . . . . . .24 4.16 The "atom:introspection" Element. . . . 33 8.2 URIs . . . . . . . .25 4.17 The "atom:post" Element. . . . . . . . . . . . . . . .25 4.18 The "atom:edit" Element. . . 33 8.3 IRIs . . . . . . . . . . . . .25 4.19 The "atom:tagline" Element. . . . . . . . . . . . . . 33 8.4 Encryption and Signing .25 4.20 The "atom:generator" Element. . . . . . . . . . . . . .25 4.21 The "atom:info" Element. . . 33 9. References . . . . . . . . . . . . .26 5. Managing Feed State. . . . . . . . . . . . 34 9.1 Normative References . . . . . . . .27 6. Securing Atom Documents. . . . . . . . . . . 34 9.2 Informative References . . . . . . .28 6.1 Digital Signatures. . . . . . . . . . . 35 Authors' Addresses . . . . . . . . .28 6.2 Encryption. . . . . . . . . . . . 36 A. Contributors . . . . . . . . . . . .28 7. Embedding Atom in Other Formats. . . . . . . . . . . . 37 B. Collected RELAX NG Compact Schema . .29 8. Extending Atom. . . . . . . . . . . 38 C. Change Log . . . . . . . . . . . .30 9. IANA Considerations. . . . . . . . . . . . . 45 Intellectual Property and Copyright Statements . . . . . . .31 9.1 Registry of Link Relations . . . . . . . . . . . . . . . . 31 10. Security Considerations . . . . . . . . . . . . . . . . . . 33 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 34 11.1 Normative References . . . . . . . . . . . . . . . . . . . 34 11.2 Informative References . . . . . . . . . . . . . . . . . . 35 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . 36 A. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 37 B. Collected RELAX NG Compact Schema . . . . . . . . . . . . . 38 C. Revision History . . . . . . . . . . . . . . . . . . . . . . 45 Intellectual Property and Copyright Statements . . . . . . . 47 Nottingham & Sayre Expires July 27, 2005 [Page 3] Internet-Draft Atom Format January 2005 1. Introduction Atom is an XML-based document format which describes lists48 Nottingham & Sayre Expires September 13, 2005 [Page 3] Internet-Draft Atom Format March 2005 1. Introduction Atom is an XML-based document format that describes lists of related information known as "feeds". Feeds are composed of a number of items, known as "entries", each with an extensible set of attached metadata. For example, each entry has a title. The primary use case that Atom addresses is the syndication of Web content such as Weblogs and news headlines to Web sites as well as directly to user agents. However, nothing precludes it from being used for other purposes and kinds of content.Details of communication protocols between software agents using Atom can be found in the Atom Protocol specification [Atom-protocol]. [[ more motivation / design principles ]]1.1 Editorial Notes The Atom format is a work-in-progress, and this draft is both incomplete and likely to change rapidly. As a result, THE FORMAT DESCRIBED BY THIS DRAFT SHOULD NOT BE DEPLOYED, either in production systems or in any non-experimental fashion on the Internet. Discussion of this draft happens in two fora; The mailing list[1]<http://www.imc.org/atom-syntax/index.html> The Atom Wiki Web site[2]<http://www.intertwingly.net/wiki/pie/FrontPage> Active development takes place on the mailing list, while the Wiki is used for issue tracking and new proposals.This document is an early draft and known to be incomplete. Topics marked [[like this]] indicate where additional text is likely to be added.Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 4] Internet-Draft Atom FormatJanuaryMarch 2005 1.2 Example A minimal, single-entry Atom Feed Document: <?xml version="1.0" encoding="UTF-8"?> <feedversion="draft-ietf-atompub-format-05:do not deploy" xmlns="http://purl.org/atom/ns#draft-ietf-atompub-format-05"> <head>xmlns="http://purl.org/atom/ns#draft-ietf-atompub-format-06"> <title>Example Feed</title> <link href="http://example.org/"/> <updated>2003-12-13T18:30:02Z</updated> <author> <name>John Doe</name> </author></head><entry> <title>Atom-Powered Robots Run Amok</title> <link href="http://example.org/2003/12/13/atom03"/><id>vemmi://example.org/2003/32397</id><id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id> <updated>2003-12-13T18:30:02Z</updated> </entry> </feed> [[anchor4: Ask yourself: is the example atom:entry valid?]] 1.3Conformance [[ talk about atom documents and atom consumers,Notational Conventions This specification describes conformance in terms of two kinds of artefacts; Atom Feed Documents andhowAtom Entry documents. Additionally, it places some requirementsare placedonthem ]] 1.4 Notational ConventionsAtom Processors. 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 BCP 14,[RFC2119].[RFC2119], as scoped to those conformance targets. This specification uses XML Namespaces [W3C.REC-xml-names-19990114] to uniquely identify XML elementsand attributenames. It uses the following namespace prefixes for the indicated namespace URIs; "atom":http://purl.org/atom/ns#draft-ietf-atompub-format-05http://purl.org/atom/ns#draft-ietf-atompub-format-06 Note that the choice of any namespace prefix is arbitrary and not semantically significant. Atom is specified using terms from the XML Infoset[W3C.REC-xml-infoset-20011024].[W3C.REC-xml-infoset-20040204]. However, this specification uses a shorthand for two common terms; the phrase "Information Item" isomitted when naming Element Information Items and AttributeNottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 5] Internet-Draft Atom FormatJanuaryMarch 2005 omitted when naming Element Information Items and Attribute Information Items. Therefore, when this specification uses the term "element," it is referring to an Element Information Item in Infoset terms. Likewise, when it uses the term "attribute," it is referring to an Attribute Information Item. Some sections of this specification are illustrated with fragments of a non-normative RELAX NG Compact schema [RELAX-NG]. However, the text of this specification provides the definition of conformance. A collected schema appears in an informative appendix. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 6] Internet-Draft Atom FormatJanuaryMarch 2005 2. Atom Documents This specification describes two kinds of Atom Documents; Atom Feed Documents and Atom Entry Documents. An Atom Feed Document is a representation of an Atom feed, including metadata about the feed, and some or all of the entries associated with it. Itsdocument elementroot isatom:feed.the atom:feed element. An Atom Entry Document represents exactly one Atom Entry, outside of the context of an Atom Feed. Itsdocument elementroot isatom:entry.the atom:entry element. namespace atom= "http://purl.org/atom/ns#draft-ietf-atompub-format-05"="http://purl.org/atom/ns#draft-ietf-atompub-format-06" start = atomFeed | atomEntry Both kinds of Atom documents are specified in terms of the XML Information Set, serialised as XML 1.0 [W3C.REC-xml-20040204] and identified with the "application/atom+xml" media type. Atom Documents MUST be well-formed XML. Atom constrains the appearance and content of elements and attributes; unless otherwise stated, Atom Documents MAY contain other Information Items as appropriate. In particular, Comment Information Items and Processing Instruction Information Items SHOULD be ignored in the normal processing of an Atom Document. Any element in an Atom Document MAY have an xml:base attribute. XML Base [W3C.REC-xmlbase-20010627] processing MUST be applied to any relative reference[RFC3986][RFC3987] present in an Atom Document. This includes such elements and attributes as specified by Atom itself, as well as those specified by extensions to Atom. Any element in an Atom Document MAY have an xml:lang attribute, whose content indicates the natural languageoffor theelement's content.element and its children. The language context is only significant for elements and attributes declared to be "language-sensitive" by this specification. Requirements regarding the content and interpretation of xml:lang are specified in XML 1.0[W3C.REC-xml-20040204][W3C.REC-xml-20040204], Section 2.12. atomCommonAttributes = attribute xml:base { atomUri }?, attribute xml:lang { atomLanguageTag }?[[ discussionAtom allows the use of IRIs [RFC3987], rather than only URIs [RFC3986]. For resolution, IRIs can easily be converted to URIs. When comparing IRIs serving as Identity Constructs, they MUST NOT be Nottingham & Sayre Expires September 13, 2005 [Page 7] Internet-Draft Atom Format March 2005 converted to URIs. Please note that by definition, every URIescaping and i18n,is an IRI, so any URI can be used where an IRI]] [[is needed. [[anchor7: discussion of whitespace ]]space]] Atom isextensible.an extensible format. See the section titled 'Extending Atom' later inNottingham & Sayre Expires July 27, 2005 [Page 7] Internet-Draft Atom Format January 2005this document for a full description of how Atom Documents can be extended. Atom Processors MAY keep state (e.g., metadata in atom:feed, entries) sourced from Atom Feed Documents and combine them with other Atom Feed Documents, in order to facilitate a contiguous view of the contents of a feed. The manner in which Atom Feed Documents are combined in order to reconstruct a feed (e.g., updating entries and metadata, dealing with missing entries) is out of the scope of this specification, but may be defined by an extension to Atom. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 8] Internet-Draft Atom FormatJanuaryMarch 2005 3. Common Atom Constructs Many of Atom's elements share a few common structures. This section defines a few such structures and their requirements for convenient reference by the appropriate element definitions. When an element is identified as being a particular kind of construct, it inherits the corresponding requirements from that construct's definition in this section. 3.1 Text Constructs A Text construct contains human readable text, usually infairlysmall quantities. Except for the "type" attribute, the content of Text constructs is language-sensitive. atomPlainTextConstruct = atomCommonAttributes, attribute type {"TEXT""text" |"HTML""html" }?, text atomXHTMLTextConstruct = atomCommonAttributes, attribute type {"XHTML""xhtml" }, (text|anyElement)* atomTextConstruct = atomPlainTextConstruct | atomXHTMLTextConstruct 3.1.1 "type" Attribute Text constructs MAY have a "type" attribute. [[anchor11: Some feel type attributes with different allowable values in different elements is confusing.]]. When present, the value MUST be one of"TEXT", "HTML""text", "html" or"XHTML"."xhtml". If the "type" attribute is not provided,softwareAtom Processors MUST behave as though it were present with a value of"TEXT"."text". Note that MIME media types [RFC2045] are not acceptable values for the "type" attribute. If the value is"TEXT","text", the content of the Text construct MUST NOT contain child elements. Such text is intended to be presented to humans in a readable fashion. Thus,softwareAtom Processors MAY display it using normal text rendering techniques such as proportional fonts, white-space collapsing, and justification. Nottingham & Sayre Expires September 13, 2005 [Page 9] Internet-Draft Atom Format March 2005 If the value of "type" is"HTML","html", the content of the Text construct MUST NOT contain child elements, and SHOULD be suitable for handlingby software that knows HTML. Theas HTML [W3C.REC-html401-19991224]. Any markupmustwithin MUST be escaped; for example, "<br>" as "<br>".TheHTML markup within SHOULD be such that itNottingham & Sayre Expires July 27, 2005 [Page 9] Internet-Draft Atom Format January 2005could validly appear directly within an HTML <DIV>element. Receiving software which displays theelement, after unescaping. Atom Processors that display such content MAY usethemarkup to aid indisplaying it. [[exampleits display. [[anchor12: example atom entry w/ escaped markup]] If the value of "type" is"XHTML","xhtml", the content of the Text constructMAY contain child elements. The content SHOULDMUST be a single XHTML div element [W3C.REC-xhtml-basic-20001219]. The XHTML div MUST contain XHTML text and markup that could validly appeardirectlywithin anxhtml:divXHTML div element.Receiving softwareThe XHTML div element itself MUST NOT be considered part of the content. Atom Processors whichdisplaysdisplay the content MAY use the markup to aid in displaying it. Escaped markup is interpreted as a text representation of markup, and MUST NOT be interpreted as markup itself. Example: ... <summary type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml"> This is <b>XHTML</b> content. </div> </summary> ... <summary type="xhtml"> <xhtml:div xmlns:xhtml="http://www.w3.org/1999/xhtml"> This is <xhtml:b>XHTML</xhtml:b> content. </xhtml:div> </summary> ... The following example assumes that the XHTML namespace has been bound to the "xh" prefix earlier in the document: ... <summary type="xhtml"> <xh:div> This is <xh:b>XHTML</xh:b> content. </xh:div> </summary> ... Nottingham & Sayre Expires September 13, 2005 [Page 10] Internet-Draft Atom Format March 2005 3.2 Person Constructs A Person construct is an element that describes a person, corporation, or similarentity.entity (hereafter, 'person'). Person constructs MAY be extended by namespace-qualified element children. This specification assigns no significance to the order of appearance of the child elements in a Person construct. atomPersonConstruct = atomCommonAttributes, (element atom:name { text } & element atom:uri { atomUri }? & element atom:email { atomEmailAddress }?) 3.2.1 The "atom:name" Element The "atom:name" element's content conveys a human-readable name for the person. The content of atom:name is language sensitive. Person constructs MUST contain exactly one "atom:name" element. 3.2.2 The "atom:uri" Element The "atom:uri" element's content conveysa URIan IRI associated with the person. Person constructs MAY contain an atom:uri element, but MUST NOT contain more than one. The content of atom:uri in a Person construct MUST bea URIan IRI reference[RFC3986].[RFC3987]. xml:base [W3C.REC-xmlbase-20010627] processing MUST be applied to the atom:uri element's content.Nottingham & Sayre Expires July 27, 2005 [Page 10] Internet-Draft Atom Format January 20053.2.3 The "atom:email" Element The "atom:email" element's content conveys an e-mail address associated with thepersons.person. Person constructs MAY contain an atom:email element, but MUST NOT contain more than one. Its content MUSTbe an e-mail addressconform to the addr-spec BNF rule in [RFC2822]. 3.3 Date Constructs A Date construct is an element whose content MUST conform to the date-time BNF rule in [RFC3339]. I.e., the content of this element matches this regular expression: Nottingham & Sayre Expires September 13, 2005 [Page 11] Internet-Draft Atom Format March 2005 [0-9]{8}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]+) ?(Z|[\+\-][0-9]{2}:[0-9]{2}) As a result, the date values conform to the following specifications: [RFC3339], [W3C.REC-xmlschema-2-20041028], [W3C.NOTE-datetime-19980827], and [ISO.8601.1988]. atomDateConstruct = atomCommonAttributes, xsd:dateTime3.4 Service Constructs A Service construct is an emptyNottingham & Sayre Expires September 13, 2005 [Page 12] Internet-Draft Atom Format March 2005 4. Atom Element Definitions 4.1 Container Elements 4.1.1 The "atom:feed" Element [[anchor21: Substantially changed from format-05, review carefully.]] The "atom:feed" elementthat conveysis theURIdocument (i.e., top-level) element of an AtomPublishing Protocol [Atom-protocol] serviceFeed Document, acting as a container for metadata and data associated withan entrythe feed. Its element children consist of one or more metadata elements followed by zero or more atom:entry child elements. This specification assigns no significance to the order of atom:entry elements within the feed.atomServiceConstructatomFeed =atomCommonAttributes, attribute hrefelement atom:feed {atomUri } 3.4.1 The "href" AttributeatomCommonAttributes, (atomAuthor? & atomCategory* & atomContributor* & atomCopyright? & atomGenerator? & atomIcon? & atomId? & atomImage? & atomLink+ & atomSubtitle? & atomTitle & atomUpdated & anyElement* ), atomEntry* } The"href" attribute contains the a URI of the service. atom:servicefollowing child elementsMUST have a "href" attribute, whose value MUST be a URI reference [RFC3986]. xml:base processing MUST be applied to the "href" attribute. 3.5 Identity Constructs An Identity construct is an element whose content conveys a permanent, universally unique identifier for the construct's parent. Its content MUST be a URI, asare defined by[RFC3986]. Notethis specification (note that thedefinitionpresence of"URI" excludes relative references. When an Atom documentsome of these elements isrelocated, migrated, syndicated, republished, exported or imported, the contentrequired): o atom:feed elements MUST contain exactly one atom:author element, UNLESS all ofits Identity constructthe atom:feed element's child atom:entry elements contain an atom:author element. atom:feed elements MUST NOTchange. Put another way, an Identity constructcontain more than one atom:author element. [[anchor22: inheritance]] o atom:feed elements MAY contain any number of atom:category elements. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page11]13] Internet-Draft Atom FormatJanuaryMarch 2005pertains to all instantiations of a particular Atom entry or feed; revisions retain the same content in their Identity constructs. atomIdentityConstruct = atomCommonAttributes, (atomUri) 3.5.1 Dereferencing Identity Constructs The content of an Identity constructo atom:feed elements MAYbe dereferencable (e.g. an HTTP URI). However, processorscontain any number of atom:contributor elements. o atom:feed elements MUST NOTassume it to be dereferencable. The content of an Identity constructcontain more than one atom:copyright element. o atom:feed elements MUSTbe created in a way that assures uniqueness, and it is suggested that the Identity construct be stored along with the associated resource. Because of the risk of confusion between URIs that would be equivalent if dereferenced, the following normalization strategy is strongly encouraged when generating Identity constructs: o Provide the scheme in lowercase characters. o Provide the host, if any, in lowercase characters.NOT contain more than one atom:generator element. oOnly perform percent-encoding where it is essential.atom:feed elements MUST NOT contain more than one atom:icon element. oUse uppercase A-through-F characters when percent-encoding.atom:feed elements MUST NOT contain more than one atom:image element. oPrevent dot-segments appearing in paths.atom:feed elements MUST NOT contain more than one atom:id element. oFor schemes that defineatom:feed elements MUST contain at least one atom:link element with adefault authority, use an empty authority if the default is desired.relation of "alternate". oFor schemes that define an empty path to be equivalent toatom:feed elements SHOULD contain one atom:link element with apathrel attribute value of"/", use "/". o For schemes that define"self" and SHOULD contain aport, usehref attribute with anempty port ifabsolute URI as its value. This URI identifies thedefault is desired. o Preserve empty fragment identifiersfeed andqueries. o Ensure that all portions of the URI are UTF-8 encoded NFC form Unicode strings. 3.5.2 Comparing Identity Constructs Instances of Identity constructs can be compareda representation equivalent todetermine whether an entry or feed isthesame as one seen before. Processorsfeed. o atom:feed elements MUSTcompare Identity constructs on a character-by-character basis in a case-sensitive fashion. AsNOT contain more than one atom:link element with aresult, two URIsrel attribute value of "alternate" thatresolve tohas the sameresource but are not character-for-character identical will be considered different for the purposes of Identifier comparison. Nottingham & Sayre Expires July 27, 2005 [Page 12] Internet-Draft Atom Format January 2005 For example, "http://www.example.org/thing", "http://www.example.org/Thing", "http://www.EXAMPLE.org/thing" and "HTTP://www.example.org/thing" will all be considered different identifiers, despite their differences in case. Likewise, "http://www.example.com/~bob", "http://www.example.com/%7ebob" and "http://www.example.com/%7Ebob" will all be considered different identifiers, because URI %-escaping is significant fortype attribute value. If a feed's atom:link element with type="alternate" resolves to an HTML document, then that document SHOULD have a autodiscovery link element [Atom-autodiscovery] that reflects back to thepurposes of comparison. Nottingham & Sayre Expires July 27, 2005 [Page 13] Internet-Draft Atom Format January 2005 4. Element Definitions 4.1feed. atom:feed elements MAY contain additional atom:link elements beyond those described above. o atom:feed elements MUST NOT contain more than one atom:subtitle element. o atom:feed elements MUST contain exactly one atom:title element. o atom:feed elements MUST contain exactly one atom:updated element. o atom:feed elements MUST NOT contain atom:entry elements with identical atom:id values. 4.1.2 The"atom:feed""atom:entry" Element The"atom:feed" element is the document (i.e., top-level)"atom:entry" elementofrepresents anAtom Feed Document,individual entry, acting as a container for metadata and data associated with thefeed. Its firstentry. This element can appear as a childMUST be atom:head, which MAY be followed zeroof the atom:feed element, ormoreit can appear as the document (i.e., top-level) element of a standalone Atom Entry Document. The atom:entry element MAY contain any namespace-qualified [W3C.REC-xml-names-19990114] elements as children. This specification assigns no significance to the order of appearance of the childelements. atomFeedelements of atom:entry. Nottingham & Sayre Expires September 13, 2005 [Page 14] Internet-Draft Atom Format March 2005 atomEntry = elementatom:feedatom:entry { atomCommonAttributes,atomVersionAttribute, (atomHead(atomAuthor? &atomEntry*atomCategory* &anyElement*) } 4.1.1 The "version" Attribute atom:feed elements MUST have a "version" attribute whose content indicates the version of the Atom specification that the feed conforms to. The content of this attribute is unstructured text. The version identifier for this specification is "draft-ietf-atompub-format-05: do not deploy". atomVersionAttribute = attribute version {"draft-ietf-atompub-format-05 : do not deploy"} 4.2 The "atom:head" Element The atom:head element acts as a container for metadata about the feed itself. The atom:head element MAY contain any namespace-qualified [W3C.REC-xml-names-19990114] elements as children. This specification assigns no significance to the order of appearance of the child elements of atom:head. Nottingham & Sayre Expires July 27, 2005 [Page 14] Internet-Draft Atom Format January 2005 atomHead = element atom:head { atomCommonAttributes, (atomTitle & atomUpdated & atomLink+ & atomId? & atomAuthor?atomContent? & atomContributor* &atomTagline?atomCopyright? &atomGenerator?atomId &atomInfo?atomLink* &atomCopyright?atomPublished? &atomCategory*atomSourceFeed? &atomIntrospection?atomSummary? & atomTitle &atomPost?atomUpdated & anyElement*) } The following child elements are defined by this specification (note that it requires the presence of some of these elements): o atom:entry elements MUST contain exactly one atom:author element, unless, in an Atom Feed Document, the atom:feed element contains an atom:author element itself. atom:entry elements MUST NOT contain more than one atom:author element. [[anchor24: What if there's a source-feed element? This isrequired):busted. We should make author required for atom:feed and optional for atom:entry. No inheritance co-constraints required. --R. Sayre]] oatom:headatom:entry elements MAY contain any number of atom:category elements. o atom:entry elements MAY contain any number of atom:contributor elements. o atom:entry elements MUST NOT contain more than one atom:copyright element. o atom:entry elements MUST contain exactly oneatom:titleatom:id element. oatom:headatom:entry elements that contain no child atom:content element MUST contain at least one atom:link element with a rel attribute value of "alternate".o atom:head[[anchor25: "atom:entry elements MUST NOT contain more than one atom:link element with a rel attribute value of "alternate" that has the same type attributevalue. If a feed's atom:link element with type="alternate" resolves to an HTML document, then that document SHOULD have a autodiscovery link element [Atom-autodiscovery] that reflects back to the feed. atom:headvalue." This requirement predates @hreflang. Keep it? --R. Sayre]] atom:entry elements MAY contain additional atom:link elements beyond those described above. oatom:headatom:entry elements MUST NOT containexactlymore than oneatom:author element, UNLESS all of the atom:feed element's child atom:entry elements contain an atom:author element. atom:head elements MUST NOT contain more than one atom:author element. [[inheritance]] o atom:head elements MUST NOT contain more than one an atom:contributor element. o atom:head elements MUST NOT contain more than one an atom:copyright element. o atom:head elements MUST NOT contain more than one an atom:id element. o atom:head elements MUST contain exactly one atom:updatedatom:published element. oatom:head elements MAY contain any number of atom:category elements. o atom:headatom:entry elements MUST NOT contain more than oneatom:postatom:source-feed element. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 15] Internet-Draft Atom FormatJanuaryMarch 2005 oatom:headatom:entry elements MUSTNOTcontainmore than one atom:introspectionan atom:summary element in any of the following cases: [[anchor26: Do these requirements reflect the WG's decisions? --R. Sayre]] * the atom:entry element contains no atom:content element. [[anchor27: Net result: Atom entries MUST have an atom:summary or an atom:content element.]] * the atom:entry contains an atom:content that has a "src" attribute (and is thus empty). * the atom:entry contains content that is encoded in Base64; i.e. the "type" attribute of atom:content is a MIME media type [RFC2045] and does not begin with "text/" nor end with "+xml". oatom:headatom:entry elements MUST NOT contain more than oneatom:taglineatom:summary element. oatom:headatom:entry elements MUSTNOT contain more thanhave exactly oneatom:generator"atom:title" element. oatom:headatom:entry elements MUSTNOTcontainmore thanexactly oneatom:infoatom:updated element.4.2.1 Usage4.1.3 The "atom:content" Element The "atom:content" element either contains or links to the content of"atom:head" within "atom:entry" In this case,theatom:head element acts as a containerentry. Except formetadata about the feed within whichtheentry was created. If an atom:entry is copied into one feed from another feed, then"type" and "src" attributes, theatom:head elementcontent ofthe source feed SHOULD be inserted into theatom:content is language-sensitive. atom:entryunless the entry, as copied, already contains an atom:head element. If the atom:entry already contains an atom:head, then that atom:head SHOULD be copied without modification. [[ ... example ... ]] 4.3 The "atom:entry" Element The "atom:entry"elements MUST contain zero or one atom:content elements. Nottingham & Sayre Expires September 13, 2005 [Page 16] Internet-Draft Atom Format March 2005 atomInlineTextContent = elementrepresents an individual entry. Thisatom:content { atomCommonAttributes, attribute type { "text" | "html" | atomMediaType }?, (text)* } atomInlineXHTMLContent = elementcan appear asatom:content { atomCommonAttributes, attribute type { "xhtml" | atomMediaType }?, (text|anyElement)* } atomOutOfLineContent = element atom:content { atomCommonAttributes, attribute type { "text" | "html" | "xhtml" | atomMediaType }?, attribute src { atomUri }, empty } atomContent = atomInlineTextContent | atomInlineXHTMLContent | atomOutOfLineContent 4.1.3.1 The "type" attribute atom:content MAY have achild of"type" attribute. When present, theatom:feed element,value MAY be one of "text", "html", or "xhtml". Failing that, itcan appear as the document (i.e., top-level) element ofMUST be astandalone Atom Entry Document. When appearing in anMIME media type [RFC2045] with a discrete top-level type (see Section 5 of [RFC2045]). If the type attribute is not provided, AtomEntry Document, atom:entry elementsProcessors MUSThavebehave as though it were present with a"version"value of "text". 4.1.3.2 The "src" attribute atom:content MAY have a "src" attribute, whosecontent indicates the version of the Atom specification thatvalue MUST be an IRI reference [RFC3987]. If theentry conforms to. The version identifier for this specification"src" attribute is"draft-ietf-atompub-format-05: do not deploy". The atom:entry elementpresent, Atom Processors MAYcontain any namespace-qualified [W3C.REC-xml-names-19990114] elements as children. This specification assigns no significanceuse the IRI to retrieve theorder of appearance ofcontent. If thechild elements of atom:entry."src" Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page16]17] Internet-Draft Atom FormatJanuaryMarch 2005atomEntry = element atom:entry { atomCommonAttributes, atomVersionAttribute?, (atomTitle & atomId & atomLink* & atomUpdated & atomPublished? & atomAuthor? & atomContributor* & atomHost? & atomCopyright? & atomCategory* & atomEdit? & atomSummary? & atomContent? & atomHead? & anyElement*) } The following child elements are defined by this specification (note that it requires the presence of some of these elements): o atom:entry elements MUST have exactly one "atom:title" element. o atom:entry elements MUST contain exactly one atom:id element. o atom:entry elements that contain no childattribute is present, atom:contentelementMUSTcontain at least one atom:link element with a relbe empty. That is to say, the content may be retrievable using "src=" IRI, or it may be contained within atom:content, but not both. If the "src" attributevalue of "alternate". atom:entry elementsis present, the "type" attribute SHOULD be provided and MUSTNOT contain more than one atom:link element withbe arel attributeMIME media type [RFC2045], rather than "text", "html", or "xhtml". The valueof "alternate"is advisory; thathasis to say, upon dereferencing thesameIRI to retrieve the content, if the server providing that content also provides a media type, the server-provided media type is authoritative. If the value of type begins with "text/" or ends with "+xml", the content SHOULD be local; that is to say, no "src" attributevalue. atom:entry elements MAY contain additional atom:link elements beyond those described above. o atom:entry elements MUST contain exactly one atom:updated element. o atom:entry elements MUST NOT contain more than one atom:published element. o atom:entry elements MUST contain exactly one atom:author element, unless, in an Atom Feed Document,should be provided. [[anchor31: J. Reschke: I'm not sure I understand what this is for. It seems to discourage putting XML data out-of-band. Why? ... Explaining theatom:head element contains an atom:author element itself. atom:entry elements MUST NOT contain more than one atom:author element. o atom:entry elements MUST NOT contain more than one atom:contributor element. o atom:entry elements MUST NOT contain more than one atom:host element. o atom:entry elements MUST NOT contain more than one atom:copyright element. o atom:entry elements MAY contain any numberissue instead ofatom:category elements. Nottingham & Sayre Expires July 27, 2005 [Page 17] Internet-Draftjust trying to enforce it may lead to better results...]] 4.1.3.3 Processing Model AtomFormat January 2005 o atom:entry elementsDocuments MUSTcontain an atom:summary element in any ofconform to the followingcases: * the atom:entry element contains norules. Atom Processors MUST interpret atom:contentelement. *according to theatom:entry contains anfirst applicable rule. 1. If the value of "type" is "text", the content of atom:contentwhich hasMUST NOT contain child elements. Such text is intended to be presented to humans in a"src" attribute (andreadable fashion. Thus, Atom Processors MAY display it using normal text rendering techniques such as proportional fonts, white-space collapsing, and justification. 2. If the value of "type" isthus empty). *"html", the content of atom:content MUST NOT contain child elements, and SHOULD be suitable for handling as HTML [W3C.REC-html401-19991224]. The HTML markup must be escaped; for example, "<br>" as "<br>". The HTML markup SHOULD be such that it could validly appear directly within an HTML <DIV> element. Atom Processors that display theatom:entry containscontentwhich is encodedSHOULD use the markup to aid inBase64; i.e.displaying it. 3. If the value of "type"attributeis "xhtml", the content of atom:contentis a MIME media type [RFC2045] and does not begin with "text/" nor end with "+xml". o atom:entry elements MUST NOT contain more than one atom:summary element. o atom:entry elements MUST NOT contain more than one atom:edit element. o atom:entry elementsMUSTNOT contain more than one atom:head element. 4.4 The "atom:title" Element The "atom:title" element is a Text construct that conveysbe ahuman-readable title for an entry or feed. atomTitle =single XHTML div elementatom:title { atomTextConstruct } 4.5 The "atom:id" Element[W3C.REC-xhtml-basic-20001219]. The"atom:id" element is an Identity constructXHTML div MUST contain XHTML text and markup thatconveys a permanent, universally unique identifier forcould validly appear within anentry or feed. atomId = element atom:id { atomIdentityConstruct } 4.6 The "atom:link" ElementXHTML div element. Theatom:link element is an emptyXHTML div elementthat defines a reference from anitself MUST NOT be considered part of the content. AtomDocumentProcessors that display the content MAY use the markup to aid in displaying it. Escaped markup is interpreted as aWeb resource. atomLink = element atom:link { atomCommonAttributes, attribute href { atomUri }, attribute rel { atomNCName | atomUri }?, attribute type { atomMediaType }?, attribute hreflang { atomLanguageTag }?, attribute title {text}?,representation of markup, and MUST NOT be interpreted as markup itself. 4. If the value of "type" ends with "+xml" or "/xml" (case-insensitive), the content of atom:content may include child elements, and SHOULD be suitable for handling as the indicated media type. If the "src" attributelength { text }?, emptyis not provided, this would Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 18] Internet-Draft Atom FormatJanuaryMarch 2005} 4.6.1 The "href" Attribute The "href" attribute containsnormally mean that thelink's URI. Link constructs MUST have a href attribute, whose value MUST be"atom:content" element would contain aURI reference [RFC3986]. xml:base [W3C.REC-xmlbase-20010627] processing MUST be applied tosingle child element which would serve as thehref attribute's content. 4.6.2 The "rel" Attribute Link elements MAY have an "rel" attribute that indicatesroot element of thelink relationXML document of the indicated type. 5. If the"rel" attribute is not present,value of "type" begins with "text/" (case-insensitive), thelink elementcontent of atom:content MUSTbe interpreted as ifNOT contain child elements. 6. For all other values of "type", thelink relation type is "alternate". rel_attribute = segment-nz-nc / URI The valuecontent of"rel"atom:content MUST beeitheraname,valid Base64 encoding [RFC3548], whichis non-empty and does not contain any colon (":") characters, or a URI [RFC3986]. Note that use of a relative reference is not allowed. If a name is given, implementations MUST consider the link relation type towhen decoded SHOULD beequivalent tosuitable for handling as thesame name registered withinindicated media type. In this case, theIANA Registry of Link Relations Section 9, and thuscharacters in theURI that wouldBase64 encoding may beobtained by appendingpreceded and followed in thevalue ofatom:content element by whitespace, and lines are separated by a single newline (U+000A) character. 4.1.3.4 Examples XHTML inline: ... <content type="xhtml"> <div xmlns="http://www.w3.org/1999/xhtml"> This is <b>XHTML</b> content. </div> </content> ... <content type="xhtml"> <xhtml:div xmlns:xhtml="http://www.w3.org/1999/xhtml"> This is <xhtml:b>XHTML</xhtml:b> content. </xhtml:div> </content> ... The following example assumes that therel attributeXHTML namespace has been bound to thestring "http://www.iana.org/assignments/relation/". The value of "rel" describes the meaning of"xh" prefix earlier in thelink, but does not impose any behavioral requirements on implementations.document: ... <content type="xhtml"> <xh:div> Thisdocument defines two initial values for the Registry of Link Relations:is <xh:b>XHTML</xh:b> content. </xh:div> </content> ... 4.2 Metadata Elements 4.2.1 Thevalue "alternate" signifies"atom:author" Element The "atom:author" element is a Person construct that indicates theURI in the valueauthor of thehrefentry or feed. Nottingham & Sayre Expires September 13, 2005 [Page 19] Internet-Draft Atom Format March 2005 atomAuthor = element atom:author { atomPersonConstruct } 4.2.2 The "atom:category" Element The "atom:category" element conveys information about a category associated with an entry or feed. atomCategory = element atom:category { atomCommonAttributes, attribute term { text }, attribute scheme { atomUri }?, attribute label { text }?, empty } 4.2.2.1 The "term" Attribute The "term" attribute is a string that identifiesan alternate version oftheresource described bycategory to which thecontaining element.entry or feed belongs. Category elements MUST have a "term" attribute. 4.2.2.2 Thevalue "related" signifies"scheme" Attribute The "scheme" attribute is an IRI thatthe URIidentifies a categorization scheme. Category elements MAY have a "scheme" attribute. 4.2.2.3 The "label" attribute The "label" attribute provides a human-readable label for display inthe valueend-user applications. The content of thehref"label" attributeidentifiesis language-sensitive. Category elements MAY have aresource related"label" attribute. 4.2.3 The "atom:contributor" Element The "atom:contributor" element is a Person construct that indicates a person or other entity who contributed to theresource described by the containing atom:feedentry oratom:entry element. For example, the feed forfeed. atomContributor = element atom:contributor { atomPersonConstruct } 4.2.4 The "atom:copyright Element The "atom:copyright" element is asite which discusses the performance of the search engine at "http://search.example.com" might contain, asText construct that conveys achild of atom:head: <link rel="related" href="http://search.example.com/">human-readable copyright statement for an entry or feed. atomCopyright = element atom:copyright { atomTextContstruct } Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page19]20] Internet-Draft Atom FormatJanuaryMarch 2005An identical link might appear as a child of any atom:entry whose content contains a discussion of that same search engine. 4.6.3The"type" Attribute Link elements MAY have a type attribute, whose value MUST conformatom:copyright element SHOULD NOT be used tothe syntax of a MIME media type [RFC2045]. The type attribute's value isconvey machine-readable licensing information. If anadvisory media type; it is a hint aboutatom:entry element does not contain an atom:copyright element, then thetypeatom:copyright element of therepresentation whichcontaining atom:feed element's atom:head element, if present, isexpectedconsidered to apply tobe returned when the value of the href attribute is dereferenced. Note that the type attribute does not override the actual media type returned withtherepresentation. 4.6.4entry. 4.2.5 The"hreflang" Attribute"atom:generator" Element The"hreflang" attribute's"atom:generator" element's contentdescribes the language of the resource pointed to byidentifies thehref attribute. Whenagent usedtogether with the rel="alternate", it impliesto generate atranslatedfeed, for debugging and other purposes. atomGenerator = element atom:generator { atomCommonAttributes, attribute uri { atomUri }?, attribute version { text }?, text } The content ofthe entry. Link elements MAY have an hreflang attribute, whose valuethis element, when present, MUST be alanguage tag [RFC3066]. 4.6.5 The "title" Attribute The "title" attribute conveysstring that is a human-readableinformation about the link. Link elementsname for the generating agent. The atom:generator element MAY have atitle attribute. 4.6.6 The "length" Attribute The "length""uri" attributeindicateswhose value MUST be anadvisory length of the linked content in octets; it isIRI reference [RFC3987]. When dereferenced, that IRI SHOULD produce ahint about the content length of therepresentationreturned when the URI in the href attributethat isdereferenced. Noterelevant to thatthe lengthagent. The atom:generator element MAY have a "version" attributedoes not overridethat indicates theactual content lengthversion of therepresentation as reported by the underlying protocol. Link elements MAY have a length attribute. 4.7generating agent. When present, its value is unstructured text. 4.2.6 The"atom:updated""atom:icon" Element The"atom:updated" element"atom:icon" element's content isa Date construct indicating the most recent instant in time whenanentry or feed was modified inIRI [RFC3987] which identifies an image which provides iconic visual identification for away the producer considers significant. Therefore, not all modifications necessarily result infeed. The image SHOULD have an aspect ratio of one (horizontal) to one (vertical), and should be suitable for presentation at a small size. atomIcon = element atom:icon { atomCommonAttributes, (atomUri) } 4.2.7 The "atom:id" Element [[anchor45: Substantially changedatom:updated value. Publishers MAY change the value of thisfrom format-05, review carefully]] The "atom:id" elementover time. Processors MAY present entries sorted using this value. Processors MAY choose not to present entries until the instant in time specifiedconveys a permanent, universally unique Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page20]21] Internet-Draft AtomFormat January 2005 inFormat March 2005 identifier for an entry or feed. atomId = element atom:id { atomCommonAttributes, (atomUri) } Its content MUST be an IRI, as defined by [RFC3987]. Note that the definition of "IRI" excludes relative references. Though the IRI might use a dereferencable scheme, Atom Processors MUST NOT assume it can be dereferenced. When an Atom document is relocated, migrated, syndicated, republished, exported or imported, theatom:updated element has passed. atomUpdated =content of its atom:id elementatom:updated { atomDateConstruct } 4.8 The "atom:published" Element The "atom:published"MUST NOT change. Put another way, an atom:id elementispertains to all instantiations of aDate construct indicating an instantparticular Atom entry or feed; revisions retain the same content intime associated withtheir atom:id elements. The content of anevent earlyatom:id element MUST be created in a way that assures uniqueness; it is suggested that thelife cycle of the entry. Typically, atom:published willatom:id element beassociatedstored along with theinitial creation or first availabilityassociated resource. Because of theresource. Processors MAY present entries sorted using this value. Processors MAY choose not to present entries untilrisk of confusion between IRIs that would be equivalent if dereferenced, theinstantfollowing normalization strategy is strongly encouraged when generating atom:id elements: o Provide the scheme intime specifiedlowercase characters. o Provide the host, if any, in lowercase characters. o Only perform percent-encoding where it is essential. o Use uppercase A-through-F characters when percent-encoding. o Prevent dot-segments appearing in paths. o For schemes that define a default authority, use an empty authority if theatom:published element has passed. 4.9 The "atom:author" Element The "atom:author" elementdefault is desired. o For schemes that define an empty path to be equivalent to aPerson constructpath of "/", use "/". o For schemes thatindicatesdefine a port, use an empty port if the defaultauthoris desired. o Preserve empty fragment identifiers and queries. o Ensure that all components of the IRI are appropriately character-normalized, e.g. by using NFC or NFKC. 4.2.7.1 Comparing atom:id Instances of atom:id elements can be compared to determine whether an entry or feedatomAuthor = element atom:author { atomPersonConstruct } 4.10 The "atom:contributor" Element The "atom:contributor" elementisa Person construct that indicates a person or other entity who contributes totheentry. atomContributor = element atom:contributor { atomPersonConstruct } 4.11 The "atom:host" Element The "atom:host" element's content conveys a domain name or network address associated with an entry's origin. Its contentsame as one seen before. Processors MUSTbe a domain name [RFC1035], a dotted-decimal IPv4 address [RFC0791], or a colon-delimited IPv6 address [RFC2460]. 4.12 The "atom:copyright" Element The "atom:copyright" element iscompare atom:id elements on aText construct that conveyscharacter-by-character basis (in ahuman-readable copyright statement for an entry or feed. The atom:copyright element SHOULD NOTcase-sensitive fashion). Comparison operations MUST beused to conveybased solely on the IRI character strings, and MUST NOT rely on dereferencing the IRIs. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page21]22] Internet-Draft Atom FormatJanuaryMarch 2005machine-readable licensing information. If an atom:entry element does not contain an atom:copyright element, then the atom:copyright element of the containing atom:feed element's atom:head element, if present, should be considered to apply to the entry. 4.13 The "atom:category" Element Category elements contain information about a category to which an Atom feed or entry is associated. atomCategory = element atom:category { atomCommonAttributes, attribute term { text }, attribute scheme { atomUri }?, attribute label { text }?, empty } 4.13.1 The "term" Attribute The "term" attribute is a string which identifies the category to which the entry or feed belongs. Category elements MUST have a "term" attribute. 4.13.2 The "scheme" Attribute The "scheme" attribute is a URI that identifies a categorization scheme. Category elements MAY have a "scheme" attribute. 4.13.3 The "label" attribute The "label" attribute providesAs ahuman-readable labelresult, two IRIs thatmayresolve to the same resource but are not character-for-character identical will bedisplayedconsidered different for the purposes of identifier comparison. For example: http://www.example.org/thing http://www.example.org/Thing http://www.EXAMPLE.org/thing HTTP://www.example.org/thing are four distinct identifiers, despite their differences inend-user applications. Category elements MAY have a "label" attribute. 4.14case. Likewise, http://www.example.com/~bob http://www.example.com/%7ebob http://www.example.com/%7Ebob are three distinct identifiers, because IRI %-escaping is significant for the purposes of comparison. 4.2.8 The"atom:summary""atom:image" Element The"atom:summary" element"atom:image" element's content is an IRI [RFC3987] which identifies an image which provides visual identification for aText construct that conveys a short summary, abstract or excerpt offeed. The image SHOULD have anentry. atomSummaryaspect ratio of 2 (horizontal) to 1 (vertical). atomImage = elementatom:summaryatom:image {atomTextConstructatomCommonAttributes, (atomUri) }Nottingham & Sayre Expires July 27, 2005 [Page 22] Internet-Draft Atom Format January 2005 4.154.2.9 The"atom:content""atom:link" Element The"atom:content""atom:link" elementeither containsis an empty element that defines a reference from an entry orlinksfeed tothe content of the entry. atom:entry elements MUST contain zero or one atom:content elements. atomInlineTextContenta Web resource. atomLink = elementatom:contentatom:link { atomCommonAttributes, attributetypehref {"TEXT" | "HTML"atomUri }, attribute rel { atomNCName |atomMediaTypeatomUri }?,(text)* } atomInlineXHTMLContent = element atom:content { atomCommonAttributes,attribute type {"XHTML" |atomMediaType }?,(text|anyElement)* } atomOutOfLineContent = element atom:contentattribute hreflang {atomCommonAttributes,atomLanguageTag }?, attributetypetitle {"TEXT" | "HTML" | "XHTML" | atomMediaTypetext }?, attributesrclength {atomUri },text }?, empty Nottingham & Sayre Expires September 13, 2005 [Page 23] Internet-Draft Atom Format March 2005 }atomContent = atomInlineTextContent | atomInlineXHTMLContent | atomOutOfLineContent 4.15.14.2.9.1 The"type""href" Attribute The "href" attribute contains the link's IRI. atom:link elements MUST have a href attribute, whose value MUST be a IRI reference [RFC3987]. xml:base [W3C.REC-xmlbase-20010627] processing MUST be applied to the href attribute's content. 4.2.9.2 The "rel" Attribute atom:link elements MAY have an "rel" attribute that indicates the link relation type. If the "rel" attributeatom:content MAY have a "type" attribute, Whenis not present, thevalue MAYlink element MUST beoneinterpreted as if the link relation type is "alternate". rel_attribute = segment-nz-nc / IRI The value of"TEXT", "HTML", or "XHTML". Failing that, it"rel" MUST be either aMIME medianame that is non-empty and does not contain any colon (":") characters, or a IRI [RFC3987]. Note that use of a relative reference is not allowed. If a name is given, implementations MUST consider the link relation type[RFC2045] in which,tousebe equivalent to the same name registered within theterminologyIANA Registry of Link Relations Section5 of [RFC2045],7, and thus thetop level is a discrete type. IfIRI that would be obtained by appending thetypevalue of the rel attributeis not provided, software MUST behave as though it were present with ato the string "http://www.iana.org/assignments/relation/". The value of"TEXT". 4.15.2"rel" describes the meaning of the link, but does not impose any behavioral requirements on implementations. This document defines five initial values for the Registry of Link Relations: The"src" attribute atom:content MAY have a "src" attribute, whosevalueMUST be a URI reference [RFC3986]. If"alternate" signifies that the"src"IRI in the value of the href attributeis present, software MAY useidentifies an alternate version of theURI to retrieveresource described by thecontent. Ifcontaining element. The value "related" signifies that the"src"IRI in the value of the href attributeisidentifies a resource related to the resource described by the containing element. For example, the feed for a site that discusses the performance of the search engine at "http://search.example.com" might contain, as a child of atom:feed: <link rel="related" href="http://search.example.com/"> An identical link might appear as a child of any atom:entry whose Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page23]24] Internet-Draft Atom FormatJanuaryMarch 2005present, atom:content MUST be empty. That is to say, thecontentmay be retrievable using "src=" URI, or it may be contained within atom:content, but not both. If the "src" attribute is present, the "type" attribute SHOULD be provided and MUST becontains aMIME media type [RFC2045], rather than "TEXT", "HTML", or "XHTML".discussion of that same search engine. The valueis advisory; that is to say, upon dereferencing the URI to retrieve the content, if the server providing"self" signifies thatcontent also provides a media type,theserver-provided media type is authoritative. IfIRI in the value oftype begins with "text/" or ends with "+xml",thecontent SHOULD be local; that is to say, no "src"href attributeshould be provided. 4.15.3 Processing Model Software MUST apply the following rules in the order belowidentifies a resource equivalent toascertain the rules governing the content of "atom:content". 1. Ifthe containing element. The valueis "TEXT","enclosure" signifies that thecontent of atom:content MUST NOT contain child elements. Such text is intended to be presented to humansIRI ina readable fashion. Thus, software MAY display it using normal text rendering techniques such as proportional fonts, white-space collapsing, and justification. 2. Ifthe value of"type" is "HTML",thecontent of atom:content MUST NOT contain child elements, and SHOULD be suitable for handling by software that knows HTML. The HTML markup must be escaped; for example, "<br>" as "<br>". The HTML markup SHOULD be such that it could validly appear directly within an HTML <DIV> element. Receiving softwarehref attribute identifies a related resource whichdisplaysis potentially large in size and may require special handling by consuming software. For Link constructs with rel="enclosure", thecontentlength attribute SHOULDusebe provided. The value "via" signifies that themarkup to aidIRI indisplaying it. 3. Ifthe value of"type"the href attribute identifies a resource that is"XHTML",thecontentsource ofatom:content MAY contain child elements. The content SHOULD be XHTML text and markup that could validly appear directly within an xhtml:div element. Receiving software which displaysthecontent SHOULD useinformation provided in themarkupcontaining element. 4.2.9.3 The "type" Attribute Link elements MAY have a type attribute, whose value MUST conform toaid in displaying it. Escaped markupthe syntax of a MIME media type [RFC2045]. The type attribute's value is an advisory media type; it isinterpreted asatext representationhint about the type ofmarkup, and MUST NOTthe representation that is expected to beinterpreted as markup itself. 4. Ifreturned when the value of"type" endsthe href attribute is dereferenced. Note that the type attribute does not override the actual media type returned with"+xml" or "/xml",the representation. 4.2.9.4 The "hreflang" Attribute The "hreflang" attribute's content describes the language ofatom:content may include child elements, and SHOULD be suitable for handlingthe resource pointed to bysoftware that knowstheindicated media type. Ifhref attribute. When used together with the"src"rel="alternate", it implies a translated version of the entry. Link elements MAY have an hreflang attribute, whose value MUST be a language tag [RFC3066]. 4.2.9.5 The "title" Attribute The "title" attribute conveys human-readable information about the link. The content of the "title" attribute isnot provided, this would normally mean thatlanguage sensitive. Link elements MAY have a title attribute. 4.2.9.6 The "length" Attribute The "length" attribute indicates an advisory length of the"atom:content" element would containlinked content in octets; it is asingle child element which would serve ashint about theroot elementcontent length of theXML document ofrepresentation returned when theindicated type. 5. IfIRI in thevalue of "type" begins with "text/"href attribute is dereferenced. Note that the length attribute does not override the actual content length ofatom:content MUST NOT contain child elements.the representation as reported by the underlying protocol. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page24]25] Internet-Draft Atom FormatJanuaryMarch 20056. For all other values of "type",Link elements MAY have a length attribute. 4.2.10 The "atom:published" Element The "atom:published" element is a Date construct indicating an instant in time associated with an event early in thecontentlife cycle ofatom:content MUSTthe entry. Typically, atom:published will bea valid Base64 encoding [RFC3548], which when decoded SHOULDassociated with the initial creation or first availability of the resource. atomPublished = element atom:published { atomDateConstruct } 4.2.11 The "atom:source-feed" Element If an atom:entry is copied from one feed into another feed, then the source atom:feed's metadata (all child elements of atom:feed other than the atom:entry elements) MAY besuitable for handlingpreserved within the copied entry bysoftware that knowsadding an atom:source-feed child element, if it is not already present in theindicated media type. In this case,entry, and including some or all of thecharacters insource feed's metadata elements as theBase64 encoding mayatom:source-feed element's children. Such metadata SHOULD beprecededpreserved if the source atom:feed contains any of the child elements atom:author, atom:contributor, atom:copyright, or atom:category andfollowedthose child elements are not present in theatom:contentsource atom:entry. atomSourceFeed = element atom:source-feed { atomCommonAttributes, (atomAuthor? & atomCategory* & atomContributor* & atomCopyright? & atomGenerator? & atomIcon? & atomId? & atomImage? & atomLink+ & atomSubtitle? & atomTitle & atomUpdated & anyElement* ) } 4.2.12 The "atom:subtitle" Element The "atom:subtitle" elementby whitespace, and lines are separated byis asingle newline (U+000A) character. 4.16Text construct that conveys a human-readable description or subtitle for a feed. Nottingham & Sayre Expires September 13, 2005 [Page 26] Internet-Draft Atom Format March 2005 atomSubtitle = element atom:subtitle { atomTextConstruct } 4.2.13 The"atom:introspection""atom:summary" Element The"atom:introspection""atom:summary" element is aServiceText construct that conveysthe URIa short summary, abstract or excerpt of anintrospection file associated with a feed. atomIntrospectionentry. atomSummary = elementatom:introspectionatom:summary {atomServiceConstructatomTextConstruct }4.174.2.14 The"atom:post""atom:title" Element The"atom:post""atom:title" element is aServiceText construct that conveysthe URI used to add entries toa human-readable title for an entry or feed.atomPostatomTitle = elementatom:postatom:title {atomServiceConstructatomTextConstruct }4.184.2.15 The"atom:edit""atom:updated" Element The"atom:edit""atom:updated" element is aServiceDate constructthat conveysindicating theURImost recent instant in time when an entry or feed was modified in a way the publisher considers significant. Therefore, not all modifications necessarily result in a changed atom:updated value. atomUpdated = element atom:updated { atomDateConstruct } Publishers MAY change the value of this element over time. Nottingham & Sayre Expires September 13, 2005 [Page 27] Internet-Draft Atom Format March 2005 5. Securing Atom Documents Because Atom is an XML-based format, existing XML security mechanisms can be used toretrieve and editsecure its content. 5.1 Digital Signatures The root of an Atom document (i.e., atom:feed in an Atom Feed Document, atom:entry in an Atom Entry Document) MAY have an Enveloped Signature, as described by XML-Signature and Syntax Processing [W3C.REC-xmldsig-core-20020212]. Processors MUST NOT reject an Atom Document containing such a signature because they are not capable of verifying it; they MUST continue processing and MAY inform the user of their failure to validate thesource representationsignature. In other words, the presence of anentry. atomEdit = element atom:edit { atomServiceConstruct } 4.19 The "atom:tagline" Element The "atom:tagline"elementiswith the namespace IRI "http://www.w3.org/2000/09/xmldsig#" and aText construct that conveyslocal name of "Signature" as ahuman-readable description or tagline forchild of thefeed. atomTagline =document elementatom:tagline { atomTextConstruct } 4.20 The "atom:generator" Elementmust not cause an Atom Processor to fail merely because of its presence. Other elements in an Atom Document MUST NOT be signed unless their definitions explicitly specify such a capability. 5.2 Encryption The"atom:generator" element's content identifiesroot of an Atom Document (i.e., atom:feed in an Atom Feed Document, atom:entry in an Atom Entry Document) MAY be encrypted, using thesoftware agentmechanisms described by XML Encryption Syntax and Processing [W3C.REC-xmlenc-core-20021210]. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page25]28] Internet-Draft Atom FormatJanuaryMarch 2005 6. Extending Atom 6.1 Extensions From Non-Atom Vocabularies This specification describes Atom's XML markup vocabulary. Markup from other vocabularies ("foreign markup") can be used in an Atom document. Note that the atom:content element is designed togenerate a feed, for debuggingsupport the inclusion of arbitrary foreign markup. 6.2 Extensions To the Atom Vocabulary Future versions of this specification may add new elements andother purposes. atomGenerator = element atom:generator { atomCommonAttributes, attribute url { atomUri }?, attributeattributes to the Atom markup vocabulary. Software written to conform to this version{ text }?, text } The contentof the specification will not be able to process such markup correctly and, in fact, will not be able to distinguish it from markup error. For the purposes of this discussion, unrecognized markup from the Atom vocabulary will be considered "foreign "markup". Unlike markup from other vocabularies, foreign markup from the Atom vocabulary MAY appear at any location in an Atom document. 6.3 Software Processing of Foreign Markup Software processing an Atom Document which encounters foreign markup in a location that is legal according to thiselement, when present,specification MUST NOT stop processing or signal an error. It may bea stringthe case that the software isa human-readable name forable to process thegenerating agent. The atom:generator element MAY have a "uri" attribute whose value MUST be a URI reference [RFC3986].foreign markup correctly and does so. Otherwise, such markup is termed "unknown foreign markup". Whendereferenced, that URI SHOULD produce a representation thatunknown foreign markup isrelevantencountered as a child of atom:entry, atom:feed, or a Person Construct, software MAY [[anchor67: Changed tothat agent. The atom:generator elementMAYhave a "version" attribute that indicatesfrom SHOULD. Republishers might want to copy it. --R. Sayre]] bypass theversionmarkup and any textual content and MUST NOT change its behavior as a result of thegenerating agent.markup's presence. Whenpresent, its value is unstructured text. 4.21 The "atom:info" Element The "atom:info" elementunknown foreign markup is encountered in a Textconstruct that conveys a human-readable explanationContruct or atom:content element, software SHOULD ignore the markup and process any text content of foreign elements as though thefeed format itself. The atom:info element SHOULD NOT besurrounding markup were not present. 6.4 Extension Elements Atom allows foreign markup anywhere in an Atom document. Child elements of atom:entry and atom:feed are considered "metadata" elements, and are described below. Child elements of Person Constructs are consideredmeaningful by processors; it is a conveniencetopublishers. atomInfo = element atom:info { atomTextConstruct } Nottingham & Sayre Expires July 27, 2005 [Page 26] Internet-Draft Atom Format January 2005 5. Managing Feed State [[ talk about what it meansapply tokeep a viewthe construct. The role ofa feed ]]other foreign markup is undefined by this specification. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page27]29] Internet-Draft Atom FormatJanuaryMarch 20056. Securing Atom Documents Because Atom is an XML-based format, existing XML security mechanisms can6.4.1 Simple Extension Elements A Simple Extension element MUST NOT have any attributes or child elements. The element MAY contain either character data, or beused to secure its content. 6.1 Digital Signaturesempty. Thedocumentelementof an Atom document (i.e., atom:feed in an Atom Feed Document, atom:entry in an Atom Entry Document) MAY have an Enveloped Signature,can be interpreted asdescribed by XML-Signature and Syntax Processing [W3C.REC-xmldsig-core-20020212]. Processors MUST NOT reject an Atom document containing suchasignature because they are not capablesimple property (or name/value pair) ofverifying it; they MUST continue processing and MAY informtheuserparent element that encloses it. The pair consisting oftheir failure to validate the signature. In other words,thepresencenamespace-URI ofan element withthenamespace URI "http://www.w3.org/2000/09/xmldsig#"element andathe local name of"Signature"the element can be interpreted asa childthe name of the property. The character data content of thedocumentelementmust not cause a processor to fail merely becausecan be interpreted as the value ofits presence. Other elements in an Atom document MUST NOTthe property. If the element is empty, then the property value can besigned unless their definitions explicitly specify such a capability. 6.2 Encryptioninterpreted as an empty string. 6.4.2 Structured Extension Elements Thedocumentroot element ofan Atom document (i.e., atom:feed in an Atom Feed Document, atom:entry in an Atom Entry Document)a Structured Extension element MUST have at least one attribute or child element. It MAY have attributes, it MAY contain well-formed XML content (including character data), or it MAY beencrypted, usingempty. The structure of a Structured Extension element, including the order of its child elements, could be significant. This specification does not provide an interpretation of a Structured Extension element. The syntax of the XML contained in the element, and an interpretation of how the element relates to its containing element is defined by the specification of themechanisms described by XML Encryption Syntax and Processing [W3C.REC-xmlenc-core-20021210]. Nottingham & Sayre Expires July 27, 2005 [Page 28] Internet-Draft Atom Format January 2005 7. Embedding Atom in Other Formats [[ ... ]] Nottingham & Sayre Expires July 27, 2005 [Page 29] Internet-Draft Atom Format January 2005 8. ExtendingAtom[[ ... ]]extension. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 30] Internet-Draft Atom FormatJanuaryMarch 20059.7. IANA Considerations An Atom Document, when serialized as XML 1.0, can be identified with the following media type: MIME media type name: application MIME subtype name: atom+xml Mandatory parameters: None. Optional parameters: "charset": This parameter has identical semantics to the charset parameter of the "application/xml" media type as specified inRFC 3023 [RFC3023].[RFC3023]. Encoding considerations: Identical to those of "application/xml" as described inRFC 3023[RFC3023], section 3.2. Security considerations: As defined in this specification.[[update[[anchor71: update upon publication]] In addition, as this media type uses the "+xml" convention, it shares the same security considerations as described inRFC 3023[RFC3023], section 10. Interoperability considerations: There are no known interoperability issues. Published specification: This specification.[[update[[anchor72: update upon publication]] Applicationswhichthat use this media type: No known applications currently use this media type. Additional information: Magic number(s): As specified for "application/xml" inRFC 3023[RFC3023], section 3.2. File extension: .atom Fragment identifiers: As specified for "application/xml" inRFC 3023[RFC3023], section 5. Base URI: As specified inRFC 3023[RFC3023], section 6. Macintosh File Type code: TEXT Person and email address to contact for further information: Mark Nottingham <mnot@pobox.com> Intended usage: COMMON Author/Change controller: This specification's author(s).[[update[[anchor73: update upon publication]]9.17.1 Registry of Link Relations This registry is maintained by IANA and initially containsthe twofive values:"alternate""alternate", "related", "self", "enclosure", and"related"."via". New assignments are subject to IESG Approval, as outlined in [RFC2434]. Requests should be made by email to IANA, which will then forward the request to the IESG requesting approval. The request should containdiscussion of atNottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 31] Internet-Draft Atom FormatJanuaryMarch 2005 discussion of at least the following five topics: o A value for the "rel" attribute that conforms to the syntax rule given in Section4.6.24.2.9.2 o Common name for link type. o Description of link type semantics. o Expected display characteristics. o Security considerations. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 32] Internet-Draft Atom FormatJanuaryMarch 200510.8. Security Considerations 8.1 HTML and XHTML Content Text Constructs and atom:content allow the delivery of HTML and XHTML to receiving software, which may process it. Many elements in these languages are considered 'unsafe' in that they open clients to one or more types of attack. Implementers of software which processes Atom should carefully consider their handling of every type of element when processing incoming (X)HTML in Atom documents. See the security sections of RFC 2854 and HTML 4.01 for guidance. Atom Processors should pay particular attention to the security of the IMG, SCRIPT, EMBED, OBJECT, FRAME, FRAMESET, IFRAME, META, and LINK elements, but other elements may also have negative security properties. (X)HTML can either directly contain or indirectly reference executable content. 8.2 URIs Atom Processors handle URIs. See Section 7 of [RFC3986]. 8.3 IRIs Atom Processors handle IRIs. See Section 8 of [RFC3987]. 8.4 Encryption and Signing Atom document can be encrypted and signed using [W3C.REC-xmlenc-core-20021210] and [W3C.REC-xmldsig-core-20020212], respectively, and is subject to the security considerations implied by their use. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 33] Internet-Draft Atom FormatJanuaryMarch 200511.9. References11.19.1 Normative References [Atom-autodiscovery] Pilgrim, M., "Atom Feed Autodiscovery", work-in-progress, August 2004.[Atom-protocol] Gregorio, J.[ISO.8601.1988] International Organization for Standardization, "Data elements andR. Sayre, "The Atom Publishing Protocol", work-in-progress, July 2004. [RFC0791] Postel, J., "Internet Protocol", STD 5, RFC 791, September 1981. [RFC1035] Mockapetris, P., "Domain namesinterchange formats -implementationInformation interchange - Representation of dates andspecification", STD 13, RFC 1035, November 1987.times", ISO Standard 8601, June 1988. [RFC2045] Freed, N. and N. Borenstein, "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies", RFC 2045, November 1996. [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.[RFC2460] Deering, S. and R. Hinden, "Internet Protocol, Version 6 (IPv6) Specification", RFC 2460, December 1998.[RFC2822] Resnick, P., "Internet Message Format", RFC 2822, April 2001. [RFC3023] Murata, M., St. Laurent, S. and D. Kohn, "XML Media Types", RFC 3023, January 2001. [RFC3066] Alvestrand, H., "Tags for the Identification of Languages", BCP 47, RFC 3066, January 2001. [RFC3339] Klyne, G. and C. Newman, "Date and Time on the Internet: Timestamps", RFC 3339, July 2002. [RFC3548] Josefsson, S., "The Base16, Base32, and Base64 Data Encodings", RFC 3548, July 2003. [RFC3986] Berners-Lee, T., Fielding, R. and L. Masinter, "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, January 2005. [RFC3987] Duerst, M. and M. Suignard, "Internationalized Resource Identifiers (IRIs)", RFC 3987, January 2005. [W3C.NOTE-datetime-19980827] Wolf, M. and C. Wicksteed, "Date and Time Formats", W3C NOTE NOTE-datetime-19980827, August 1998. [W3C.REC-html401-19991224] Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 34] Internet-Draft Atom FormatJanuaryMarch 2005Wolf, M. and C. Wicksteed, "DateRaggett, D., Hors, A. andTime Formats",I. Jacobs, "HTML 4.01 Specification", W3C REC REC-html401-19991224, December 1999. [W3C.REC-xhtml-basic-20001219] Baker, M., Ishikawa, M., Matsui, S., Stark, P., Wugofski, T. and T. Yamakami, "XHTML Basic", W3CNOTE NOTE-datetime-19980827, August 1998.REC REC-xhtml-basic-20001219, December 2000. [W3C.REC-xml-20040204] Yergeau, F., Paoli, J., Sperberg-McQueen, C., Bray, T. and E. Maler, "Extensible Markup Language (XML) 1.0 (Third Edition)", W3C REC REC-xml-20040204, February 2004.[W3C.REC-xml-infoset-20011024] Tobin, R. and J.[W3C.REC-xml-infoset-20040204] Cowan, J. and R. Tobin, "XML InformationSet",Set (Second Edition)", W3CFirstEdition REC-xml-infoset-20011024, October 2001.REC REC-xml-infoset-20040204, February 2004. [W3C.REC-xml-names-19990114] Hollander, D., Bray, T. and A. Layman, "Namespaces in XML", W3C REC REC-xml-names-19990114, January 1999. [W3C.REC-xmlbase-20010627] Marsh, J., "XML Base", W3C REC REC-xmlbase-20010627, June 2001. [W3C.REC-xmldsig-core-20020212] Solo, D., Reagle, J. and D. Eastlake, "XML-Signature Syntax and Processing", W3C REC REC-xmldsig-core-20020212, February 2002. [W3C.REC-xmlenc-core-20021210] Reagle, J. and D. Eastlake, "XML Encryption Syntax and Processing", W3C REC REC-xmlenc-core-20021210, December 2002.11.2[W3C.REC-xmlschema-2-20041028] Malhotra, A. and P. Biron, "XML Schema Part 2: Datatypes Second Edition", W3C REC REC-xmlschema-2-20041028, October 2004. 9.2 Informative References [RELAX-NG] OASIS Technical Committee: RELAX NG, "RELAX NG Specification", December 2001. Nottingham & Sayre Expires September 13, 2005 [Page 35] Internet-Draft Atom Format March 2005 [RFC2434] Narten, T. and H. Alvestrand, "Guidelines for Writing an IANA Considerations Section in RFCs", BCP 26, RFC 2434, October 1998.Nottingham & Sayre Expires July 27, 2005 [Page 35] Internet-Draft Atom Format January 2005 URIs [1] <http://www.imc.org/atom-syntax/index.html> [2] <http://www.intertwingly.net/wiki/pie/FrontPage>Authors' Addresses Mark Nottingham (editor)EMail:Email: mnot@pobox.com URI: http://www.mnot.net/ Robert Sayre (editor) Boswijck Memex ConsultingEMail:Email: rfsayre@boswijck.com URI: http://boswijck.com Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 36] Internet-Draft Atom FormatJanuaryMarch 2005 Appendix A. Contributors The following people contributed to preliminary drafts of this document: Tim Bray, Mark Pilgrim, and Sam Ruby. Norman Walsh provided the Relax NG schema. The content and concepts within are a product of the Atom community and the Atom Publishing Format and Protocol Working Group. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 37] Internet-Draft Atom FormatJanuaryMarch 2005 Appendix B. Collected RELAX NG Compact Schema This appendix is informative. # -*- Relax NG -*- namespace local = "" namespace atom ="http://purl.org/atom/ns#draft-ietf-atompub-format-04""http://purl.org/atom/ns#draft-ietf-atompub-format-06" namespace s = "http://www.ascc.net/xml/schematron" start = atomFeed | atomEntry### Attribute definitions atomCommonAttributes = attribute xml:base { atomUri }?, attribute xml:lang { atomLanguageTag }?atomVersionAttribute = attribute version {"draft-ietf-atompub-format-05 : do not deploy"} ### Common Atom Constructs atomPlainTextConstruct = atomCommonAttributes, attribute type { "TEXT" | "HTML" }?, text atomXHTMLTextConstruct = atomCommonAttributes, attribute type { "XHTML" }, (text|anyElement)* atomTextConstruct = atomPlainTextConstruct | atomXHTMLTextConstruct atomPersonConstruct = atomCommonAttributes, (element atom:name { text } & element atom:uri { atomUri }? & element atom:email { atomEmailAddress }?) atomDateConstruct = atomCommonAttributes, xsd:dateTimeatomServiceConstruct = atomCommonAttributes,Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 38] Internet-Draft Atom FormatJanuaryMarch 2005attribute href { atomUri } atomIdentityConstruct = atomCommonAttributes, (atomUri)## Container elements # atom:feed # TODO: Test for multiple atom:link/@rel='alternate' with # the same @type The following tests are simple to do, # but my validator is giving me trouble. # TODO: Debug and add them back # Test for at least one atom:link/@rel='alternate' # Test for atom:author or all atom:entry have atom:author # atom:feed atomFeed =element atom:feed { atomCommonAttributes, atomVersionAttribute, (atomHead & atomEntry* & anyElement*) } # atom:head atomHead =[ s:rule [ context ="atom:head""atom:feed" s:assert [ test = "atom:link[@rel='alternate']" "An atom:feed must have at least one link element with a rel attribute of 'alternate'." ] ] s:rule [ context ="atom:head""atom:feed" s:assert [ test = "atom:author or not(../atom:entry[count(atom:author) = 0])" "An atom:feed must have an atom:author unless all of its atom:entry children have an atom:author." ] ] ] elementatom:headatom:feed {Nottingham & Sayre Expires July 27, 2005 [Page 39] Internet-Draft Atom Format January 2005atomCommonAttributes,(atomTitle(atomAuthor? &atomUpdatedatomCategory* &atomLink+atomContributor* &atomId?atomCopyright? &atomAuthor?atomGenerator? &atomContributor*atomIcon? &atomTagline?atomId? &atomGenerator?atomImage? &atomInfo?atomLink+ &atomCopyright?atomSubtitle? &atomCategory*atomTitle &atomIntrospection?atomUpdated &atomPost?anyElement* ), atomEntry* Nottingham &anyElement*)Sayre Expires September 13, 2005 [Page 39] Internet-Draft Atom Format March 2005 } # atom:entry # TODO: Test for multiple atom:link @rel='alternate' # with the same @type # TODO: Test for required atom:summary atomEntry = [ s:rule [ context ="/atom:entry" s:assert [ test = "@version" "The version attribute is required on standalone atom:entry elements." ] ] s:rule [ context ="atom:entry" s:assert [ test = "atom:link[@rel='alternate']" "An atom:entry must have at least one link element with a rel attribute of 'alternate'." ] ] s:rule [ context = "atom:entry" s:assert [ test = "atom:author or ../atom:author" "An atom:entry must have an atom:author if the parent atom:feed does not." ] ]Nottingham & Sayre Expires July 27, 2005 [Page 40] Internet-Draft Atom Format January 2005] element atom:entry { atomCommonAttributes,atomVersionAttribute?, (atomTitle(atomAuthor? &atomId & atomLink* & atomUpdated & atomPublished?atomCategory* &atomAuthor?atomContent? & atomContributor* &atomHost? &atomCopyright? &atomCategory*atomId & atomLink* & atomPublished? &atomEdit?atomSourceFeed? & atomSummary? &atomContent?atomTitle &atomHead?atomUpdated & anyElement*) } Nottingham & Sayre Expires September 13, 2005 [Page 40] Internet-Draft Atom Format March 2005 #atom:title atomTitleatom:content atomInlineTextContent = elementatom:titleatom:content { atomCommonAttributes, attribute type { "text | "html" | atomMediaType }?, (text)* } atomInlineXHTMLContent = element atom:content { atomCommonAttributes, attribute type { "xhtml" | atomMediaType }?, (text|anyElement)* } atomOutOfLineContent = element atom:content { atomCommonAttributes, attribute type {atomTextConstruct"text" | "html" | "xhtml" | atomMediaType }?, attribute src { atomUri }, empty } atomContent = atomInlineTextContent | atomInlineXHTMLContent | atomOutOfLineContent ## Metadata Elements #atom:id atomIdatom:author atomAuthor = elementatom:idatom:author {atomIdentityConstructatomPersonConstruct }atomLink# atom:category atomCategory = elementatom:linkatom:category { atomCommonAttributes, attributehrefterm {atomUritext }, attributerelscheme {atomNCName |atomUri }?, attributetype { atomMediaType }?, attribute hreflang { atomLanguageTag }?, attribute title { text }?, attribute lengthlabel { text }?, empty } #atom:updated # TODO: Test for a timezone that SHOULD be UTC atomUpdated = element atom:updated { atomDateConstruct } # atom:publishedatom:contributor Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 41] Internet-Draft Atom FormatJanuaryMarch 2005atomPublishedatomContributor = elementatom:publishedatom:contributor {atomDateConstructatomPersonConstruct } #atom:author atomAuthoratom:copyright atomCopyright = elementatom:authoratom:copyright {atomPersonConstructatomTextConstruct } #atom:contributor atomContributoratom:generator atomGenerator = elementatom:contributoratom:generator {atomPersonConstructatomCommonAttributes, attribute uri { atomUri }?, attribute version { text }?, text } #atom:hostatom:icon atomIcon = element atom:icon { atomCommonAttributes, (atomUri) } #TODO: tighten this up atomHostatom:id atomId = elementatom:hostatom:id {text} #atom:copyright atomCopyrightatom:image atomImage = elementatom:copyrightatom:image {atomTextConstructatomCommonAttributes, (atomUri) } #atom:category atomCategoryatom:link atomLink = elementatom:categoryatom:link { atomCommonAttributes, attributetermhref {textatomUri }, attributeschemerel { atomNCName | atomUri }?, attributelabeltype { atomMediaType }?, attribute hreflang { atomLanguageTag }?, attribute title { text }?, attribute length { text }?, empty } #atom:summary atomSummaryatom:published atomPublished = elementatom:summaryatom:published {atomTextConstructatomDateConstruct } #atom:content atomInlineTextContent = element atom:content { atomCommonAttributes, attribute type { "TEXT" | "HTML" | atomMediaType }?, (text)* } atomInlineXHTMLContentatom:source-feed atomSourceFeed = elementatom:content { atomCommonAttributes, attribute typeatom:source-feed {"XHTML" | atomMediaType }?, (text|anyElement)* }Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 42] Internet-Draft Atom FormatJanuaryMarch 2005atomOutOfLineContent = element atom:content {atomCommonAttributes,attribute type { "TEXT" | "HTML" | "XHTML" | atomMediaType }?, attribute src { atomUri }, empty } atomContent = atomInlineTextContent | atomInlineXHTMLContent | atomOutOfLineContent # atom:introspection atomIntrospection = element atom:introspection { atomServiceConstruct( atomTitle & atomUpdated & atomLink+ & atomIcon & atomId? & atomImage? & atomSubtitle? & atomAuthor? & atomContributor* & atomCopyright? & atomCategory* & atomGenerator? & anyElement* ) } #atom:post atomPostatom:subtitle atomSubtitle = elementatom:postatom:subtitle {atomServiceConstructatomTextConstruct } #atom:edit atomEditatom:summary atomSummary = elementatom:editatom:summary {atomServiceConstructatomTextConstruct } #atom:tagline atomTaglineatom:title atomTitle = elementatom:taglineatom:title { atomTextConstruct } #atom:generator atomGenerator = element atom:generator { atomCommonAttributes, attribute url { atomUri }?, attribute version { text }?, text }atom:updated #atom:info atomInfoTODO: Test for a timezone that SHOULD be UTC atomUpdated = elementatom:infoatom:updated {atomTextConstructatomDateConstruct }Nottingham & Sayre Expires July 27, 2005 [Page 43] Internet-Draft Atom Format January 2005# Low-level simple types # TODO: can anything more specific be said about these types? atomNCName = xsd:string { minLength = "1" pattern = "[^:]*" } atomMediaType = text atomLanguageTag = text atomUri = text atomEmailAddress = text # Extensibility anyForeignElement = element * - (atom:* | local:*) Nottingham & Sayre Expires September 13, 2005 [Page 43] Internet-Draft Atom Format March 2005 { (attribute * { text } | text | anyForeignElement)* } anyForeignAttribute = attribute * - (atom:* | local:* | xml:*) { text } anyElement = element * - atom:* { (attribute * { text } | text | anyElement)* } # EOF Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page 44] Internet-Draft Atom FormatJanuaryMarch 2005 Appendix C.Revision History [[ thisChange Log [[anchor85: This section should be removed before finalpublication. ]]publication.]] -06: Move Identity Construct into atom:id (only place it's used) atom:id values must be unique within a feed. restore atom:copyright definition mistakenly dropped during alphabetizing. Remove atom:head, add atom:source-feed, and "Extension Construct" text in an effort to accurately reflect WG consensus on data model and extensibility, acknowledging two opinions in favor of atom:head. Note @hreflang issue. Add comment on atom:entry/atom:summary requirements. Rework atom:id text. The dereferencing section didn't talk about dereferencing. Remove protocol reference. Alphabetize where appropriate (PaceOrderSpecAlphabetically). Add mI language (PaceExtendingAtom). Add atom:icon and atom:image (PaceImageAndIcon). Change atom:tagline to atom:subtitle Add inline XHTML language (PaceXHTMLNamespaceDiv). Change "TEXT" etc, to lowercase Change example id IRI to urn:uuid:... Add rel="self" (PaceFeedLink). Add Feed State text (PaceNoFeedState). Move to IRIs (PaceIRI). Add rel="via" (PaceLinkRelVia). Add rel="enclosure" (PaceEnclosuresAndPix). Remove info and host (PaceRemoveInfoAndHost) Clarify order of entries (PaceEntryOrder). Remove version attribute (PaceRemoveVersionAttr). Date format roundup (PaceDatesXSD). Remove Service construct and elements. fix atom:contributor cardinality typo Removed motivation/design principles note; if we haven't come up with them by now... Put conformance text into notational conventions. Removed instances of 'software'; too specific. Added refs to HTML and XHTML. Updated ref to Infoset. Various editorial tweaks. Fix RFC 3023 refs in IANA section Adjust head/link requirement Nottingham & Sayre Expires September 13, 2005 [Page 45] Internet-Draft Atom Format March 2005 fix @version typos -05: Add RNC from N. Walsh. Re-organize element definitions. Lift the prohibition on other types of DSig and encryption. Remove text on "indiscriminate use" of DSig and XMLEnc. -04: Update URI terms for 2396bis. Add Category construct (PaceCategoryRevised). Insert paranoid XHTML interpretation guidelines. Adjust atom:copyright, per chairs' instruction. Add atom:host as child element of atom:entry, per chairs' direction (PacePersonConstruct). Add link/content co-constraint (PaceContentOrLink). Remove atom:origin as a side effect of adding atom:head to atom:entry (PaceHeadInEntry). Add optional length attribute to atom:link (PaceLinkRelated). Add Link registry to Link Construct, IANA Considerations placeholder (PaceFieldingLinks). Change definition of atom:updated (PaceUpdatedDefinition). -03: Move definition of Link @rel to format spec, restrict acceptable values (PaceMoveLinkElement, PaceLinkAttrDefaults). Add Service Construct, head/post, head/introspection, entry/edit (PaceServiceElement). Add Text Construct, entry/content (PaceReformedContent3). Add entry/published (PaceDatePublished). Adjust definition of Identity Construct per chairs' direction to "fix it." Add Sayre to editors. -02: Removed entry/modified, entry/issued, entry/created; added entry/updated (PaceDateUpdated). Changed date construct from W3C date-time to RFC3339 (PaceDateUpdated). Feed links to HTML pages should be reflected back (PaceLinkReflection). Added Identity construct (PaceIdConstruct). Changed feed/id and entry/id to be Identity constructs (PaceIdConstruct). Changed entry/origin's content so that it's the same as the feed's id, rather than its link/@rel="alternate" (PaceIdConstruct). Added "Securing Atom Documents" (PaceDigitalSignatures). -01: Constrained omission of "Information Item" to just elements and attributes. Clarified xml:lang inheritence.Nottingham & Sayre Expires July 27, 2005 [Page 45] Internet-Draft Atom Format January 2005Removed entry- and feed-specific langauge about xml:lang (covered by general discussion of xml:lang) Changed xml:lang to reference XML for normative requirements. Nottingham & Sayre Expires September 13, 2005 [Page 46] Internet-Draft Atom Format March 2005 Changed "... MUST be a string" to "... is unstructued text." Remomved langauge about DOCTYPEs, PIs, Comments, Entities. Changed atom:url to atom:uri, @url to @uri Introduced atom:head Introduced "Atom Feed Document" and "Atom Entry Document". Removed requirement for all elements and attributes to be namespace-qualified; now children of selective elements Added extensibility to Person constructs. Removed requirement for media types to be registered (non-registered media types are legal) Added atom:origin (PaceEntryOrigin) Added requirement for entry/id to be present and a URI (PaceEntryIdRequired). Clarified approach to Comments, PIs and well-formedness, as per RFC3470. Referenced escaping algorithm in XML. Assorted editorial nits and cleanup, refactoring -00: Initial IETF Internet-Draft submission. Added optional version attribute to entry (PaceEntryElementNeedsVersionAttribute). Added hreflang attribute (PaceHrefLang). Clarified inheritence of copyright element (PaceItemCopyright). Added xml:lang to entries (PaceItemLang). Tweaked Infoset-related language (PaceNoInfoSet). Clarified lack of structure in version attribute (PaceVersionAsText). Changed approach to XML Base (PaceXmlBaseEverywhere). Added XML Base processing to atom:id (PaceXmlBaseId). Various editorial cleanup and adjustments for IETF publication. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page46]47] Internet-Draft Atom FormatJanuaryMarch 2005 Intellectual Property Statement The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79. Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. Disclaimer of Validity This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Copyright Statement Copyright (C) The Internet Society (2005). This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights. Acknowledgment Funding for the RFC Editor function is currently provided by the Internet Society. Nottingham & Sayre ExpiresJuly 27,September 13, 2005 [Page47]48] ----