idnits 2.17.1 draft-taylor-types-example-05.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 243. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 220. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 227. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 233. ** 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 : ---------------------------------------------------------------------------- No issues found here. 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 (May 22, 2006) is 6547 days in the past. Is this intentional? -- Found something which looks like a code comment -- if you have code sections in the document, please surround them with '' and '' lines. 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: 'RFC4288' is defined on line 198, but no explicit reference was found in the text ** Obsolete normative reference: RFC 4288 (Obsoleted by RFC 6838) Summary: 4 errors (**), 0 flaws (~~), 3 warnings (==), 8 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Network Working Group T. Taylor 3 Internet-Draft Nortel 4 Expires: November 23, 2006 May 22, 2006 6 Example media types for use in documentation 7 draft-taylor-types-example-05.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 November 23, 2006. 34 Copyright Notice 36 Copyright (C) The Internet Society (2006). 38 Abstract 40 This document is registration for the 'example' media type and 41 'example' subtypes within the standards tree. The 'example/*' and 42 '*/example' media types are defined for documentation purposes only. 44 1. Introduction 46 From time to time, documents created by the IETF or by other 47 standards bodies show examples involving the use of media types, 48 where the actual media type is not relevant. It would be useful in 49 such cases to be able to show a media type whose illustrative role in 50 the example is clear. In the worst case, this can be useful to debug 51 implementations where the designer mistook the example for a 52 requirement of the protocol concerned. 54 To meet this need, this document registers the following media types: 55 o the 'example' media type; 56 o the 'text/example', 'image/example', 'audio/example', 'video/ 57 example', 'application/example', and 'multipart/example' media 58 subtypes. 60 It is suggested that compilers of illustrative examples involving 61 media types in trees other than the standards tree might also 62 incorporate the string "example" into their hypothetical media types. 64 2. Terminology 66 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 67 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 68 document are to be interpreted as described in [RFC2119]. 70 3. Registration of the 'example' media type 72 This section registers the 'example' media type in accordance with 73 the requirements of RFC 4288. 75 Type name: example. 77 Subtype name: any subtype may be used with the 'example' type. 78 However, IANA MUST NOT register any subtypes for the 'example' media 79 type. 81 Required parameters: as invented by the user. 83 Optional parameters: as invented by the user. 85 Encoding considerations: as invented by the user. 87 Security considerations: The 'example' media type is defined for use 88 in documentation only. It MUST NOT be implemented. Its appearance 89 in real code could lead to unpredictable results and therefore open 90 up security holes. 92 Interoperability considerations: Any attempt to negotiate or send the 93 'example' media type is bound to lead to interoperability problems. 95 Published specification: this document. 97 Applications that use this media type: as invented by the user. 99 Additional information: 100 Magic number(s): not applicable. 101 File extension(s): not applicable. 102 Macintosh file type code(s): not applicable. 104 Person & email address to contact for further information: 105 ietf-types@iana.org. 107 Intended usage: LIMITED USE. 109 Restrictions on usage: this type is intended only for use in 110 documents providing examples involving specification of some media 111 type, where the actual media type used is irrelevant. 113 Author: Internet Engineering Task Force 115 Change controller: Internet Engineering Task Force 117 4. Registration of the 'application/example', 'audio/example', 'image/ 118 example', 'message/example', 'model/example', 'multipart/example', 119 'text/example', and 'video/example' subtypes 121 This section registers 'example' media subtypes in accordance with 122 the requirements of RFC 4288. 124 Type name: 'application', 'audio', 'image', 'message', 'model', 125 'multipart', 'text', and 'video'. 127 Subtype name: 'example'. 129 Required parameters: those required by the type and any others as 130 invented by the user. 132 Optional parameters: those offered by the type and any others as 133 invented by the user. 135 Encoding considerations: as invented by the user. 137 Security considerations: The 'example' media subtypes are defined for 138 use in documentation only. They MUST NOT be implemented. Their 139 appearance in real code could lead to unpredictable results and 140 therefore open up security holes. 142 Interoperability considerations: Any attempt to negotiate or send one 143 of these 'example' media subtypes is bound to lead to 144 interoperability problems. 146 Published specification: this document. 148 Applications that use this media type: as invented by the user. 150 Additional information: 151 Magic number(s): not applicable. 152 File extension(s): not applicable. 153 Macintosh file type code(s): not applicable. 155 Person & email address to contact for further information: 156 ietf-types@iana.org. 158 Intended usage: LIMITED USE. 160 Restrictions on usage: these subtypes are intended only for use in 161 documents providing examples involving specification of some subtype 162 of the given media type, where the actual subtype used is irrelevant. 164 Author: Internet Engineering Task Force 166 Change controller: Internet Engineering Task Force 168 5. Security considerations 170 The 'example' media type and subtypes are defined for use in 171 documentation only. They MUST NOT be implemented. Any attempt to 172 implement them in real code could lead to unpredictable results and 173 thus potentially open up security holes. 175 6. IANA considerations 177 This document specifies and registers the 'example' media type and 178 the 'application/example', 'audio/example', 'image/example', 179 'message/example', 'model/example', 'multipart/example', 'text/ 180 example', and 'video/example' subtypes. 182 7. Acknowledgements 184 This document sprang from Magnus Westerland's expression of need and 185 Rod Walsh's support and suggestions for generalization. Warnings 186 against implementation in the Security Considerations and 187 Interoperability Considerations sections and the 'multipart/example' 188 subtype were added at John Klensin's suggestion. Some editing 189 touchup and strengthening of the language in the Security 190 Considerations sections was done in response to the Gen-ART reviewer, 191 Sharon Chisholm. 193 8. Normative References 195 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 196 Requirement Levels", BCP 14, RFC 2119, March 1997. 198 [RFC4288] Freed, N. and J. Klensin, "Media Type Specifications and 199 Registration Procedures", BCP 13, RFC 4288, December 2005. 201 Author's Address 203 Tom Taylor 204 Nortel 205 1852 Lorraine Ave 206 Ottawa, Ontario K1H 6Z8 207 Canada 209 Email: taylor@nortel.com 211 Intellectual Property Statement 213 The IETF takes no position regarding the validity or scope of any 214 Intellectual Property Rights or other rights that might be claimed to 215 pertain to the implementation or use of the technology described in 216 this document or the extent to which any license under such rights 217 might or might not be available; nor does it represent that it has 218 made any independent effort to identify any such rights. Information 219 on the procedures with respect to rights in RFC documents can be 220 found in BCP 78 and BCP 79. 222 Copies of IPR disclosures made to the IETF Secretariat and any 223 assurances of licenses to be made available, or the result of an 224 attempt made to obtain a general license or permission for the use of 225 such proprietary rights by implementers or users of this 226 specification can be obtained from the IETF on-line IPR repository at 227 http://www.ietf.org/ipr. 229 The IETF invites any interested party to bring to its attention any 230 copyrights, patents or patent applications, or other proprietary 231 rights that may cover technology that may be required to implement 232 this standard. Please address the information to the IETF at 233 ietf-ipr@ietf.org. 235 Disclaimer of Validity 237 This document and the information contained herein are provided on an 238 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 239 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET 240 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, 241 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE 242 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 243 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 245 Copyright Statement 247 Copyright (C) The Internet Society (2006). This document is subject 248 to the rights, licenses and restrictions contained in BCP 78, and 249 except as set forth therein, the authors retain all their rights. 251 Acknowledgment 253 Funding for the RFC Editor function is currently provided by the 254 Internet Society.