[要約] RFC 7994は、プレーンテキスト形式のRFCに関する要件を定めたものであり、その目的は、可読性とアクセシビリティの向上を図ることです。
Internet Architecture Board (IAB) H. Flanagan
Request for Comments: 7994 RFC Editor
Category: Informational December 2016
ISSN: 2070-1721
Requirements for Plain-Text RFCs
プレーンテキストRFCの要件
Abstract
概要
In 2013, after a great deal of community discussion, the decision was made to shift from the plain-text, ASCII-only canonical format for RFCs to XML as the canonical format with more human-readable formats rendered from that XML. The high-level requirements that informed this change were defined in RFC 6949, "RFC Series Format Requirements and Future Development". Plain text remains an important format for many in the IETF community, and it will be one of the publication formats rendered from the XML. This document outlines the rendering requirements for the plain-text RFC publication format. These requirements do not apply to plain-text RFCs published before the format transition.
2013年、コミュニティでの多くの議論の後、RFCのプレーンテキストのASCIIのみの正規形式から、XMLからレンダリングされたより人間が読める形式の正規形式としてのXMLに移行することが決定されました。この変更を通知する高レベルの要件は、RFC 6949の「RFCシリーズ形式の要件と将来の開発」で定義されています。プレーンテキストは、IETFコミュニティの多くにとって重要なフォーマットであり続け、XMLからレンダリングされる公開フォーマットの1つになります。このドキュメントでは、プレーンテキストのRFC公開形式のレンダリング要件について概説します。これらの要件は、フォーマット移行前に公開されたプレーンテキストRFCには適用されません。
Status of This Memo
本文書の状態
This document is not an Internet Standards Track specification; it is published for informational purposes.
このドキュメントはInternet Standards Trackの仕様ではありません。情報提供を目的として公開されています。
This document is a product of the Internet Architecture Board (IAB) and represents information that the IAB has deemed valuable to provide for permanent record. It represents the consensus of the Internet Architecture Board (IAB). Documents approved for publication by the IAB are not a candidate for any level of Internet Standard; see Section 2 of RFC 7841.
このドキュメントは、インターネットアーキテクチャボード（IAB）の製品であり、IABが永続的な記録を提供するために価値があると見なした情報を表しています。これは、インターネットアーキテクチャボード（IAB）のコンセンサスを表しています。 IABによって公開が承認されたドキュメントは、どのレベルのインターネット標準の候補にもなりません。 RFC 7841のセクション2をご覧ください。
Information about the current status of this document, any errata, and how to provide feedback on it may be obtained at http://www.rfc-editor.org/info/rfc7994.
このドキュメントの現在の状態、正誤表、およびフィードバックの提供方法に関する情報は、http：//www.rfc-editor.org/info/rfc7994で入手できます。
Copyright Notice
著作権表示
Copyright (c) 2016 IETF Trust and the persons identified as the document authors. All rights reserved.
Copyright（c）2016 IETF Trustおよびドキュメントの作成者として識別された人物。全著作権所有。
This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document.
この文書は、BCP 78およびIETF文書に関するIETFトラストの法的規定（http://trustee.ietf.org/license-info）の対象であり、この文書の発行日に有効です。これらのドキュメントは、このドキュメントに関するあなたの権利と制限を説明しているため、注意深く確認してください。
Table of Contents
目次
1. Introduction ....................................................2
2. Character Encoding ..............................................4
3. Figures and Artwork .............................................4
4. General Page Format Layout ......................................4
4.1. Headers and Footers ........................................5
4.2. Table of Contents ..........................................5
4.3. Line Width .................................................5
4.4. Line Spacing ...............................................5
4.5. Hyphenation ................................................5
5. Elements from the xml2rfc v3 Vocabulary .........................5
6. Security Considerations .........................................6
7. References ......................................................6
7.1. Normative References .......................................6
7.2. Informative References .....................................7
IAB Members at the Time of Approval ................................8
Acknowledgements ...................................................8
Author's Address ...................................................8
In 2013, after a great deal of community discussion, the decision was made to shift from the plain-text, ASCII-only canonical format for RFCs to XML as the canonical format [XML-ANNOUNCE]. The high-level requirements that informed this change were defined in [RFC6949], "RFC Series Format Requirements and Future Development". Plain text remains an important format for many in the IETF community, and it will be one of the publication formats rendered from the XML. This document outlines the rendering requirements for the plain-text RFC publication format. These requirements do not apply to plain-text RFCs published before the format transition.
2013年、コミュニティでの多くの議論の後、RFCのプレーンテキストのASCIIのみの正規形式から、正規形式[XML-ANNOUNCE]としてのXMLに移行することが決定されました。この変更を通知する高レベルの要件は、[RFC6949]の「RFCシリーズ形式の要件と将来の開発」で定義されています。プレーンテキストは、IETFコミュニティの多くにとって重要なフォーマットであり続け、XMLからレンダリングされる公開フォーマットの1つになります。このドキュメントでは、プレーンテキストのRFC公開形式のレンダリング要件について概説します。これらの要件は、フォーマット移行前に公開されたプレーンテキストRFCには適用されません。
The Unicode Consortium defines "plain text" as "Computer-encoded text that consists only of a sequence of code points from a given standard, with no other formatting or structural information.
Unicodeコンソーシアムは、「プレーンテキスト」を「特定の規格からのコードポイントのシーケンスのみで構成され、他のフォーマットや構造情報を含まない、コンピューターでエンコードされたテキスト」と定義しています。
Plain-text interchange is commonly used between computer systems that do not share higher-level protocols." [UNICODE-GLOSSARY]. In other words, plain-text files cannot include embedded character formatting or style information. The actual character encoding, however, is not limited to any particular sequence of code points.
プレーンテキストの交換は、上位レベルのプロトコルを共有しないコンピュータシステム間で一般的に使用されます。 "[UNICODE-GLOSSARY]。つまり、プレーンテキストファイルには、埋め込み文字フォーマットやスタイル情報を含めることができません。ただし、実際の文字エンコードコードポイントの特定のシーケンスに限定されません。
A plain-text output for RFCs will continue to be required for the foreseeable future. The process of converting xml2rfc version 2 (xml2rfc v2) into text documents is well understood [RFC7749]. We plan to rely on the practice to date to inform the requirements for converting xml2rfc version 3 (xml2rfc v3) to text [RFC7991]. This document calls out those requirements that are changed from v2 or otherwise deserve special attention, such as the requirements around the character encoding that may be used; changes in the page layout; and changes in how figures, artwork, and pagination may be handled. For more details on general style, see "RFC Style Guide" [RFC7322].
RFCのプレーンテキスト出力は、当面の間、引き続き必要です。 xml2rfcバージョン2（xml2rfc v2）をテキストドキュメントに変換するプロセスはよく理解されています[RFC7749]。 xml2rfcバージョン3（xml2rfc v3）をテキスト[RFC7991]に変換するための要件を通知するために、これまでのプラクティスに依存する予定です。このドキュメントでは、v2から変更された、または使用される可能性のある文字エンコードに関する要件など、特別な注意が必要な要件を説明しています。ページレイアウトの変更。図、アートワーク、ページネーションの処理方法の変更。一般的なスタイルの詳細については、「RFCスタイルガイド」[RFC7322]を参照してください。
The following assumptions drive the changes in the plain-text output for RFCs:
次の前提は、RFCのプレーンテキスト出力の変更を促進します。
o The existing tools used by the RFC Editor and many members of the author community to create the text file are complicated to change and support; manual manipulation is often required for the final output. In particular, handling page breaks and associated widows and orphans for paginated output is tricky [WIDOWS].
o RFCエディターと作成者コミュニティの多くのメンバーがテキストファイルを作成するために使用する既存のツールは、変更とサポートが複雑です。多くの場合、最終出力には手動操作が必要です。特に、改ページと、ページ分割された出力の関連する未亡人と孤児の処理は、トリッキーです[WIDOWS]。
o Additional publication formats -- for example, PDF, HTML -- will be available that will offer features such as markup and pretty printing.
o マークアップやきれいな印刷などの機能を提供する追加の発行形式（PDF、HTMLなど）が利用可能になります。
o There is an extensive tool chain in existence among the community to work with plain-text documents. Similar functionality may be possible with other publication formats, but the workflow that uses the existing tool chain should be supported as much as is considered practical.
o コミュニティには、プレーンテキストドキュメントを操作するための広範なツールチェーンが存在します。他のパブリケーションフォーマットでも同様の機能が可能かもしれませんが、既存のツールチェーンを使用するワークフローは、実用的であると考えられる限りサポートする必要があります。
Where practical, the original guidance for the structure of a plain-text RFC has been kept (e.g., with line lengths, with lines per page [INS2AUTH]). Other publication formats, such as HTML and PDF, will include additional features that will not be present in the plain text (e.g., paragraph numbering, typographical emphasis).
実用的な場合、プレーンテキストRFCの構造に関する元のガイダンスは維持されています（たとえば、行の長さ、ページあたりの行数[INS2AUTH]）。 HTMLやPDFなどの他の出版形式には、プレーンテキストにはない追加の機能が含まれます（例：段落番号、印刷上の強調）。
The details described in this document are expected to change based on experience gained in implementing the new publication toolsets. Revised documents will be published capturing those changes as the toolsets are completed. Other implementers must not expect those changes to remain backwards-compatible with the details described in this document.
このドキュメントで説明されている詳細は、新しいパブリケーションツールセットの実装で得られた経験に基づいて変更されることが予想されます。ツールセットが完成すると、変更されたドキュメントが公開され、変更が記録されます。他の実装者は、これらの変更がこのドキュメントで説明されている詳細との下位互換性を維持することを期待してはなりません。
Plain-text files for RFCs will use the UTF-8 [RFC3629] character encoding. That said, the use of non-ASCII characters will be only allowed in a limited and controlled fashion.
RFCのプレーンテキストファイルは、UTF-8 [RFC3629]文字エンコーディングを使用します。とはいえ、非ASCII文字の使用は、制限され制御された方法でのみ許可されます。
Many elements within the xml2rfc v3 vocabulary have an attribute for the ASCII equivalent to a non-ASCII character string. The ASCII equivalent will be rendered within the plain text as per the guidance in "The Use of Non-ASCII Characters in RFCs" [RFC7997]; please view the PDF version of that document.
xml2rfc v3ボキャブラリ内の多くの要素には、非ASCII文字列に相当するASCIIの属性があります。 「RFCでの非ASCII文字の使用」[RFC7997]のガイダンスに従って、ASCII同等のものはプレーンテキスト内にレンダリングされます。そのドキュメントのPDF版をご覧ください。
The plain-text file will include a Byte Order Mark (BOM) to provide text reader software with in-band information about the character encoding scheme used.
プレーンテキストファイルにはバイトオーダーマーク（BOM）が含まれており、テキストリーダーソフトウェアに、使用されている文字エンコード方式に関するインバンド情報が提供されます。
Artwork, such as network diagrams or performance graphs, must be tagged by the XML <artwork> element (see Section 2.5 of "The 'xml2rfc' Version 3 Vocabulary" [RFC7991]. Where this artwork is comprised of an ASCII art diagram, it must be tagged as "type='ascii-art'". The plain-text format will only include ASCII art. If the canonical format includes figures or artwork other than ASCII art, then the plain-text output must include a pointer to the relevant figure in the HTML version of the RFC to allow readers to see the relevant artwork.
ネットワークダイアグラムやパフォーマンスグラフなどのアートワークは、XML <artwork>要素でタグ付けする必要があります（「 'xml2rfc'バージョン3語彙」[RFC7991]のセクション2.5を参照）。このアートワークは、ASCIIアートダイアグラムで構成されています。 「type = 'ascii-art'」というタグを付ける必要があります。プレーンテキスト形式にはASCIIアートのみが含まれます。正規形式にASCIIアート以外の図やアートワークが含まれている場合、プレーンテキスト出力には、読者が関連するアートワークを見ることができるようにする、RFCのHTMLバージョンの関連する図。
Authors who wish to include ASCII art for the plain-text file and SVG art for the other outputs may do so, but they should be aware of the potential for confusion to individuals reading the RFC with two unique diagrams describing the same content. If there is conflicting information between the publication formats, please review the XML and PDF files to resolve the conflict.
プレーンテキストファイルにASCIIアートを、他の出力にSVGアートを含めることを希望する作成者は、そうすることができますが、同じ内容を説明する2つの固有の図でRFCを読んでいる個人が混乱する可能性を認識しておく必要があります。公開形式間に情報の矛盾がある場合は、XMLファイルとPDFファイルを確認して矛盾を解決してください。
One plain-text output will be created during the publication process with basic pagination that includes a form feed instruction every 58 lines at most, including blank lines. Instructions or a script will be made available by and for the community to strip out pagination as per individual preference.
公開プロセス中に、空白行を含めて最大58行ごとにフォームフィード指示を含む基本的なページ付けを使用して、1つのプレーンテキスト出力が作成されます。コミュニティーが個別の好みに応じてページ付けを取り除くための手順またはスクリプトが利用可能になります。
The front matter on the front page (such as the RFC number and category) and the back matter on the last page (the authors' full names and contact information) will continue with the structure described in RFC 7841 [RFC7841], "RFC Streams, Headers, and Boilerplates". Running headers and footers will no longer be added.
フロントページの前付け（RFC番号やカテゴリなど）と最後のページのバックマター（著者の氏名と連絡先情報）は、RFC 7841 [RFC7841]、「RFC Streams 、ヘッダー、およびボイラープレート」。実行中のヘッダーとフッターは追加されなくなります。
In order to retain similar content wherever possible between the various publication formats, the table of contents will list section and subsection numbers and titles but will not include page numbers.
さまざまな出版形式間で可能な限り同様のコンテンツを保持するために、目次にはセクションとサブセクションの番号とタイトルがリストされますが、ページ番号は含まれません。
Each line must be limited to 72 characters followed by the character sequence that denotes an end-of-line (EOL). The EOL sequence used by the RFC Editor will be the two-character sequence CR LF (Carriage Return followed by Line Feed). This limit includes any left-side indentation.
各行は72文字に制限され、その後に行末（EOL）を示す文字シーケンスが続きます。 RFC Editorで使用されるEOLシーケンスは、2文字のシーケンスCR LF（キャリッジリターンとそれに続くラインフィード）です。この制限には、左側のインデントが含まれます。
Note that the EOL used by the RFC Editor may change with different transports and as displayed in different display software.
RFCエディタで使用されるEOLは、異なるトランスポートや異なる表示ソフトウェアで表示される場合に変わる可能性があることに注意してください。
Use single-spaced text within a paragraph, and one blank line between paragraphs.
段落内ではシングルスペースのテキストを使用し、段落間では1行の空白行を使用します。
Hyphenated words (e.g., "Internet-Draft") should not be split across successive lines.
ハイフン付きの単語（「インターネットドラフト」など）は、連続する行に分割しないでください。
The plain-text formatter uses the relevant tags from the xml2rfc v3 source file to build a document conforming to the layout and structure described by the full RFC Style Guide [RFC7322] (including the updates in the web portion of the Style Guide) [STYLEWEB].
プレーンテキストフォーマッタは、xml2rfc v3ソースファイルの関連タグを使用して、完全なRFCスタイルガイド[RFC7322]（スタイルガイドのWeb部分の更新を含む）で説明されているレイアウトと構造に準拠したドキュメントを作成します[STYLEWEB ]。
The requirements of the plain-text format involve no significant security considerations. As part of the larger format project, however, unintended changes to the text as a result of the transformation from the base XML file could in turn corrupt a standard, practice, or critical piece of information about a protocol.
プレーンテキスト形式の要件には、セキュリティに関する重要な考慮事項は含まれていません。ただし、より大きなフォーマットのプロジェクトの一環として、ベースXMLファイルからの変換の結果としてテキストが意図せずに変更されると、プロトコルに関する標準、実践、または重要な情報が破損する可能性があります。
[RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO 10646", STD 63, RFC 3629, DOI 10.17487/RFC3629, November 2003, <http://www.rfc-editor.org/info/rfc3629>.
[RFC3629] Yergeau、F。、「UTF-8、ISO 10646の変換フォーマット」、STD 63、RFC 3629、DOI 10.17487 / RFC3629、2003年11月、<http://www.rfc-editor.org/info/ rfc3629>。
[RFC6949] Flanagan, H. and N. Brownlee, "RFC Series Format Requirements and Future Development", RFC 6949, DOI 10.17487/RFC6949, May 2013, <http://www.rfc-editor.org/info/rfc6949>.
[RFC6949] Flanagan、H。およびN. Brownlee、「RFCシリーズフォーマットの要件と将来の開発」、RFC 6949、DOI 10.17487 / RFC6949、2013年5月、<http://www.rfc-editor.org/info/rfc6949> 。
[RFC7322] Flanagan, H. and S. Ginoza, "RFC Style Guide", RFC 7322, DOI 10.17487/RFC7322, September 2014, <http://www.rfc-editor.org/info/rfc7322>.
[RFC7322] Flanagan、H。およびS. Ginoza、「RFCスタイルガイド」、RFC 7322、DOI 10.17487 / RFC7322、2014年9月、<http://www.rfc-editor.org/info/rfc7322>。
[RFC7749] Reschke, J., "The "xml2rfc" Version 2 Vocabulary", RFC 7749, DOI 10.17487/RFC7749, February 2016, <http://www.rfc-editor.org/info/rfc7749>.
[RFC7749] Reschke、J。、「The "xml2rfc" Version 2 Vocabulary」、RFC 7749、DOI 10.17487 / RFC7749、2016年2月、<http://www.rfc-editor.org/info/rfc7749>。
[RFC7841] Halpern, J., Ed., Daigle, L., Ed., and O. Kolkman, Ed., "RFC Streams, Headers, and Boilerplates", RFC 7841, DOI 10.17487/RFC7841, May 2016, <http://www.rfc-editor.org/info/rfc7841>.
[RFC7841] Halpern、J.、Ed。、Daigle、L.、Ed。、and O. Kolkman、Ed。、 "RFC Streams、Headers、and Boilerplates"、RFC 7841、DOI 10.17487 / RFC7841、May 2016、<http ：//www.rfc-editor.org/info/rfc7841>。
[RFC7991] Hoffman, P., "The "xml2rfc" Version 3 Vocabulary", RFC 7991, DOI 10.17487/RFC7991, December 2016, <http://www.rfc-editor.org/info/rfc7991>.
[RFC7991] Hoffman、P。、「The "xml2rfc" Version 3 Vocabulary」、RFC 7991、DOI 10.17487 / RFC7991、2016年12月、<http://www.rfc-editor.org/info/rfc7991>。
[RFC7997] Flanagan, H., Ed., "The Use of Non-ASCII Characters in RFCs", RFC 7997, DOI 10.17487/RFC7997, December 2016, <http://www.rfc-editor.org/info/rfc7997>.
[RFC7997] Flanagan、H.、Ed。、「The Use of Non-ASCII Characters in RFCs」、RFC 7997、DOI 10.17487 / RFC7997、2016年12月、<http://www.rfc-editor.org/info/rfc7997 >。
[INS2AUTH] RFC Editor, "Instructions to Request for Comments (RFC) Authors", August 2004, <https://www.rfc-editor.org/ materials/instructions2authors.txt>.
[INS2AUTH] RFC Editor、「Instructions to Request for Comments（RFC）Authors」、2004年8月、<https://www.rfc-editor.org/materials/instructions2authors.txt>。
[STYLEWEB] RFC Editor, "Web Portion of the Style Guide", February 2016, <http://www.rfc-editor.org/styleguide/part2/>.
[STYLEWEB] RFC Editor、「Web Portion of the Style Guide」、2016年2月、<http://www.rfc-editor.org/styleguide/part2/>。
[UNICODE-GLOSSARY] The Unicode Consortium, "Glossary of Unicode Terms", September 2016, <http://www.unicode.org/glossary/>.
[UNICODE-GLOSSARY] Unicodeコンソーシアム、「Unicode用語集」、2016年9月、<http://www.unicode.org/glossary/>。
[WIDOWS] Wikipedia, "Widows and orphans", September 2016, <https://en.wikipedia.org/w/ index.php?title=Widows_and_orphans&oldid=738356204>.
[WIDOWS]ウィキペディア、「未亡人と孤児」、2016年9月、<https://en.wikipedia.org/w/ index.php？title = Widows_and_orphans＆oldid = 738356204>。
[XML-ANNOUNCE] Flanagan, H., "Subject: Direction of the RFC Format Development effort", May 2013, <http://www.rfc-editor.org/pipermail/ rfc-interest/2013-May/005584.html>.
[XML-ANNOUNCE] Flanagan、H。、「件名：RFCフォーマット開発の取り組みの方向性」、2013年5月、<http://www.rfc-editor.org/pipermail/ rfc-interest / 2013-May / 005584。 html>。
IAB Members at the Time of Approval
承認時のIABメンバー
The IAB members at the time this memo was approved were (in alphabetical order):
このメモが承認されたときのIABメンバーは（アルファベット順）でした。
Jari Arkko Ralph Droms Ted Hardie Joe Hildebrand Russ Housley Lee Howard Erik Nordmark Robert Sparks Andrew Sullivan Dave Thaler Martin Thomson Brian Trammell Suzanne Woolf
ジャリアルコラルフドロムステッドハーディジョーヒルデブランドラスハウズリーリーハワードエリックノードマークロバートスパークスアンドリューサリバンデイブターラーマーティントムソンブライアントラメルスザンヌウルフ
Acknowledgements
謝辞
This document owes a great deal of thanks to the efforts of the RFC Format Design Team: Nevil Brownlee, Tony Hansen, Joe Hildebrand, Paul Hoffman, Ted Lemon, Julian Reschke, Adam Roach, Alice Russo, Robert Sparks, and David Thaler.
このドキュメントは、RFCフォーマットデザインチームの尽力に多大な感謝を寄せています。NevilBrownlee、Tony Hansen、Joe Hildebrand、Paul Hoffman、Ted Lemon、Julian Reschke、Adam Roach、Alice Russo、Robert Sparks、David Thaler。
Author's Address
著者のアドレス
Heather Flanagan RFC Editor
ヘザーフラナガンRFCエディター
Email: rse@rfc-editor.org
URI: http://orcid.org/0000-0002-2647-2220