idnits 2.17.1
draft-snell-atompub-feed-thread-00.txt:
Checking boilerplate required by RFC 5378 and the IETF Trust (see
https://trustee.ietf.org/license-info):
----------------------------------------------------------------------------
** It looks like you're using RFC 3978 boilerplate. You should update this
to the boilerplate described in the IETF Trust License Policy document
(see https://trustee.ietf.org/license-info), which is required now.
-- Found old boilerplate from RFC 3978, Section 5.1 on line 14.
-- Found old boilerplate from RFC 3978, Section 5.5 on line 334.
-- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 311.
-- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 318.
-- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 324.
** This document has an original RFC 3978 Section 5.4 Copyright Line,
instead of the newer IETF Trust Copyright according to RFC 4748.
** This document has an original RFC 3978 Section 5.5 Disclaimer, instead
of the newer disclaimer which includes the IETF Trust according to RFC
4748.
Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt:
----------------------------------------------------------------------------
== No 'Intended status' indicated for this document; assuming Proposed
Standard
Checking nits according to https://www.ietf.org/id-info/checklist :
----------------------------------------------------------------------------
** The document seems to lack separate sections for Informative/Normative
References. All references will be assumed normative when checking for
downward references.
Miscellaneous warnings:
----------------------------------------------------------------------------
== The copyright year in the RFC 3978 Section 5.4 Copyright Line does not
match the current year
== Line 188 has weird spacing: '...ment or other...'
-- The document seems to lack a disclaimer for pre-RFC5378 work, but may
have content which was first submitted before 10 November 2008. If you
have contacted all the original authors and they are all willing to grant
the BCP78 rights to the IETF Trust, then this is fine, and you can ignore
this comment. If not, you may need to add the pre-RFC5378 disclaimer.
(See the Legal Provisions document at
https://trustee.ietf.org/license-info for more information.)
-- The document date (July 2005) is 6852 days in the past. Is this
intentional?
Checking references for intended status: Proposed Standard
----------------------------------------------------------------------------
(See RFCs 3967 and 4897 for information about using normative references
to lower-maturity documents in RFCs)
== Outdated reference: A later version (-11) exists of
draft-ietf-atompub-format-10
Summary: 4 errors (**), 0 flaws (~~), 4 warnings (==), 7 comments (--).
Run idnits with the --verbose option for more detailed information about
the items above.
--------------------------------------------------------------------------------
2 Network Working Group J. Snell
3 Internet-Draft July 2005
4 Expires: January 2, 2006
6 Feed Thread: Enabling Threaded Entries in Atom
7 draft-snell-atompub-feed-thread-00.txt
9 Status of this Memo
11 By submitting this Internet-Draft, each author represents that any
12 applicable patent or other IPR claims of which he or she is aware
13 have been or will be disclosed, and any of which he or she becomes
14 aware will be disclosed, in accordance with Section 6 of BCP 79.
16 Internet-Drafts are working documents of the Internet Engineering
17 Task Force (IETF), its areas, and its working groups. Note that
18 other groups may also distribute working documents as Internet-
19 Drafts.
21 Internet-Drafts are draft documents valid for a maximum of six months
22 and may be updated, replaced, or obsoleted by other documents at any
23 time. It is inappropriate to use Internet-Drafts as reference
24 material or to cite them other than as "work in progress."
26 The list of current Internet-Drafts can be accessed at
27 http://www.ietf.org/ietf/1id-abstracts.txt.
29 The list of Internet-Draft Shadow Directories can be accessed at
30 http://www.ietf.org/shadow.html.
32 This Internet-Draft will expire on January 2, 2006.
34 Copyright Notice
36 Copyright (C) The Internet Society (2005).
38 Abstract
40 This memo presents a mechanism that allows feeds publishers to
41 express threading relationships between entries and feeds.
43 Table of Contents
45 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
46 2. Notational Conventions . . . . . . . . . . . . . . . . . . . . 3
47 3. The 'in-reply-to' extension element . . . . . . . . . . . . . 3
48 4. The 'replies' link relation . . . . . . . . . . . . . . . . . 5
49 5. Security Considerations . . . . . . . . . . . . . . . . . . . 7
50 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 7
51 7. References . . . . . . . . . . . . . . . . . . . . . . . . . . 7
52 Author's Address . . . . . . . . . . . . . . . . . . . . . . . 7
53 A. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 8
54 Intellectual Property and Copyright Statements . . . . . . . . 9
56 1. Introduction
58 This document specifies a mechanism that allows the expression of
59 threaded discussions within the Atom Syndication Format ([I-D.ietf-
60 atompub-format]).
62 2. Notational Conventions
64 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
65 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
66 document are to be interpreted as described in BCP 14, [RFC2119], as
67 scoped to those conformance targets.
69 In this specification, "entry" refers to an atom:entry element.
71 In this specification, "feed" refers to an Atom Feed Document.
73 In this specification, "head section" refers to the children of a
74 feed's document-wide metadata container; e.g., the child elements of
75 the atom:feed element in an Atom Feed Document.
77 In this specification, "link" refers to the atom:link element.
79 In this specification, "link relation" refers to the value of the
80 atom:link element's rel attribute.
82 In this specification, the term "extension element" refers to a
83 structured extension element as described in [I-D.ietf-atompub-
84 format].
86 This specification uses XML Namespaces [W3C.REC-xml-names-19990114]
87 to uniquely identify XML element names. It uses the following
88 namespace prefix for the indicated namespace URI;
89 "thr": "http://purl.org/syndication/thread/1.0"
91 This specification uses terms from the XML Infoset [W3C.REC-xml-
92 infoset-20040204]. However, this specification uses a shorthand; the
93 phrase "Information Item" is omitted when naming Element Information
94 Items. Therefore, when this specification uses the term "element,"
95 it is referring to an Element Information Item in Infoset terms.
97 3. The 'in-reply-to' extension element
99 The 'in-reply-to' extension element is used to indicate that an atom:
100 entry is a response to another resource. The element must take one
101 of two forms as described by the inReplyToDereferenceable and
102 inReplyToNonDereferenceable constructs defined below.
104 inReplyToDereferenceable = element thr:in-reply-to {
105 atomCommonAttributes,
106 attribute href { atomURI },
107 attribute type { atomMediatype }?
108 }
110 inReplyToNonDereferenceable = element thr:in-reply-to {
111 atomCommonAttributes,
112 attribute idref { atomURI },
113 attribute type { atomMediaType }?,
114 attribute source { atomURI}?
115 }
117 In the inReplyToDereferenceable form, the href attribute MUST specify
118 a dereferenceable URI that may be used to locate the entity that the
119 containing Atom Entry is a response to. The type attribute MAY be
120 used to indicate the media type of the entity specified by the href
121 attribute.
123 In the inReplyToNonDereferenceable form, the idref attribute MUST
124 specify a nondereferenceable URI that uniquely identifies the entity
125 that the containing Atom Entry is a response to. The type attribute
126 MAY be used to indicate the media type of the entity identified by
127 the id attribute. The source attribute MAY be used to specify a
128 dereferenceable URI identifying the source of the entity being
129 responded to.
131 o atom:entry elements MAY contain any number of 'in-reply-to'
132 extension elements.
133 o atom:entry elements MUST NOT contain more than one 'in-reply-to'
134 extension element having the same 'type' and 'href' attribute or
135 'type' and 'idref' attribute values.
136 o atom:feed elements MAY contain any number of 'in-reply-to'
137 extension elements.
138 o atom:feed elements MUST NOT contain more than one 'in-reply-to'
139 extension elements having the same 'type' and 'href' attribute or
140 'type' and 'idref' attribute values.
141 o atom:source elements MAY contain any number of 'in-reply-to'
142 extension elements.
143 o atom:source elements MUST NOT contain more than one 'in-reply-to'
144 extension element having the same 'type' and 'href' attribute or
145 'type' and 'idref' attribute values.
146 o If an atom:entry element does not contain any 'in-reply-to'
147 extension elements, any 'in-reply-to' extension elements of the
148 contained atom:source are considered to apply
149 o In an Atom Feed Document, if an atom:entry element or a contained
150 atom:source element do not contain any 'in-reply-to' extension
151 elements, any 'in-reply-to' extension elements in the feed head
152 section are considered to apply.
154 For example
155
156 http://www.example.com/myfeed
157 My Example Feed
158 2005-07-28T12:00:00Z
159
160 James
161
162 tag:entries.com,2005:1
163 My original entry
164
165 This is my original entry
166
167
168 tag:entries.com,2005:1,1
169 A response to the original
170
171
175 This is a response to the original entry
176
177
179 The behavior of 'in-reply-to' extension elements with type attributes
180 specifying any media type other than "application/atom+xml" is
181 undefined. Software written to conform to this version of the
182 specification will not be guaranteed to process such links correctly.
184 4. The 'replies' link relation
186 While responses to entries MAY appear within the same feed as the
187 entry being responded to, it is common practice to separate responses
188 into a separate feed document or other resource. In such cases, it
189 is helpful for an atom:feed or atom:entry to indicate the location of
190 a resource where responses may be found. For this purpose, the
191 'replies' link relation is used.
193 The type attribute of the 'replies' link relation indicates the type
194 of resource containing the responses. A value of 'application/
195 atom+xml' indicates that the resource identified by the link's href
196 attribute is either an Atom Feed Document or an Atom Entry Document
197 that MAY contain one or more 'in-reply-to' link relations. If the
198 type attribute is omitted, it's value is assumed to be "application/
199 atom+xml".
201 o atom:entry elements MAY contain any number of 'replies' link
202 relations.
203 o atom:entry elements MUST NOT contain more than one 'replies' link
204 relation having the same 'type' and 'href' attribute values.
205 o atom:feed elements MAY contain any number of 'replies' link
206 relations.
207 o atom:feed elements MUST NOT contain more than one 'replies' link
208 relation having the same 'type' and 'href' attribute values.
209 o atom:source elements MAY contain any number of 'replies' link
210 relations.
211 o atom:source elements MUST NOT contain more than one 'replies' link
212 relation having the same 'type' and 'href' attribute values.
213 o If an atom:entry element does not contain any 'replies' link
214 relations, any 'replies' link relations of the contained atom:
215 source are considered to apply
216 o In an Atom Feed Document, if an atom:entry element or a contained
217 atom:source element do not contain any 'replies' link relations,
218 any 'replies' link relations in the feed head section are
219 considered to apply.
221 The presence of a 'replies' link relation is merely a hint as to
222 where responses to entries MAY be found and does not guarantee that
223 the referenced resource contains any 'in-reply-to' link relations or
224 responses to any entries within the containing feed.
226 For example, replies contained in a separate Atom feed
227
228 http://www.example.com/myfeed
229 My Example Feed
230 2005-07-28T12:00:00Z
231
232
235 James
236
237 tag:entries.com,2005:1
238 My original entry
239
240 This is my original entry
241
242
244 The behavior of 'replies' link relations specifying any media type
245 other than "application/atom+xml" is undefined. Software written to
246 conform to this version of the specification will not be guaranteed
247 to process such links correctly.
249 5. Security Considerations
251 Feeds using the mechanisms described here could be crafted in such a
252 way as to cause a consumer to initiate excessive (or even an unending
253 sequence of) network requests, causing denial of service (either to
254 the consumer, the target server, and/or intervening networks). This
255 risk can be mitigated by requiring user intervention after a certain
256 number of requests, or by limiting requests either according to a
257 hard limit, or with heuristics.
259 6. IANA Considerations
261 This specification defines one new Atom link relation type to be
262 registered in the IANA Registry of Link Relation as defined by
263 [I-D.ietf-atompub-format].
264 Attribute Value: replies
265 Description: (see section 4)
266 Expected display characteristics: (see section 4)
267 Security considerations: (see section 6)
269 7. References
271 [I-D.ietf-atompub-format]
272 Sayre, R. and M. Nottingham, "The Atom Syndication
273 Format", draft-ietf-atompub-format-10 (work in progress),
274 July 2005.
276 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
277 Requirement Levels", BCP 14, RFC 2119, March 1997.
279 [W3C.REC-xml-infoset-20040204]
280 Tobin, R. and J. Cowan, "XML Information Set (Second
281 Edition)", W3C REC REC-xml-infoset-20040204,
282 February 2004.
284 [W3C.REC-xml-names-19990114]
285 Hollander, D., Bray, T., and A. Layman, "Namespaces in
286 XML", W3C REC REC-xml-names-19990114, January 1999.
288 Author's Address
290 James M Snell
292 Phone:
293 Email: jasnell@gmail.com
294 URI: http://snellspace.com
296 Appendix A. Acknowledgements
298 The author gratefully acknowledges the feedback from the members of
299 Atom Publishing Format and Protocol working group during the
300 development of this specification.
302 Intellectual Property Statement
304 The IETF takes no position regarding the validity or scope of any
305 Intellectual Property Rights or other rights that might be claimed to
306 pertain to the implementation or use of the technology described in
307 this document or the extent to which any license under such rights
308 might or might not be available; nor does it represent that it has
309 made any independent effort to identify any such rights. Information
310 on the procedures with respect to rights in RFC documents can be
311 found in BCP 78 and BCP 79.
313 Copies of IPR disclosures made to the IETF Secretariat and any
314 assurances of licenses to be made available, or the result of an
315 attempt made to obtain a general license or permission for the use of
316 such proprietary rights by implementers or users of this
317 specification can be obtained from the IETF on-line IPR repository at
318 http://www.ietf.org/ipr.
320 The IETF invites any interested party to bring to its attention any
321 copyrights, patents or patent applications, or other proprietary
322 rights that may cover technology that may be required to implement
323 this standard. Please address the information to the IETF at
324 ietf-ipr@ietf.org.
326 Disclaimer of Validity
328 This document and the information contained herein are provided on an
329 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
330 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
331 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
332 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
333 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
334 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
336 Copyright Statement
338 Copyright (C) The Internet Society (2005). This document is subject
339 to the rights, licenses and restrictions contained in BCP 78, and
340 except as set forth therein, the authors retain all their rights.
342 Acknowledgment
344 Funding for the RFC Editor function is currently provided by the
345 Internet Society.