idnits 2.17.1
draft-snell-atompub-feed-nofollow-04.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 278.
-- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 255.
-- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 262.
-- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 268.
** 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 6709 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)
== Unused Reference: 'RFC4287' is defined on line 215, but no explicit
reference was found in the text
Summary: 4 errors (**), 0 flaws (~~), 3 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 Atom Link No Follow
7 draft-snell-atompub-feed-nofollow-04.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 feed publishers to express
41 preferences over how a consumer processes Atom links and Content-By-
42 Reference.
44 Table of Contents
46 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
47 2. Notational Conventions . . . . . . . . . . . . . . . . . . . . 3
48 3. The 'x:follow' extension attribute . . . . . . . . . . . . . . 4
49 4. The 'x:index' extension attribute . . . . . . . . . . . . . . . 4
50 5. The 'x:archive' extension attribute . . . . . . . . . . . . . . 5
51 6. Security Considerations . . . . . . . . . . . . . . . . . . . . 6
52 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 6
53 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 6
54 Appendix A. Acknowledgements . . . . . . . . . . . . . . . . . . . 6
55 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 7
56 Intellectual Property and Copyright Statements . . . . . . . . . . 8
58 1. Introduction
60 This docoument specifies a mechanism by which feed publishers MAY
61 express how applications consuming Atom documents should handle links
62 and referenced content. For example, a publisher may include an
63 enclosure link within a feed but may not wish for applications to
64 automatically download the enclosed file when it processes the feed;
65 or, the publisher may not wish to allow applications to archive or
66 index the enclosure in any way. The 'follow', 'index' and 'archive'
67 attributes introduced herein provide the means for publishers to
68 express these preferences.
69 noFollowAttributes = {
70 attribute follow { "yes" | "no" }?,
71 attribute index { "yes" | "no" }?,
72 attribute archive { "yes" | "no" }?
73 }
75 Section 6.3 of the Atom Format specification indicates that Atom
76 processors that encounter unknown extensions MUST ignore those
77 extensions without altering their behavior. Because of this
78 requirement, there can be no assumption that a particular software
79 implementation will support the extensions defined herein.
81 2. Notational Conventions
83 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
84 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
85 document are to be interpreted as described in BCP 14, [RFC2119], as
86 scoped to those conformance targets.
88 In this specification, "entry" refers to an atom:entry element.
90 In this specification, "feed" refers to an Atom Feed Document.
92 In this specification, "head section" refers to the children of a
93 feed's document-wide metadata container; e.g., the child elements of
94 the atom:feed element in an Atom Feed Document.
96 In this specification, the term "extension attribute" refers to a
97 namespace qualified element attribute.
99 In this specification, the term "link" refers to an atom:link
100 element.
102 In this specification, the term "referenced content" refers to an
103 atom:content element that contains a @src attribute.
105 This specification uses XML Namespaces [W3C.REC-xml-names-19990114]
106 to uniquely identify XML element and attribute names. It uses the
107 following namespace prefix for the indicated namespace URI;
109 {Ed. Note: The Namespace must be changed before publication to
110 reflect a proper IETF namespace scheme}
111 "x": "http://purl.org/atompub/nofollow/1.0"
113 This specification uses terms from the XML Infoset [W3C.REC-xml-
114 infoset-20040204]. However, this specification uses a shorthand; the
115 phrase "Information Item" is omitted when naming Element Information
116 Items. Therefore, when this specification uses the term "element,"
117 it is referring to an Element Information Item in Infoset terms.
119 3. The 'x:follow' extension attribute
121 The 'x:follow" attribute indicates whether applications should
122 automatically attempt to follow links and referenced content (e.g.,
123 whether or not enclosure links should be automatically downloaded,
124 etc). The value of the attribute is either "yes" or "no". If
125 missing, the value is considered to be indeterminate. A value of
126 "no" indicates that applications SHOULD NOT attempt to automatically
127 resolve the referenced resource -- rather, the application should
128 wait until a user explicitly requests the linked resource to be
129 resolved.
131 For example,
132
134 ...
135 ...
136
139 ...
140
142 The 'x:follow' attribute MAY be contained by atom:link elements and
143 atom:content elements that contain a 'src' attribute.
145 4. The 'x:index' extension attribute
147 The 'x:index' attribute indicates whether applications should index
148 links and referenced content. The value of the attribute is either
149 "yes" or "no". If missing, the value is considered to be
150 indeterminate. A value of "no" indicates that applications SHOULD
151 NOT index the referenced resource.
153 For the sake of this specification, 'indexing' refers to the practice
154 of parsing and processing the content of a resource for the purpose
155 of populating a database used for searching and other forms of
156 analysis. The intended purpose of using x:index="no" would be for
157 the publisher to indicate their preference that the associated
158 resource not be processed for searching or analysis purposes.
159
161 ...
162 ...
163
166 ...
167
169 The 'x:index' attribute MAY be contained by atom:link elements and
170 atom:content elements containing a 'src' attribute.
172 5. The 'x:archive' extension attribute
174 The 'x:archive' attribute indicates whether applications should
175 archive the targets of links and content references. The value of
176 the attribute is either "yes" or "no". If missing, the value is
177 considered to be "yes". A value of "no" indicate that applications
178 SHOULD NOT archive the referenced resource.
180 For the sake of this specification, 'archiving' refers to the
181 practice of maintain a local copy of a resource as part of a
182 historical record. This is different than the practice of
183 maintaining locally cached copies of a resource for the sake of
184 improving transmission performance and reducing network bandwidth.
185 The intended purpose of using x:archive="no" would be for a publisher
186 to indicate their preference that local copies of the asociated
187 resource not be maintained for archival/historical purposes.
188
190 ...
191 ...
192
195 ...
196
198 The 'x:archive' attribute MAY be contained by atom:link elements and
199 atom:content elements containing a 'src' attribute.
201 6. Security Considerations
203 There are no security considerations introduced by this
204 specification.
206 7. IANA Considerations
208 There are no IANA considerations introduced by this specification.
210 8. References
212 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
213 Requirement Levels", BCP 14, RFC 2119, March 1997.
215 [RFC4287] Nottingham, M. and R. Sayre, "The Atom Syndication
216 Format", RFC 4287, December 2005.
218 [W3C.REC-xml-infoset-20040204]
219 Tobin, R. and J. Cowan, "XML Information Set (Second
220 Edition)", W3C REC REC-xml-infoset-20040204,
221 February 2004.
223 [W3C.REC-xml-names-19990114]
224 Hollander, D., Bray, T., and A. Layman, "Namespaces in
225 XML", W3C REC REC-xml-names-19990114, January 1999.
227 [W3C.REC-xmlschema-2-20041028]
228 Malhotra, A. and P. Biron, "XML Schema Part 2: Datatypes
229 Second Edition", W3C REC REC-xmlschema-2-20041028,
230 October 2004.
232 Appendix A. Acknowledgements
234 The author gratefully acknowledges the feedback from the members of
235 the Atom Publishing Format and Protocol working group during the
236 development of this specification.
238 Author's Address
240 James M Snell
242 Phone:
243 Email: jasnell@gmail.com
244 URI: http://snellspace.com
246 Intellectual Property Statement
248 The IETF takes no position regarding the validity or scope of any
249 Intellectual Property Rights or other rights that might be claimed to
250 pertain to the implementation or use of the technology described in
251 this document or the extent to which any license under such rights
252 might or might not be available; nor does it represent that it has
253 made any independent effort to identify any such rights. Information
254 on the procedures with respect to rights in RFC documents can be
255 found in BCP 78 and BCP 79.
257 Copies of IPR disclosures made to the IETF Secretariat and any
258 assurances of licenses to be made available, or the result of an
259 attempt made to obtain a general license or permission for the use of
260 such proprietary rights by implementers or users of this
261 specification can be obtained from the IETF on-line IPR repository at
262 http://www.ietf.org/ipr.
264 The IETF invites any interested party to bring to its attention any
265 copyrights, patents or patent applications, or other proprietary
266 rights that may cover technology that may be required to implement
267 this standard. Please address the information to the IETF at
268 ietf-ipr@ietf.org.
270 Disclaimer of Validity
272 This document and the information contained herein are provided on an
273 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
274 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
275 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
276 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
277 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
278 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
280 Copyright Statement
282 Copyright (C) The Internet Society (2005). This document is subject
283 to the rights, licenses and restrictions contained in BCP 78, and
284 except as set forth therein, the authors retain all their rights.
286 Acknowledgment
288 Funding for the RFC Editor function is currently provided by the
289 Internet Society.