idnits 2.17.1
draft-snell-atompub-feed-thread-03.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 333.
-- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 310.
-- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 317.
-- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 323.
** 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
-- 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 (December 6, 2005) is 6716 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)
No issues found here.
Summary: 4 errors (**), 0 flaws (~~), 2 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 December 6, 2005
4 Expires: June 9, 2006
6 Feed Thread: Enabling Threaded Entries in Atom
7 draft-snell-atompub-feed-thread-03.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 June 9, 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 threaded discussions within the Atom Syndication Format.
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 . . . . . . . . . . . . . . . . . 6
49 5. Security Considerations . . . . . . . . . . . . . . . . . . . 7
50 6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8
51 7. References . . . . . . . . . . . . . . . . . . . . . . . . . . 8
52 Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . 8
53 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 9
54 Intellectual Property and Copyright Statements . . . . . . . . . . 10
56 1. Introduction
58 This document specifies a mechanism that allows the expression of
59 threaded discussions within the Atom Syndication Format ([RFC4287]).
61 2. Notational Conventions
63 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
64 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
65 document are to be interpreted as described in BCP 14, [RFC2119], as
66 scoped to those conformance targets.
68 In this specification, "entry" refers to an atom:entry element.
70 In this specification, "feed" refers to an Atom Feed Document.
72 In this specification, "head section" refers to the children of a
73 feed's document-wide metadata container; e.g., the child elements of
74 the atom:feed element in an Atom Feed Document.
76 In this specification, "link" refers to the atom:link element.
78 In this specification, "link relation" refers to the value of the
79 atom:link element's rel attribute.
81 In this specification, the term "extension element" refers to a
82 structured extension element as described in [RFC4287].
84 This specification uses XML Namespaces [W3C.REC-xml-names-19990114]
85 to uniquely identify XML element names. It uses the following
86 namespace prefix for the indicated namespace URI;
87 "thr": "http://purl.org/syndication/thread/1.0"
89 This specification uses terms from the XML Infoset [W3C.REC-xml-
90 infoset-20040204]. However, this specification uses a shorthand; the
91 phrase "Information Item" is omitted when naming Element Information
92 Items. Therefore, when this specification uses the term "element,"
93 it is referring to an Element Information Item in Infoset terms.
95 3. The 'in-reply-to' extension element
97 The 'in-reply-to' extension element is used to indicate that a feed
98 entry is a response to another resource. The element MUST contain
99 either or both the 'id' and 'href' attributes.
101 in-reply-to = element thr:in-reply-to {
102 atomCommonAttributes,
103 attribute id { atomURI }?,
104 attribute href { atomURI }?
105 }
107 The 'id' attribute specifies the universally unique identifier of the
108 resource being responded to. The value of the attribute MUST conform
109 to the same construction and comparison rules as the atom:id element.
110 The 'href' attribute specifies an IRI that may be used to retrieve a
111 representation of the resource being responded to.
113 o atom:entry elements MAY contain any number of 'in-reply-to'
114 extension elements.
115 o atom:entry elements SHOULD NOT contain more than one 'in-reply-to'
116 extension element having the same 'id' attribute value.
117 o atom:feed elements MAY contain any number of 'in-reply-to'
118 extension elements.
119 o atom:feed elements SHOULD NOT contain more than one 'in-reply-to'
120 extension elements having the same 'id' attribute value.
121 o atom:source elements MAY contain any number of 'in-reply-to'
122 extension elements.
123 o atom:source elements SHOULD NOT contain more than one
124 'in-reply-to' extension element having the same 'id' attribute
125 value.
127 An 'in-reply-to' extension element appearing as a child of an atom:
128 feed element indicates that all of the atom:entry elements contained
129 within that atom:feed are responses to the referenced resource.
131 For example
133
135 http://www.example.com/myfeed
136 My Example Feed
137 2005-07-28T12:00:00Z
138
139 James
140
141 tag:example.com,2005:1
142 My original entry
143
144 This is my original entry
145
146
147 tag:example.com,2005:1,1
148 A response to the original
149
150
152 This is a response to the original entry
153
154
156 When an 'in-reply-to' extension element is used to reference an
157 entity that does not appear within the same Atom document as the
158 entry containing the in-reply-to element, a "related" link relation
159 SHOULD be included that references the same URI as the href
160 attribute.
162 For example
164
166 http://www.example.com/myfeed
167 My Example Feed
168 2005-07-28T12:00:00Z
169
170 James
171
172 tag:example.com,2005:1,1
173 A response to the original
174
175
178
180 This is a response to the original entry
181
182
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.
208 o atom:feed elements MUST NOT contain more than one 'replies' link
209 relation having the same 'type' and 'href' attribute values.
210 o atom:source elements MAY contain any number of 'replies' link
211 relations.
212 o atom:source elements MUST NOT contain more than one 'replies' link
213 relation having the same 'type' and 'href' attribute values.
215 A 'replies' link relation appearing as a child of an atom:feed
216 element indicates that the referenced resource MAY contain responses
217 to any of the atom:feed elements contained atom:entry's. A 'replies'
218 link relation appearing as a child of an atom:entry or atom:source
219 element indicates that the referenced resource MAY contain responses
220 to the containing atom:entry.
222 The presence of a 'replies' link relation is merely a hint as to
223 where responses to entries MAY be found and does not guarantee that
224 the referenced resource contains any 'in-reply-to' link relations or
225 responses to any entries within the containing feed.
227 For example, replies contained in a separate Atom feed
228
229 http://www.example.com/myfeed
230 My Example Feed
231 2005-07-28T12:00:00Z
232
233
236 James
237
238 tag:entries.com,2005:1
239 My original entry
240
241 This is my original entry
242
243
245 The behavior of 'replies' link relations specifying any media type
246 other than "application/atom+xml" is undefined. Software written to
247 conform to this version of the specification will not be guaranteed
248 to process such links correctly.
250 5. Security Considerations
252 Feeds using the mechanisms described here could be crafted in such a
253 way as to cause a consumer to initiate excessive (or even an unending
254 sequence of) network requests, causing denial of service (either to
255 the consumer, the target server, and/or intervening networks). This
256 risk can be mitigated by requiring user intervention after a certain
257 number of requests, or by limiting requests either according to a
258 hard limit, or with heuristics.
260 6. IANA Considerations
262 This specification defines one new Atom link relation type to be
263 registered in the IANA Registry of Link Relation as defined by
264 [RFC4287].
265 Attribute Value: replies
266 Description: (see section 4)
267 Expected display characteristics: (see section 4)
268 Security considerations: (see section 6)
270 7. References
272 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
273 Requirement Levels", BCP 14, RFC 2119, March 1997.
275 [RFC4287] Nottingham, M. and R. Sayre, "The Atom Syndication
276 Format", RFC 4287, December 2005.
278 [W3C.REC-xml-infoset-20040204]
279 Tobin, R. and J. Cowan, "XML Information Set (Second
280 Edition)", W3C REC REC-xml-infoset-20040204,
281 February 2004.
283 [W3C.REC-xml-names-19990114]
284 Hollander, D., Bray, T., and A. Layman, "Namespaces in
285 XML", W3C REC REC-xml-names-19990114, January 1999.
287 Appendix A. Acknowledgements
289 The author gratefully acknowledges the feedback from the members of
290 Atom Publishing Format and Protocol working group during the
291 development of this specification.
293 Author's Address
295 James M Snell
297 Phone:
298 Email: jasnell@gmail.com
299 URI: http://snellspace.com
301 Intellectual Property Statement
303 The IETF takes no position regarding the validity or scope of any
304 Intellectual Property Rights or other rights that might be claimed to
305 pertain to the implementation or use of the technology described in
306 this document or the extent to which any license under such rights
307 might or might not be available; nor does it represent that it has
308 made any independent effort to identify any such rights. Information
309 on the procedures with respect to rights in RFC documents can be
310 found in BCP 78 and BCP 79.
312 Copies of IPR disclosures made to the IETF Secretariat and any
313 assurances of licenses to be made available, or the result of an
314 attempt made to obtain a general license or permission for the use of
315 such proprietary rights by implementers or users of this
316 specification can be obtained from the IETF on-line IPR repository at
317 http://www.ietf.org/ipr.
319 The IETF invites any interested party to bring to its attention any
320 copyrights, patents or patent applications, or other proprietary
321 rights that may cover technology that may be required to implement
322 this standard. Please address the information to the IETF at
323 ietf-ipr@ietf.org.
325 Disclaimer of Validity
327 This document and the information contained herein are provided on an
328 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
329 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
330 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
331 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
332 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
333 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
335 Copyright Statement
337 Copyright (C) The Internet Society (2005). This document is subject
338 to the rights, licenses and restrictions contained in BCP 78, and
339 except as set forth therein, the authors retain all their rights.
341 Acknowledgment
343 Funding for the RFC Editor function is currently provided by the
344 Internet Society.