Example Media Types for Use in Documentation
RFC 4735
Document | Type |
RFC - Proposed Standard
(October 2006; No errata)
Was draft-taylor-types-example (individual in tsv area)
|
|
---|---|---|---|
Author | Tom Taylor | ||
Last updated | 2015-10-14 | ||
Stream | Internent Engineering Task Force (IETF) | ||
Formats | plain text html pdf htmlized (tools) htmlized bibtex | ||
Reviews | |||
Stream | WG state | (None) | |
Document shepherd | No shepherd assigned | ||
IESG | IESG state | RFC 4735 (Proposed Standard) | |
Action Holders |
(None)
|
||
Consensus Boilerplate | Unknown | ||
Telechat date | |||
Responsible AD | Magnus Westerlund | ||
Send notices to | (None) |
Network Working Group T. Taylor Request for Comments: 4735 Nortel Category: Standards Track October 2006 Example Media Types for Use in Documentation Status of This Memo This document specifies an Internet standards track protocol for the Internet community, and requests discussion and suggestions for improvements. Please refer to the current edition of the "Internet Official Protocol Standards" (STD 1) for the standardization state and status of this protocol. Distribution of this memo is unlimited. Copyright Notice Copyright (C) The Internet Society (2006). Abstract This document is registration for the 'example' media type and 'example' subtypes within the standards tree. The 'example/*' and '*/example' media types are defined for documentation purposes only. 1. Introduction From time to time, documents created by the IETF or by other standards bodies show examples involving the use of media types, where the actual media type is not relevant. It would be useful in such cases to be able to show a media type whose illustrative role in the example is clear. In the worst case, this can be useful to debug implementations where the designer mistook the example for a requirement of the protocol concerned. To meet this need, this document registers the following media types: o the 'example' media type; o the 'application/example', 'audio/example', 'image/example', 'message/example', 'model/example', 'multipart/example', 'text/example', and 'video/example' media subtypes. It is suggested that compilers of illustrative examples involving media types in trees other than the standards tree might also incorporate the string "example" into their hypothetical media types. Taylor Standards Track [Page 1] RFC 4735 Example Media Types October 2006 2. Terminology 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 [RFC2119]. 3. Registration of the 'example' Media Type This section registers the 'example' media type in accordance with the requirements of RFC 4288. Type name: example. Subtype name: any subtype may be used with the 'example' type. However, IANA MUST NOT register any subtypes for the 'example' media type. Required parameters: as invented by the user. Optional parameters: as invented by the user. Encoding considerations: as invented by the user. Security considerations: The 'example' media type is defined for use in documentation only. It MUST NOT be implemented. Its appearance in real code could lead to unpredictable results and therefore open up security holes. Interoperability considerations: Any attempt to negotiate or send the 'example' media type is bound to lead to interoperability problems. Published specification: this document. Applications that use this media type: as invented by the user. Additional information: Magic number(s): not applicable. File extension(s): not applicable. Macintosh file type code(s): not applicable. Person & email address to contact for further information: ietf-types@iana.org. Intended usage: LIMITED USE. Taylor Standards Track [Page 2] RFC 4735 Example Media Types October 2006 Restrictions on usage: This type is intended only for use in documents providing examples involving specification of some media type, where the actual media type used is irrelevant. Author: Internet Engineering Task Force Change controller: Internet Engineering Task Force 4. Registration of the 'application/example', 'audio/example', 'image/example', 'message/example', 'model/example', 'multipart/example', 'text/example', and 'video/example' Subtypes This section registers 'example' media subtypes in accordance with the requirements of RFC 4288. Type name: 'application', 'audio', 'image', 'message', 'model', 'multipart', 'text', and 'video'. Subtype name: 'example'. Required parameters: those required by the type and any others as invented by the user. Optional parameters: those offered by the type and any others as invented by the user. Encoding considerations: as invented by the user. Security considerations: The 'example' media subtypes are defined for use in documentation only. They MUST NOT be implemented. Their appearance in real code could lead to unpredictable results and therefore open up security holes. Interoperability considerations: Any attempt to negotiate or send one of these 'example' media subtypes is bound to lead toShow full document text