[要約] このRFCは、PandocとXMLを使用してI-DsとRFCsを作成する方法を説明しています。目的は、より効率的で一貫性のあるドキュメント作成プロセスを提供することです。
Independent Submission R. Gieben
Request for Comments: 7328 Google
Category: Informational August 2014
ISSN: 2070-1721
Writing I-Ds and RFCs Using Pandoc and a Bit of XML
PandocとXMLを使用してI-DとRFCを作成する
Abstract
概要
This document presents a technique for using a Markdown syntax variant, called Pandoc, and a bit of XML (as defined in RFC 2629) as a source format for documents that are Internet-Drafts (I-Ds) or RFCs.
このドキュメントでは、Pandocと呼ばれるMarkdown構文のバリアントを使用するための手法と、インターネットドラフト（I-D）またはRFCであるドキュメントのソース形式として（RFC 2629で定義されている）XMLのビットを使用します。
The goal of this technique (which is called Pandoc2rfc) is to let an author of an I-D focus on the main body of text without being distracted too much by XML tags; however, it does not alleviate the need to typeset some files in XML.
この手法（Pandoc2rfcと呼ばれます）の目標は、I-Dの作成者がXMLタグに煩わされることなくテキストの本文に集中できるようにすることです。ただし、一部のファイルをXMLでタイプセットする必要が軽減されるわけではありません。
Status of This Memo
本文書の状態
This document is not an Internet Standards Track specification; it is published for informational purposes.
このドキュメントはInternet Standards Trackの仕様ではありません。情報提供を目的として公開されています。
This is a contribution to the RFC Series, independently of any other RFC stream. The RFC Editor has chosen to publish this document at its discretion and makes no statement about its value for implementation or deployment. Documents approved for publication by the RFC Editor are not a candidate for any level of Internet Standard; see Section 2 of RFC 5741.
これは、他のRFCストリームとは無関係に、RFCシリーズへの貢献です。 RFCエディターは、このドキュメントを独自の裁量で公開することを選択し、実装または展開に対するその価値については何も述べていません。 RFC Editorによって公開が承認されたドキュメントは、どのレベルのインターネット標準の候補にもなりません。 RFC 5741のセクション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/rfc7328.
このドキュメントの現在のステータス、エラータ、およびフィードバックの提供方法に関する情報は、http：//www.rfc-editor.org/info/rfc7328で入手できます。
Copyright Notice
著作権表示
Copyright (c) 2014 IETF Trust and the persons identified as the document authors. All rights reserved.
Copyright（c）2014 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. Pandoc to RFC . . . . . . . . . . . . . . . . . . . . . . . . 2
2.1. Dependencies . . . . . . . . . . . . . . . . . . . . . . 5
3. Building an Internet-Draft . . . . . . . . . . . . . . . . . 5
4. Supported Features . . . . . . . . . . . . . . . . . . . . . 5
5. Unsupported Features and Limitations . . . . . . . . . . . . 7
6. Pandoc Style . . . . . . . . . . . . . . . . . . . . . . . . 7
6.1. Figures . . . . . . . . . . . . . . . . . . . . . . . . . 7
6.2. Tables . . . . . . . . . . . . . . . . . . . . . . . . . 7
6.3. References . . . . . . . . . . . . . . . . . . . . . . . 7
6.4. Index . . . . . . . . . . . . . . . . . . . . . . . . . . 8
7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8
8. Security Considerations . . . . . . . . . . . . . . . . . . . 8
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 8
9.1. Normative References . . . . . . . . . . . . . . . . . . 8
9.2. Informative References . . . . . . . . . . . . . . . . . 9
Appendix A. Cheat Sheet . . . . . . . . . . . . . . . . . . . . 10
This document presents a technique for using a Markdown [Markdown] syntax variant, called Pandoc [Pandoc], and a bit of XML [RFC2629] as a source format for documents that are Internet-Drafts (I-Ds) or RFCs.
このドキュメントでは、Pandoc [Pandoc]と呼ばれるMarkdown [Markdown]構文バリアントを使用するための手法と、インターネットドラフト（I-D）またはRFCであるドキュメントのソース形式としてXMLのビット[RFC2629]を紹介します。
The goal of this technique is to let an author of an I-D focus on the main body of text without being distracted too much by XML tags; however, it does not alleviate the need to typeset some files in XML.
この手法の目標は、I-Dの作成者がXMLタグにあまり気を取られることなくテキストの本文に集中できるようにすることです。ただし、一部のファイルをXMLでタイプセットする必要が軽減されるわけではありません。
Pandoc is a format that is almost plain text and therefore particularly well suited for editing RFC-like documents. The syntax itself is a superset of the syntax championed by Markdown.
Pandocはほぼプレーンテキストの形式であるため、RFCのようなドキュメントの編集に特に適しています。構文自体は、Markdownが支持する構文のスーパーセットです。
Pandoc's syntax is easy to learn and write, and it can be translated to numerous output formats, including, but not limited to: HTML, EPUB, (plain) Markdown, and DocBook XML.
Pandocの構文は学習と記述が簡単で、HTML、EPUB、（プレーン）Markdown、DocBook XMLなど、さまざまな出力形式に変換できます。
Pandoc2rfc allows authors to write in Pandoc syntax that is then transformed to XML and given to xml2rfc. The conversions are, in a way, amusing, as we start off with (almost) plain text, use elaborate XML, and end up with plain text again.
Pandoc2rfcを使用すると、作成者はPandoc構文で記述し、XMLに変換してxml2rfcに渡すことができます。変換は、ある意味で、（ほとんど）プレーンテキストから始まり、精巧なXMLを使用し、最終的にプレーンテキストで終わるので、面白いです。
+-------------------+ pandoc +---------+
| ALMOST PLAIN TEXT | ------> | DOCBOOK |
+-------------------+ 1 +---------+
| |
non-existent | 2 | xsltproc
faster way | |
v v
+------------+ xml2rfc +---------+
| PLAIN TEXT | <-------- | XML |
+------------+ 3 +---------+
Figure 1: Attempt to justify Pandoc2rfc
図1：Pandoc2rfcを正当化する試み
The output of step 2 in Figure 1 is XML that is suitable for inclusion in either the "middle" or "back" section of an RFC.
図1のステップ2の出力は、RFCの「中間」または「戻る」セクションに含めるのに適したXMLです。
Even though Pandoc2rfc abstracts away a lot of XML details, there are still places left where XML files needs to be edited -- most notably in the "front" section of an RFC.
Pandoc2rfcは多くのXMLの詳細を抽象化していますが、XMLファイルを編集する必要がある場所が残っています。特に、RFCの「フロント」セクションにあります。
The simplest way to start using Pandoc2rfc is to create a template XML file and include the appropriate XML for the "front", "middle", and "back" section:
Pandoc2rfcの使用を開始する最も簡単な方法は、テンプレートXMLファイルを作成し、「front」、「middle」、および「back」セクションに適切なXMLを含めることです。
<?xml version='1.0' ?>
<!DOCTYPE rfc SYSTEM 'rfc2629.dtd' [
<!ENTITY pandocAbstract PUBLIC '' 'abstract.xml'>
<!ENTITY pandocMiddle PUBLIC '' 'middle.xml'>
<!ENTITY pandocBack PUBLIC '' 'back.xml'>
<!ENTITY rfc.2629 PUBLIC '' 'reference.RFC.2629.xml'>
]>
<rfc ipr='trust200902' docName='draft-string-example'>
<front>
<title>Writing I-Ds and RFCs using Pandoc</title>
<author>
<organization/>
<address><uri>http://www.example.com</uri></address>
</author>
<date/>
<abstract>
&pandocAbstract;
</abstract>
</front>
<middle>
&pandocMiddle;
</middle>
<back>
<references title="Normative References">
&rfc.2629;
</references>
&pandocBack;
</back>
</rfc>
Figure 2: A minimal template.xml
図2：最小限のtemplate.xml
In this case, you will need to edit four documents:
この場合、4つのドキュメントを編集する必要があります。
1. "abstract.mkd" - contains the abstract;
1. "abstract.mkd"-アブストラクトが含まれています。
2. "middle.mkd" - contains the main body of text;
2. "middle.mkd"-テキストの本文が含まれます。
3. "back.mkd" - holds the appendices (if any);
3. "back.mkd"-付録（ある場合）を保持します。
4. and this "template.xml" -- probably a fairly static file; among other things, it holds the author(s) and the references.
4. そして、この「template.xml」-おそらくかなり静的なファイルです。とりわけ、それは著者と参照を保持します。
Up-to-date source code for Pandoc2rfc can be found at [Pandoc2rfc]; this includes the style sheet "transform.xsl", which is used for the XML transformation (also see Section 3).
Pandoc2rfcの最新のソースコードは[Pandoc2rfc]にあります。これには、XML変換に使用されるスタイルシート "transform.xsl"も含まれます（セクション3も参照）。
Pandoc2rfc needs "xsltproc" [XSLT] and "pandoc" [Pandoc] to be installed. The conversion to xml2rfc XML is done with a style sheet based on XSLT version 1.0 [W3C.REC-xslt-19991116].
Pandoc2rfcには、「xsltproc」[XSLT]および「pandoc」[Pandoc]をインストールする必要があります。 xml2rfc XMLへの変換は、XSLTバージョン1.0 [W3C.REC-xslt-19991116]に基づくスタイルシートで行われます。
When using the template from Figure 2, xml2rfc version 2 (or higher) must be used.
図2のテンプレートを使用する場合、xml2rfcバージョン2（またはそれ以上）を使用する必要があります。
Assuming the setup from Section 2, we can build an I-D as follows (in a Unix-like environment):
セクション2の設定を想定すると、次のようにI-Dを構築できます（Unixのような環境）。
for i in abstract middle back; do
pandoc -st docbook $i.mkd | xsltproc --nonet transform.xsl - > $i.xml
done
xml2rfc template.xml -f draft.txt --text # create text output
xml2rfc template.xml -f draft.html --html # or create HTML output
xml2rfc template.xml -f draft.xml --exp # or create XML output
Figure 3: Building an I-D
図3：I-Dの構築
Note that the output file names (abstract.xml, middle.xml, and back.xml) must match the names used as the XML entities in "template.xml". (See the "!ENTITY" lines in Figure 2.) The Pandoc2rfc source repository includes a shell script that incorporates the above transformations. Creating a "draft.txt" or a "draft.xml" can be done with "pandoc2rfc *.mkd" and "pandoc2rfc -X *.mkd", respectively.
出力ファイル名（abstract.xml、middle.xml、およびback.xml）は、「template.xml」でXMLエンティティとして使用される名前と一致する必要があることに注意してください。 （図2の "！ENTITY"行を参照してください。）Pandoc2rfcソースリポジトリには、上記の変換を組み込んだシェルスクリプトが含まれています。 「draft.txt」または「draft.xml」の作成は、それぞれ「pandoc2rfc * .mkd」および「pandoc2rfc -X * .mkd」で実行できます。
The full description of Pandoc's syntax can be found in [PandocGuide]. The following features of xml2rfc are supported by Pandoc2rfc (also see Table 1 in Appendix A for a "cheat sheet"):
Pandocの構文の完全な説明は、[PandocGuide]にあります。 xml2rfcの次の機能がPandoc2rfcでサポートされています（「チートシート」については、付録Aの表1も参照してください）。
o Sections with an anchor and title attributes;
o アンカーとタイトル属性を持つセクション。
o Several list styles:
o いくつかのリストスタイル：
* style="symbols", use "* " for each item;
* style = "symbols"、各アイテムには "*"を使用します。
* style="numbers", use digits: "1. " for each item;
* style = "numbers"、数字を使用： "1."各アイテム。
* style="empty", use "#. " for each item;
* style = "empty"、各アイテムに「＃。」を使用します。
* style="format %i", use lowercase Roman numerals: "ii. ";
* style = "format％i"、小文字のローマ数字を使用： "ii。";
* style="format (%d)", use uppercase Roman numerals "II. ";
* style = "format（％d）"、大文字のローマ数字 "II。"を使用します。
* style="format ...", use strike-through text at the start in the first element, "1. ~~REQ%d.~~ ";
* style = "format ..."、最初の要素 "1. ~~ REQ％d。~~"の先頭に取り消し線テキストを使用します;
* style="letters", use lower- or uppercase letters: "a. " and "A. " (note: two spaces as mandated by Pandoc);
* style = "letters"、小文字または大文字を使用： "a。"および "A."（注：Pandocの指示どおりに2つのスペース）;
* style="hanging", use the Pandoc definition list syntax:
* style = "hanging"、Pandoc定義リスト構文を使用：
Term 1
期間1
: Definition 1
：定義1
o Spanx style="verb", style="emph", and style="strong", respectively, use: "`text`", "_text_" or "**text**";
o Spanx style = "verb"、style = "emph"、およびstyle = "strong"はそれぞれ、「 `text`」、「_ text_」、または「** text **」を使用します。
o Block quote, which is converted to a paragraph within a "<list style="empty">";
o "<list style =" empty ">"内の段落に変換されるブロック引用;
o Figures with an anchor and title (Section 6.1);
o アンカーとタイトルが付いた図（セクション6.1）。
o Tables with an anchor and title (Section 6.2);
o アンカーとタイトルが付いたテーブル（セクション6.2）。
o References (Section 6.3)
o 参照（セクション6.3）
* external ("<eref>");
* 外部（ "<eref>"）;
* cross-reference ("<xref>"), to:
* 以下への相互参照（ "<xref>"）
+ sections (handled by Pandoc);
+ セクション（Pandocが処理）;
+ figures (handled by XSLT);
+ 図（XSLTで処理）;
+ tables (handled by XSLT).
+ テーブル（XSLTによって処理されます）。
o Index, by using footnotes and superscript text (Section 6.4);
o 脚注と上付きテキストを使用して索引を付ける（6.4節）。
o Citations, by using cross-references;
o 相互参照を使用した引用。
o Processing Instructions (PIs), which appear as "<?rfc?>", may be used after a section header. They are carried over to the generated XML.
o 「<？rfc？>」として表示される処理命令（PI）は、セクションヘッダーの後に使用できます。生成されたXMLに引き継がれます。
o The "<vspace>" tag is supported and carried over to the generated XML.
o 「<vspace>」タグがサポートされ、生成されたXMLに引き継がれます。
With Pandoc2rfc, an author of an I-D can get a long way without needing to input XML, but it is not a 100% solution. The initial setup and the reference library still force the author to edit XML files. The metadata feature (Pandoc's "Title Block" extension) is not used in Pandoc2rfc. This information (authors, date, keyword, and URLs) should be put in the "template.xml".
Pandoc2rfcを使用すると、I-Dの作成者はXMLを入力しなくても長い道のりをたどることができますが、100％のソリューションではありません。初期設定と参照ライブラリにより、作成者はXMLファイルを編集する必要があります。メタデータ機能（Pandocの「タイトルブロック」拡張）は、Pandoc2rfcでは使用されません。この情報（作成者、日付、キーワード、およびURL）は、「template.xml」に配置する必要があります。
Some other quirks:
他のいくつかの癖：
o Comments are supported via HTML comments in the Pandoc source files.
o コメントは、PandocソースファイルのHTMLコメントを介してサポートされます。
o Citations are supported via cross-references; the citation syntax of Pandoc is not used.
o 引用は相互参照を介してサポートされます。 Pandocの引用構文は使用されません。
o Authors still need to know how to deal with possible errors from xml2rfc.
o 作成者は、xml2rfcから発生する可能性のあるエラーに対処する方法を知る必要があります。
The following sections detail how to use the Pandoc syntax for figures, tables, and references to get the desired output.
以下のセクションでは、図、表、および参照のPandoc構文を使用して目的の出力を取得する方法について詳しく説明します。
Indent the paragraph with 4 spaces as mandated by Pandoc. If you add an inline footnote _directly_ after the figure, the artwork gets a title attribute with the text of that footnote (and a possible anchor).
Pandocの指示に従って、段落を4つのスペースでインデントします。図の後ろにインライン脚注を直接追加すると、アートワークはその脚注のテキスト（およびアンカー）を含むタイトル属性を取得します。
A table can be entered by using Pandoc's table syntax. You can choose multiple styles as input, but they all are converted to the same style table (plain "<texttable>") in xml2rfc. If you add an inline footnote _directly_ after the table, it will get a title attribute with the text of that footnote (and a possible anchor). The built-in syntax of Pandoc to create a caption with "Table:" should not be used.
Pandocのテーブル構文を使用してテーブルを入力できます。複数のスタイルを入力として選択できますが、それらはすべてxml2rfcの同じスタイルテーブル（プレーンな "<texttable>"）に変換されます。インライン脚注をテーブルの後ろに直接追加すると、その脚注のテキスト（およびアンカー）を含むタイトル属性が取得されます。 「テーブル：」でキャプションを作成するためのPandocの組み込み構文は使用しないでください。
Pandoc provides a syntax that can be used for references. Its syntax is repeated in this paragraph. Any reference like "[Click here](URI)" is an external reference. An internal reference (i.e., "see Section X") is typeset with "[](#localid)".
Pandocは、参照に使用できる構文を提供します。その構文はこの段落で繰り返されます。 「[ここをクリック]（URI）」のような参照はすべて外部参照です。内部参照（つまり、「セクションXを参照」）は、「[]（＃localid）」でタイプセットされます。
For referencing RFCs (and other documents), you will need to add the reference source in the template as an external XML entity; Figure 2 provides an example. After that, you can use the following syntax to create a citation: "[](#RFC2629)" to cite RFC 2629.
RFC（およびその他のドキュメント）を参照するには、テンプレートに参照ソースを外部XMLエンティティとして追加する必要があります。図2に例を示します。その後、次の構文を使用して引用を作成できます： "[]（＃RFC2629）" RFC 2629を引用します。
There is no direct support for referencing tables, figures, and artworks, but Pandoc2rfc employs the following "hack". If an inline footnote is added after the figure or table, the text of the footnote is used as the title. The first word up until a double colon "::" will be used as the anchor. If a figure has an anchor, it will be centered on the page.
テーブル、図、アートワークの参照は直接サポートされていませんが、Pandoc2rfcは次の「ハック」を採用しています。図または表の後にインライン脚注を追加すると、脚注のテキストがタイトルとして使用されます。ダブルコロン「::」までの最初の単語がアンカーとして使用されます。図にアンカーがある場合は、ページの中央に配置されます。
Figure 2, for instance, is followed by this inline footnote:
たとえば、図2の後には、このインライン脚注が続きます。
^[fig:minimal::A minimal template.xml.]
An index can be generated by using the following syntax:
インデックスは、次の構文を使用して生成できます。
^[ ^item^ subitem ]
where "subitem" is optional.
「サブアイテム」はオプションです。
The following people have helped shape Pandoc2rfc: Benno Overeinder, Erlend Hamnaberg, Matthijs Mekking, and Trygve Laugstoel.
以下の人々がPandoc2rfcを形作るのを助けました：Benno Overeinder、Erlend Hamnaberg、Matthijs Mekking、およびTrygve Laugstoel。
This document raises no security issues.
このドキュメントはセキュリティ上の問題を引き起こしません。
[RFC2629] Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629, June 1999.
[RFC2629] Rose、M。、「Writing I-Ds and RFCs using XML」、RFC 2629、1999年6月。
[W3C.REC-xslt-19991116] Clark, J., "XSL Transformations (XSLT) Version 1.0", World Wide Web Consortium Recommendation REC-xslt-19991116, November 1999, <http://www.w3.org/TR/1999/REC-xslt-19991116>.
[W3C.REC-xslt-19991116]クラークJ。、「XSL Transformations（XSLT）Version 1.0」、World Wide Web Consortium Recommendation REC-xslt-19991116、1999年11月、<http://www.w3.org/TR / 1999 / REC-xslt-19991116>。
[XSLT] Veillard, D., "The XSLT C library for GNOME", 2006, <http://xmlsoft.org/XSLT/xsltproc2.html>.
[XSLT] Veillard、D。、「GNOME用のXSLT Cライブラリ」、2006、<http://xmlsoft.org/XSLT/xsltproc2.html>。
[Markdown] Gruber, J., "Markdown", 2004, <http://daringfireball.net/projects/markdown/>.
[Markdown] Gruber、J。、「Markdown」、2004、<http://daringfireball.net/projects/markdown/>。
[Pandoc] MacFarlane, J., "Pandoc, a universal document converter", 2006, <http://johnmacfarlane.net/pandoc/>.
[Pandoc] MacFarlane、J。、「Pandoc、ユニバーサルドキュメントコンバーター」、2006、<http://johnmacfarlane.net/pandoc/>。
[Pandoc2rfc] Gieben, R., "Pandoc2rfc git repository", October 2012, <http://github.com/miekg/pandoc2rfc>.
[Pandoc2rfc] Gieben、R。、「Pandoc2rfc gitリポジトリ」、2012年10月、<http://github.com/miekg/pandoc2rfc>。
[PandocGuide] MacFarlane, J., "Pandoc User's Guide", 2006, <http://johnmacfarlane.net/pandoc/README.html>.
[PandocGuide] MacFarlane、J。、「Pandoc User's Guide」、2006、<http://johnmacfarlane.net/pandoc/README.html>。
+---------------------+-----------------+--------------+
| Textual construct | Pandoc syntax | Text output |
+---------------------+-----------------+--------------+
| Section Header | "# Section" | 1. Section |
| Unordered List | "* item" | o item |
| Unordered List | "#. item" | item |
| Ordered List | "1. item" | 1. item |
| Ordered List | "a. item" | a. item |
| Ordered List | "ii. item" | i. item |
| Ordered List | "II. item" | (1) item |
| Ordered List | "A. item" | A. item |
| Ordered List | "1. ~~REQ%d.~~" | REQ1. |
| Emphasis | "_text_" | _text_ |
| Strong Emphasis | "**text**" | *text* |
| Verbatim | "`text`" | "text" |
| Block Quote | "> quote" | quote |
| External Reference | "[Click](URI)" | Click [1] |
| Internal Reference | "[](#id)" | Section 1 |
| Figure Anchor | "^[fid::text]" | N/A |
| Figure Reference | "[](#fid)" | Figure 1 |
| Table Anchor | "^[tid::text]" | N/A |
| Table Reference | "[](#tid)" | Table 1 |
| Citations | "[](#RFC2119)" | [RFC2119] |
| Table | Tables | * |
| Figures | Code Blocks | * |
| Definition List | Definition | * |
| Index | ^[ ^item^ ] | * |
+---------------------+-----------------+--------------+
* This construct creates output too voluminous to show in the table.
* この構成では、表に表示するには大きすぎる出力が作成されます。
Table 1: The most important textual constructs that can be used in Pandoc2rfc
表1：Pandoc2rfcで使用できる最も重要なテキスト構造
Author's Address
著者のアドレス
R. (Miek) Gieben Google
R.（ミーク）ギーベングーグル
EMail: miek@google.com