Independent Submission R. Gieben
Request for Comments: 7328 Google
Category: Informational August 2014
ISSN: 2070-1721
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）和一点XML（在RFC 2629中定义）作为Internet草稿（I-D）或RFC文档的源格式的技术。
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.
本文件不是互联网标准跟踪规范；它是为了提供信息而发布的。
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编辑批准发布的文件不适用于任何级别的互联网标准；见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.
版权所有（c）2014 IETF信托基金和确定为文件作者的人员。版权所有。
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
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.
本文档介绍了一种使用Markdown[Markdown]语法变体（称为Pandoc[Pandoc]）和少量XML[RFC2629]作为Internet草稿（I-D）或RFC文档的源格式的技术。
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、（普通）标记和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 +---------+
+-------------------+ 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文件，并为“前面”、“中间”和“后面”部分包含适当的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'>
]>
<?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>
<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:
在这种情况下，您需要编辑四个文档：
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
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
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源存储库包含一个包含上述转换的shell脚本。可以分别使用“pandoc2rfc*.mkd”和“pandoc2rfc-X*.mkd”创建“draft.txt”或“draft.xml”。
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"):
潘多克语法的完整描述可在[PandocGuide]中找到。Pandoc2rfc支持xml2rfc的以下功能（参见附录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=“number”，每个项目使用数字：“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.~~请求%d.~~”的开头使用贯穿文本；
* style="letters", use lower- or uppercase letters: "a. " and "A. " (note: two spaces as mandated by Pandoc);
* style=“letters”，使用小写或大写字母：“a.”和“a.”（注：Pandoc规定的两个空格）；
* style="hanging", use the Pandoc definition list syntax:
* style=“hanging”，使用Pandoc定义列表语法：
Term 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**”；
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的内置语法来创建带有“Table:”的标题。
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采用了以下“hack”。如果在图形或表格后添加内嵌脚注，则脚注的文本将用作标题。第一个单词直到一个双冒号“：”将用作锚。如果一个图形有一个定位点，它将在页面上居中。
Figure 2, for instance, is followed by this inline footnote:
例如，图2后面紧跟着这个内联脚注：
^[fig:minimal::A minimal template.xml.]
^[fig:minimal::A minimal template.xml.]
An index can be generated by using the following syntax:
可以使用以下语法生成索引：
^[ ^item^ subitem ]
^[ ^item^ subitem ]
where "subitem" is optional.
其中“子项”是可选的。
The following people have helped shape Pandoc2rfc: Benno Overeinder, Erlend Hamnaberg, Matthijs Mekking, and Trygve Laugstoel.
以下人士帮助塑造了Pandoc2rfc：本诺·奥弗林德、厄伦德·哈姆纳贝格、马提斯·梅金和特里格夫·劳格斯托尔。
This document raises no security issues.
本文件不涉及任何安全问题。
[RFC2629] Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629, June 1999.
[RFC2629]Rose，M.，“使用XML编写I-D和RFC”，RFC 26292999年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]Clark，J.，“XSL转换（xslt）1.0版”，万维网联盟建议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]格鲁伯，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]麦克法兰，J.，“Pandoc用户指南”，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^ ] | * |
+---------------------+-----------------+--------------+
+---------------------+-----------------+--------------+
| 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.（Miek）Gieben谷歌
EMail: miek@google.com
EMail: miek@google.com