RFC 5249 - Templates for Internet-Drafts Containing MIB Modules 日本語訳

原文URL : https://datatracker.ietf.org/doc/html/rfc5249
タイトル : RFC 5249 - MIBモジュールを含むインターネットドラフト用のテンプレート
翻訳編集 : 自動生成

[要約] RFC 5249は、MIBモジュールを含むインターネットドラフトのテンプレートに関するガイドラインです。その目的は、MIBモジュールを含むドラフトの作成と標準化プロセスを効率化することです。

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モジュールを含むインターネットドラフト用のテンプレート

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.

このメモは、MIBモジュールの定義を含むIETFドキュメントの3つの注釈付きテンプレートを参照しています。このようなドキュメントの編集者の作業を削減し、これらのドキュメントをより均一で読みやすく見やすくすることを目的としています。したがって、そのようなドキュメントの品質を高め、出版物を促進します。

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . . . 2
   2.  Overview  . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
   3.  Security Considerations . . . . . . . . . . . . . . . . . . . . 3
   4.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . . . 3
   5.  Normative References  . . . . . . . . . . . . . . . . . . . . . 3

1. Introduction

1. はじめに

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.

このメモは、MIBモジュールの定義を含むIETFドキュメントの3つの注釈付きテンプレートを参照しています。このようなドキュメントの編集者の作業を減らし、これらをより均一で読みやすく見やすくすることを目的としています。そのため、そのようなドキュメントの品質を高め、出版物を促進します。

2. Overview

2. 概要

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 Doctors局は、MIBモジュールを含むインターネットドラフトを対象とした3つのテンプレートを作成しました。テンプレートは、「MIBドキュメントのテンプレート」としてリストされているIETFツールWebサイトで利用できます。

o The first is an XML template for editors that use XML2RFC. Some advice echoing guidelines from RFC 4181 is embedded in comments.

o 1つ目は、XML2RFCを使用するエディター向けのXMLテンプレートです。RFC 4181のガイドラインをエコーするアドバイスは、コメントに組み込まれています。

o A second template is a text template for MIB documents with advice embedded in the document.

o 2番目のテンプレートは、ドキュメントに埋め込まれたアドバイスを備えたMIBドキュメント用のテキストテンプレートです。

o A third template is a plain text template with no advice included.

o 3番目のテンプレートは、アドバイスが含まれていないプレーンテキストテンプレートです。

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ツールWebサイトで利用可能になり、最新の要件を反映するために時々更新されます。テンプレートの最新の改訂版は、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.

編集者は、MIBモジュールドキュメント編集の最良の現在の慣行について説明するRFC 4181「MIBドキュメントの著者およびレビュアーのガイドライン」[RFC4181]を読む必要があります。

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モジュールを含めることだと感じています。

3. Security Considerations

3. セキュリティに関する考慮事項

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モジュールを文書化するインターネットドラフトのセキュリティに関する考慮事項セクションを作成するためのボイラープレートと関連するアドバイスが含まれます。

4. Contributors

4. 貢献者

These templates are based on contributions from the MIB Doctors, especially Juergen Schoenwaelder, Dave Perkins, C.M. Heard, and Randy Presuhn.

これらのテンプレートは、MIBの医師、特にJuergen Schoenwaelder、Dave Perkins、C.M。の貢献に基づいています。聞いた、そしてランディ・プレスン。

5. Normative References

5. 引用文献

[RFC4181] Heard, C., "Guidelines for Authors and Reviewers of MIB Documents", BCP 111, RFC 4181, September 2005.

[RFC4181] Heard、C。、「MIB文書の著者およびレビュアーのガイドライン」、BCP 111、RFC 4181、2005年9月。

Author's Address

著者の連絡先

David Harrington (editor) Huawei Technologies (USA) 1700 Alma Drive, Suite 100 Plano, TX 75075 USA

David Harrington（編集者）Huawei Technologies（USA）1700 Alma Drive、Suite 100 Plano、TX 75075 USA

   Phone: +1 603 436 8634
   EMail: dharrington@huawei.com

Full Copyright Statement

完全な著作権声明

著作権（c）The IETF Trust（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事務局に行われたIPR開示のコピーと、利用可能にするライセンスの保証、またはこの仕様の実装者またはユーザーによるそのような独自の権利の使用のための一般的なライセンスまたは許可を取得しようとする試みの結果を取得できます。http://www.ietf.org/iprのIETFオンライン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-ipr@ietf.orgのIETFへの情報をお問い合わせください。