Network Working Group D. Harrington, Ed.
Request for Comments: 5249 Huawei Technologies (USA)
BCP: 139 July 2008
Category: Best Current Practice
Network Working Group D. Harrington, Ed.
Request for Comments: 5249 Huawei Technologies (USA)
BCP: 139 July 2008
Category: Best Current Practice
Templates for Internet-Drafts Containing MIB Modules
包含MIB模块的Internet草稿模板
Status of This Memo
关于下段备忘
This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements. Distribution of this memo is unlimited.
本文件规定了互联网社区的最佳现行做法，并要求进行讨论和提出改进建议。本备忘录的分发不受限制。
Abstract
摘要
This memo references three annotated templates for IETF documents that contain the definition of MIB modules. It is intended to reduce the work of the editors of such documents, making these documents more uniform and easier to read and review, thus furthering the quality of such documents and expediting their publication.
本备忘录引用了IETF文件的三个带注释的模板，其中包含MIB模块的定义。其目的是减少此类文件编辑的工作，使这些文件更加统一，更易于阅读和审查，从而提高此类文件的质量并加快其出版。
Table of Contents
目录
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
3. Security Considerations . . . . . . . . . . . . . . . . . . . . 3
4. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 3
5. Normative References . . . . . . . . . . . . . . . . . . . . . 3
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
3. Security Considerations . . . . . . . . . . . . . . . . . . . . 3
4. Contributors . . . . . . . . . . . . . . . . . . . . . . . . . 3
5. Normative References . . . . . . . . . . . . . . . . . . . . . 3
This memo references three annotated templates for IETF documents that contain the definition of MIB modules. It is intended to reduce the work of the editors of such documents, making these more uniform and easier to read and review, thus furthering the quality of such documents and expediting their publication.
本备忘录引用了IETF文件的三个带注释的模板，其中包含MIB模块的定义。其目的是减少此类文件编辑的工作，使这些文件更加统一，更易于阅读和审查，从而提高此类文件的质量并加快其出版。
The MIB Doctors directorate has produced three templates specifically aimed at Internet-Drafts containing MIB modules. The templates are available at the IETF Tools web site, listed as "Templates for MIB Documents".
MIB医生管理局已经制作了三个模板，专门针对包含MIB模块的互联网草案。这些模板可在IETF工具网站上获得，列为“MIB文档模板”。
o The first is an XML template for editors that use XML2RFC. Some advice echoing guidelines from RFC 4181 is embedded in comments.
o 第一个是用于使用XML2RFC的编辑器的XML模板。注释中嵌入了一些与RFC 4181指南相呼应的建议。
o A second template is a text template for MIB documents with advice embedded in the document.
o 第二个模板是MIB文档的文本模板，文档中嵌入了通知。
o A third template is a plain text template with no advice included.
o 第三个模板是纯文本模板，不包含任何建议。
The templates were developed to make IETF documents that contain MIB modules more consistent. This makes it easier for a MIB Doctor and other IETF participants to review the document. There are a number of MUSTs in the templates, especially in the advice; these usually refer to IESG requirements for Internet-Drafts, and MIB Doctors are likely to check for these requirements.
开发这些模板是为了使包含MIB模块的IETF文档更加一致。这使得MIB医生和其他IETF参与者更容易审查文档。模板中有许多必须的内容，特别是在建议中；这些通常是指IESG对互联网草案的要求，MIB医生可能会检查这些要求。
The templates contain boilerplates that are required for IETF MIB module documents. It has been common practice for editors to use existing MIB module documents as templates. This approach has problems because boilerplates and other required elements change over time. The templates referenced by this document will be made available on the IETF Tools web site, and occasionally updated to reflect the latest requirements. The most up-to-date revisions of the templates are available at http://www.tools.ietf.org.
模板包含IETF MIB模块文档所需的样板文件。编辑器通常使用现有的MIB模块文档作为模板。这种方法有问题，因为样板和其他必需的元素会随着时间的推移而变化。本文件引用的模板将在IETF工具网站上提供，并不时更新以反映最新要求。模板的最新修订版可在http://www.tools.ietf.org.
The templates contain sections that describe the purpose and organization of the MIB module, and the relationship between this MIB module and other MIB modules. This makes it easier for MIB Doctors to understand the MIB module, which speeds the review process.
模板包含描述MIB模块的用途和组织以及此MIB模块与其他MIB模块之间关系的部分。这使得MIB医生更容易理解MIB模块，从而加快审查过程。
Editors should read RFC 4181 "Guidelines for Authors and Reviewers of MIB Documents" [RFC4181], which describes best current practices for MIB module document editing.
编辑人员应阅读RFC 4181“MIB文档作者和审阅者指南”[RFC4181]，其中描述了MIB模块文档编辑的最佳当前实践。
The document templates do not include a template for the MIB module itself. Tools to validate MIB modules typically require that the MIB module be separated from the surrounding document. The MIB Doctors feel that the simplest approach is to develop the MIB module outside the document that contains the surrounding text, and then include the MIB module into the surrounding document written using the templates.
文档模板不包括MIB模块本身的模板。用于验证MIB模块的工具通常要求将MIB模块与周围文档分离。MIB医生认为最简单的方法是在包含周围文本的文档之外开发MIB模块，然后将MIB模块包含到使用模板编写的周围文档中。
This memo recommends templates for editing; it has no direct impact on network security. The templates include boilerplates and associated advice for writing the Security Considerations section of an Internet-Draft that documents a MIB module.
本备忘录建议编辑模板；它对网络安全没有直接影响。这些模板包括样板文件和相关建议，用于编写记录MIB模块的Internet草案的安全注意事项部分。
These templates are based on contributions from the MIB Doctors, especially Juergen Schoenwaelder, Dave Perkins, C.M. Heard, and Randy Presuhn.
这些模板基于MIB医生的贡献，特别是Juergen Schoenwaeld、Dave Perkins、C.M.Heard和Randy Presuhn。
[RFC4181] Heard, C., "Guidelines for Authors and Reviewers of MIB Documents", BCP 111, RFC 4181, September 2005.
[RFC4181]Heard，C.，“MIB文件的作者和评审者指南”，BCP 111，RFC 41812005年9月。
Author's Address
作者地址
David Harrington (editor) Huawei Technologies (USA) 1700 Alma Drive, Suite 100 Plano, TX 75075 USA
David Harrington（编辑）华为技术（美国）美国德克萨斯州普莱诺市阿尔玛大道1700号100室75075
Phone: +1 603 436 8634
EMail: dharrington@huawei.com
Phone: +1 603 436 8634
EMail: dharrington@huawei.com
Full Copyright Statement
完整版权声明
Copyright (C) The IETF Trust (2008).
版权所有（C）IETF信托基金（2008年）。
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, THE IETF TRUST 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.
本文件及其包含的信息以“原样”为基础提供，贡献者、他/她所代表或赞助的组织（如有）、互联网协会、IETF信托基金和互联网工程任务组不承担任何明示或暗示的担保，包括但不限于任何保证，即使用本文中的信息不会侵犯任何权利，或对适销性或特定用途适用性的任何默示保证。
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.