Network Working Group                                          T. Taylor
Request for Comments: 4735                                        Nortel
Category: Standards Track                                   October 2006
        
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.

本文件规定了互联网社区的互联网标准跟踪协议,并要求进行讨论和提出改进建议。有关本协议的标准化状态和状态,请参考当前版本的“互联网官方协议标准”(STD 1)。本备忘录的分发不受限制。

Copyright Notice

版权公告

Copyright (C) The Internet Society (2006).

版权所有(C)互联网协会(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.

本文档是标准树中“示例”媒体类型和“示例”子类型的注册。“example/*”和“*/example”媒体类型的定义仅用于文档目的。

1. Introduction
1. 介绍

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.

IETF或其他标准机构创建的文件不时会显示涉及使用媒体类型的示例,其中实际媒体类型不相关。在这种情况下,能够显示其在示例中的说明作用明确的媒体类型将是有用的。在最坏的情况下,这对于调试实现非常有用,因为设计者将示例误认为是相关协议的要求。

To meet this need, this document registers the following media types:

为了满足这一需要,本文档注册了以下介质类型:

o the 'example' media type;

o “示例”媒体类型;

o the 'application/example', 'audio/example', 'image/example', 'message/example', 'model/example', 'multipart/example', 'text/example', and 'video/example' media subtypes.

o “应用程序/示例”、“音频/示例”、“图像/示例”、“消息/示例”、“模型/示例”、“多部分/示例”、“文本/示例”和“视频/示例”媒体子类型。

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.

有人建议,涉及树(而非标准树)中媒体类型的说明性示例的编译器也可以将字符串“example”合并到其假设的媒体类型中。

2. Terminology
2. 术语

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].

本文件中的关键词“必须”、“不得”、“必需”、“应”、“不应”、“应”、“不应”、“建议”、“可”和“可选”应按照[RFC2119]中所述进行解释。

3. Registration of the 'example' Media Type
3. “示例”媒体类型的注册

This section registers the 'example' media type in accordance with the requirements of RFC 4288.

本节根据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.

子类型名称:任何子类型都可以与“示例”类型一起使用。但是,IANA不得为“示例”媒体类型注册任何子类型。

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.

附加信息:幻数:不适用。文件扩展名:不适用。Macintosh文件类型代码:不适用。

Person & email address to contact for further information: ietf-types@iana.org.

联系人和电子邮件地址,以获取更多信息:ietf-types@iana.org.

Intended usage: LIMITED USE.

预期用途:有限使用。

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

4. 注册“应用程序/示例”、“音频/示例”、“图像/示例”、“消息/示例”、“模型/示例”、“多部分/示例”、“文本/示例”和“视频/示例”子类型

This section registers 'example' media subtypes in accordance with the requirements of RFC 4288.

本节根据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 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.

附加信息:幻数:不适用。文件扩展名:不适用。Macintosh文件类型代码:不适用。

Person & email address to contact for further information: ietf-types@iana.org.

联系人和电子邮件地址,以获取更多信息:ietf-types@iana.org.

Intended usage: LIMITED USE.

预期用途:有限使用。

Restrictions on usage: These subtypes are intended only for use in documents providing examples involving specification of some subtype of the given media type, where the actual subtype used is irrelevant.

使用限制:这些子类型仅用于提供示例的文档中,这些示例涉及指定媒体类型的某些子类型的规范,而实际使用的子类型与此无关。

Author: Internet Engineering Task Force

作者:互联网工程特别工作组

Change controller: Internet Engineering Task Force

变更控制员:互联网工程特别工作组

5. Security Considerations
5. 安全考虑

The 'example' media type and subtypes are defined for use in documentation only. They MUST NOT be implemented. Any attempt to implement them in real code could lead to unpredictable results and thus potentially open up security holes.

“示例”媒体类型和子类型的定义仅用于文档中。它们绝不能得到执行。任何在真实代码中实现它们的尝试都可能导致不可预测的结果,从而可能打开安全漏洞。

6. IANA Considerations
6. IANA考虑

This document specifies and registers the 'example' media type and the 'application/example', 'audio/example', 'image/example', 'message/example', 'model/example', 'multipart/example', 'text/example', and 'video/example' subtypes.

本文档指定并注册“示例”媒体类型以及“应用程序/示例”、“音频/示例”、“图像/示例”、“消息/示例”、“模型/示例”、“多部分/示例”、“文本/示例”和“视频/示例”子类型。

7. Acknowledgements
7. 致谢

This document sprang from Magnus Westerland's expression of need and Rod Walsh's support and suggestions for generalization. Warnings against implementation in the Security Considerations and Interoperability Considerations sections and the 'multipart/example' subtype were added at John Klensin's suggestion. Some editing touchups and strengthening of the language in the Security Considerations section were done in response to the Gen-ART reviewer, Sharon Chisholm.

本文件源自Magnus Westerland的需求表达和Rod Walsh对推广的支持和建议。根据John Klesin的建议,在“安全注意事项”和“互操作性注意事项”部分以及“多部分/示例”子类型中添加了对实现的警告。安全考虑部分中的一些编辑润色和语言强化是为了回应艺术评论专家沙龙·奇肖姆(Sharon Chisholm)。

8. Normative References
8. 规范性引用文件

[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997.

[RFC2119]Bradner,S.,“RFC中用于表示需求水平的关键词”,BCP 14,RFC 2119,1997年3月。

[RFC4288] Freed, N. and J. Klensin, "Media Type Specifications and Registration Procedures", BCP 13, RFC 4288, December 2005.

[RFC4288]Freed,N.和J.Klensin,“介质类型规范和注册程序”,BCP 13,RFC 4288,2005年12月。

Author's Address

作者地址

Tom Taylor Nortel 1852 Lorraine Ave Ottawa, Ontario K1H 6Z8 Canada

Tom Taylor Nortel 1852加拿大安大略省渥太华洛林大道K1H 6Z8

   EMail: taylor@nortel.com
        
   EMail: taylor@nortel.com
        

Full Copyright Statement

完整版权声明

Copyright (C) The Internet Society (2006).

版权所有(C)互联网协会(2006年)。

This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights.

本文件受BCP 78中包含的权利、许可和限制的约束,除其中规定外,作者保留其所有权利。

This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

本文件及其包含的信息是按“原样”提供的,贡献者、他/她所代表或赞助的组织(如有)、互联网协会和互联网工程任务组不承担任何明示或暗示的担保,包括但不限于任何保证,即使用本文中的信息不会侵犯任何权利,或对适销性或特定用途适用性的任何默示保证。

Intellectual Property

知识产权

The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79.

IETF对可能声称与本文件所述技术的实施或使用有关的任何知识产权或其他权利的有效性或范围,或此类权利下的任何许可可能或可能不可用的程度,不采取任何立场;它也不表示它已作出任何独立努力来确定任何此类权利。有关RFC文件中权利的程序信息,请参见BCP 78和BCP 79。

Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr.

向IETF秘书处披露的知识产权副本和任何许可证保证,或本规范实施者或用户试图获得使用此类专有权利的一般许可证或许可的结果,可从IETF在线知识产权存储库获取,网址为http://www.ietf.org/ipr.

The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org.

IETF邀请任何相关方提请其注意任何版权、专利或专利申请,或其他可能涵盖实施本标准所需技术的专有权利。请将信息发送至IETF的IETF-ipr@ietf.org.

Acknowledgement

确认

Funding for the RFC Editor function is provided by the IETF Administrative Support Activity (IASA).

RFC编辑器功能的资金由IETF行政支持活动(IASA)提供。