|
Warning
|
This gem has been subsumed into the Metanorma publishing framework. Development of AsciiRFC is continued at the metanorma-ietf gem. Please see the new repo for details on usage instructions. Thank you for your support. |
|
Warning
|
While the RFC XML v2 output of this gem is still valid, the RFC XML v3
output of the gem will not work with the updated xml2rfc tool, as this gem'
does not include the modifications to RFC XML v3 subsequent to RFC 7991.
Use metanorma-ietf to generate valid RFC XML v3 output.
|
asciidoctor-rfc lets you write Internet-Drafts and RFCs in AsciiDoc, the “asciidoctor-way”.
The “xml2rfc” Vocabulary (hereinafter “RFC XML”) is an XML-based language used for writing Internet-Drafts and RFCs (RFC7322).
This gem allows you to author these types of documents in AsciiDoc, and outputs RFC XML output in both v3 and v2 formats:
Its syntax is designed to be “native-asciidoctor” as much as possible, with some templated use of attributes to convey added information for RFC XML output.
We refer to the version of Asciidoc markup processed by this gem as AsciiRFC.
This README documents the AsciiRFC markup in full detail. For further information about AsciiRFC, please refer to the AsciiRFC IETF Internet-Draft.
Add this line to your application’s Gemfile:
gem "asciidoctor-rfc"And then execute:
$ bundleOr install it yourself as:
$ gem install asciidoctor-rfcClone the
rfc-asciirfc-minimal
repository as a template, and populate it for your Asciidoc RFCs and
Internet-Drafts:
$ git clone https://github.com/metanorma/rfc-asciirfc-minimalSee the README of that document for more information.
Illustrating with v2 RFC XML, and Internet Draft rather than RFC
= A Standard for the Transmission of IP Datagrams on Avian Carriers
David Waitzman <dwaitzman@BBN.COM>
:doctype: internet-draft
:abbrev: IP Datagrams on Avian Carriers
:obsoletes: 10, 120
:updates: 2010, 2120
:status: informational
:name: internet-draft-avian-transmission-00
:ipr: trust200902
:area: Internet
:workgroup: Network Working Group
:keyword: avians, datagrams
:revdate: 1990-04-01T00:00:00Z
:organization: BBN STC
:phone: (617) 873-4323
:uri: http://bbn.com
:street: 10 Moulton Street
:city: Cambridge
:code: MA 02238
[abstract]
Avian carriers can provide high delay, low throughput, and low
altitude service. The connection topology is limited to a single
point-to-point path for each carrier, used with standard carriers,
but many carriers can be used without significant interference with
each other, outside of early spring. This is because of the 3D ether
space available to the carriers, in contrast to the 1D ether used by
IEEE802.3. The carriers have an intrinsic collision avoidance
system, which increases availability. Unlike some network
technologies, such as packet radio, communication is not limited to
line-of-sight distance. Connection oriented service is available in
some cities, usually based upon a central hub topology.
NOTE: Yes, this is an April Fool's RFC.
[[frame]]
== Frame Format
The IP _datagram_ is *printed*, on a small scroll of paper, in
hexadecimal, with each octet separated by whitestuff and blackstuff.
The scroll of paper is wrapped around one leg of the avian carrier.
A band of duct tape is used to secure the datagram's edges. The
bandwidth is limited to the leg length. The MTU is variable, and
paradoxically, generally increases with increased carrier age. A
typical MTU is 256 milligrams. Some datagram padding may be needed.<<RFC7253>>
[bibliography]
== Normative References
++++
<reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119">
<front>
<title>Key words for use in RFCs to Indicate Requirement Levels</title>
<author initials="S." surname="Bradner" fullname="S. Bradner">
<organization/>
</author>
<date year="1997" month="March"/>
<abstract>
<t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
</abstract>
</front>
<seriesInfo name="BCP" value="14"/>
<seriesInfo name="RFC" value="2119"/>
<seriesInfo name="DOI" value="10.17487/RFC2119"/>
</reference>
++++
[bibliography]
== Informative References
++++
<reference anchor='RFC7253' target='https://tools.ietf.org/html/rfc7253'>
<front>
<title>Guidelines for Writing an IANA Considerations Section in RFCs</title>
<author initials="T." surname="Krovetz">
<organization>Sacramento State</organization>
</author>
<author initials="P." surname="Rogaway">
<organization>UC Davis</organization>
</author>
<date month='May' year='2014'/>
</front>
<seriesInfo name="RFC" value="7253"/>
</reference>
++++Converting your AsciiDoc to RFC XML is a simple as running the appropriate
./bin/asciidoctor-rfc script using Ruby, and passing your
AsciiDoc document file as the first argument.
Usually you would use the asciidoctor executable, specifying this gem as a
library:
$ asciidoctor -b rfc3 -r 'asciidoctor-rfc' a.adoc # RFC XML v3 output
$ asciidoctor -b rfc2 -r 'asciidoctor-rfc' a.adoc # RFC XML v2 outputor through the included bin-stub:
$ ./bin/asciidoctor-rfc3 draft-example-00.adoc # RFC XML v3 output
$ ./bin/asciidoctor-rfc2 draft-example-00.adoc # RFC XML v2 outputWhen the script completes, you should see the RFC XML file draft-example-00.xml in the
same directory.
The converter follows native AsciiDoc/asciidoctor syntax as much as possible, including built-in attributes and styles.
Extension commands are provided to fully support writing an Internet-Draft/RFC in AsciiDoc/asciidoctor syntax.
|
Note
|
The document model of Asciidoctor and RFC XML are different. In particular,
As a result, it may be necessary to postedit the RFC XML output, if the block model produced does not reflect the intended structure accurately. |
|
Note
|
The gem validates all RFC XML generated through the RELAXNG schema definitions of RFC XML. While the gem attempts to generate valid RFC XML, some Asciidoctor text may not align with the RFC XML document model, and any highlighted syntax errors will also need to be rectified in postediting, before processing the generated XML further. |
|
Note
|
A summary guide to authoring RFC XML in Asciidoctor is also available at https://tools.ietf.org/html/draft-ribose-asciirfc-02 (with source at https://github.com/metanorma/rfc-asciidoc-rfc ). |
Set the doctype attribute to set status of this document:
:doctype: internet-draft sets the document as an Internet-Draft (default value):
-
rfc/front/seriesInfo@nameattribute will be set toInternet-Draft(in v3) -
rfc/front/seriesInfo@valuewill be set to the:name:attribute, stripping any file suffixes, but including any draft number; e.g.draft-ietf-somewg-someprotocol-07(in v3) -
rfc@docNamewill be set to the:name:attribute (in v2)
:doctype: rfc sets the document as an RFC:
-
rfc/front/seriesInfo@nameattribute will be set toRFC(in v3) -
rfc/front/seriesInfo@valuewill be set to the:name:attribute, stripping the initialrfc-prefix and any file suffixes (in v3) -
rfc@numberwill be set to the:name:attribute (in v2)
| Attribute | Purpose |
|---|---|
|
Optional. Default value |
|
Optional. Default value |
|
Optional. Default value |
|
Optional. Default value |
|
Optional. Name of directory. If present, gives the name of a directory from which RFC XML references are to be read into the document, rather than assuming the references are already present in the document. |
|
Optional. Comma-delimited list of reference anchors. Used in conjunction with |
Any of these global options can also be included in the command line call, for either
the asciidoctor executable or the local bin-stubs, through the command line option -a;
e.g.
$ asciidoctor -a flush-biblio=true -b rfc3 -r 'asciidoctor-rfc' a.adoc
$ ./bin/asciidoctor-rfc2 -a smart-quotes=false draft-example-00.adocThe cache of externally addressable bibliographic information is built from screenscraping the contents of:
The cache of current IETF and IRTF workgroups is built from screenscraping the contents of:
The caches are not rebuilt daily, as the bibliographic cache is with xml2rfc. If you want to refresh the caches,
-
delete your
~/.asciidoc-rfc-biblio-cache.jsonand~/.asciidoc-rfc-workgroup-cache.jsonfiles; -
insert the document attribute
:flush-caches: trueinto the header of the document being processed; or -
run the asciidoctor executable with option
-a flush-caches=true(which has the same effect).
asciidoctor-rfc allows setting the RFC XML document header using the following
document attributes. Complying with AsciiDoc syntax, no blank lines are
permitted between the title, listing of authors, and the document attributes.
Also following AsciiDoc syntax, character entities will be ignored in the document
header: in the header for example will be rendered as .
Shared RFC XML v3/v2 syntax:
| Attribute | Purpose | RFC XML v2/v3 element |
|---|---|---|
|
Mandatory. Title of document. |
|
|
Mandatory. Abbreviation of document title. Usually the document name without
the keyword |
|
|
Mandatory. IP status of document. See
here. Defaults to
|
|
|
Optional. Identifies a section that can be extracted from text. See here. |
|
|
Optional. A comma-separated list of RFC numbers or Internet-Draft names that
this document obsoletes. Delimited by |
|
|
Optional. A comma-separated list of RFC numbers or Internet-Draft names that
this document updates. Delimited by |
|
|
Optional. Document stream of document described in
RFC7841. Allowed values: |
|
|
Optional. Latest revision date of document. Default value is current time.
Accepts ISO 8601 date. Also accepts YYYY year, and YYYY[-]MM year/month.
For consistency with AsciiDoc, |
|
|
Optional. Comma delimited text on which IETF area this document relates to. Value should "be either the full name or the abbreviation of one of the IETF areas as listed on http://www.ietf.org/iesg/area.html". See here. |
|
|
Optional. Comma delimited text on which IETF or IRTF workgroup or research group this document originates from. See here. |
|
|
Optional. Comma delimited text for singular keywords used for RFC index and metadata. |
|
The xml2rfc tool accepts processing instructions of the form <?rfc keyword='value'?>:
see https://xml2rfc.tools.ietf.org/authoring/README.html#processing.instructions .
(Of these, sort-refs, sym-refs and toc-include are also present in the
v3 RFC XML specifcation, as attributes of the
root rfc element: v3-specific document attributes.)
Those processing instructions which apply to the entire document can also be
specified for this gem as document options.
| keyword | meaning |
|---|---|
artworkdelimiter |
when producing txt or nroff files, use this string to delimit artwork |
artworklines |
when producing txt or nroff files, add this many blank lines around artwork |
authorship |
render author information |
autobreaks |
automatically force page breaks to avoid widows and orphans (not perfect) |
background |
when producing a html file, use this image |
colonspace |
put two spaces instead of one after each colon (":") in txt or nroff files |
comments |
render <cref> information |
compact |
when producing a txt/nroff file, try to conserve vertical whitespace (the default value is the current value of the rfcedstyle PI) |
docmapping |
use hierarchical tags (e.g., <h1>, <h2>, etc.) for (sub)section titles |
editing |
insert editing marks for ease of discussing draft versions |
emoticonic |
automatically replaces input sequences such as |*text| by, e.g., <strong>text</strong> in html output |
footer |
override the center footer string |
header |
override the leftmost header string |
inline |
if comments is "yes", then render comments inline; otherwise render them in an "Editorial Comments" section |
iprnotified |
include boilerplate from Section 10.4(d) of http://tools.ietf.org/html/rfc2026 |
linkmailto |
generate mailto: URL, as appropriate |
linefile |
a string like "35:file.xml" or just "35" (file name then defaults to the containing file’s real name or to the latest linefile specification that changed it) that will be used to override xml2rfc’s reckoning of the current input position (right after this PI) for warning and error reporting purposes (line numbers are 1-based) |
notedraftinprogress |
generates "(work in progress)", as appropriate |
private |
produce a private memo rather than an RFC or Internet-Draft |
refparent |
title of the top-level section containing all references |
rfcedstyle |
attempt to closely follow finer details from the latest observable RFC-Editor style so as to minimize the probability of being sent back corrections after submission; this directive is a kludge whose exact behavior is likely to change on a regular basis to match the current flavor of the month; presently, it will capitalize the adjective "This" in automatically generated headings, use the variant "acknowledgement" spelling instead of Merriam Webster’s main "acknowledgment" dictionary entry, use the "eMail" spelling instead of Knuth’s more modern "email" spelling, only put one blank line instead of two before top sections, omit "Intellectual Property and Copyright Statements" and "Author’s Address" from the table of content, and not limit the indentation to a maximum tag length in <references> sections. |
rfcprocack |
if there already is an automatically generated Acknowledg(e)ment section, pluralize its title and add a short sentence acknowledging that xml2rfc was used in the document’s production to process an input XML source file in RFC-2629 format |
slides |
when producing a html file, produce multiple files for a slide show |
sort-refs |
( |
strict |
try to enforce the ID-nits conventions and DTD validity |
subcompact |
if compact is "yes", then you can make things a little less compact by setting this to "no" (the default value is the current value of the compact PI) |
sym-refs |
( |
text-list-symbols |
modify the list of symbols used (when generated text) for list type="symbols". For example, specifying "abcde" will cause "a" to be used for 1st level, "b" for the 2nd level, etc, cycling back to the first character "a" at the 6th level. Specifying "o*" will cause the characters "o" and "*" to be alternated for each successive level. |
toc-include |
( |
tocappendix |
control whether the word "Appendix" appears in the table-of-content |
toc-depth |
if toc is "yes", then this determines the depth of the table-of-contents |
tocindent |
if toc is "yes", then setting this to "yes" will indent subsections in the table-of-contents |
tocnarrow |
affects horizontal spacing in the table-of-content |
tocompact |
if toc is "yes", then setting this to "no" will make it a little less compact |
topblock |
put the famous header block on the first page |
useobject |
when producing a html file, use the <object> html element with inner replacement content instead of the <img> html element, when a source xml element includes an src attribute |
Exceptionally, compact, toc-include, sym-refs, sort-refs and strict are is set by default to yes, subcompact to no, and toc-depth to 4.
The additional document option rfc2629xslt (default value: true) injects into the document header the processing
instruction <?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>, which impacts on the output of xml2rfc.
The name attribute sets the document’s name. This should be a number if
the document is an RFC, and a name (in the form of draft-ietf-somewg-someprotocol-07)
if it is an Internet-Draft.
When doctype is set to:
-
internet-draft: the value should be in the formdraft-ietf-somewg-someprotocol-07.-
v3: the
front/seriesInfo@valuewill be set to this value. -
v2: the
rfc@docNamewill be set to this value.
-
-
rfc: the value should be a number like7991as described here-
v3: the
front/seriesInfo@valuewill be set to this value. -
v2: the
rfc@numberwill be set to this value.
-
Set the status attribute to set the current status of this document.
The following values are allowed: standard, informational, experimental, bcp, fyi,
full-standard (v3 only), historic (v2 only).
-
In v3, this sets the first
front/seriesInfoelement with@statusas one of:standard,informational,experimental,bcp,fyi,full-standard. -
In v2, this sets the
rfc@categoryvalue as one ofstd,info,exp,bcp,historic.
Set the intended-series attribute to set the intended series of this
document.
The following values are allowed: standard, informational, experimental, bcp, fyi, full-standard.
When doctype is set to:
-
internet-draft: this value can be one ofstandard,full-standard,bcp,fyi,informational,experimental, orhistoricto indicate the intended series once the document is published as an RFC.-
In v3, this sets a second
front/seriesInfoelement with@statusas one of those values, and an empty@name, to indicate this. -
In v2, this sets the
front@categoryvalue to one ofstd,bcp,info,exp,historic.
-
-
rfc: this value can be either:-
one of
full-standard,bcporfyi, to indicate the current status of this document, followed by the number of the document within the series; e.g.full-standard 1234,bcp 14. -
exp,info, orhistoric. (experimentalandinformationalwill be accepted by the gem as synonyms.) -
In v3, this sets a second
front/seriesInfoelement with@statusas one of those values, and an empty@name, to indicate this. -
In v2, this sets the
front@categoryvalue to one ofstd,bcp,info. (While in v2, the valuesexp,historicare also possible for a RFC, our gem does not support it.)
-
Set document submission type via the submission-type document attribute.
The following values are allowed: IETF (default), independent, IAB, and IRTF.
-
In v3, the
rfc@submissionTypeandrfc/front/seriesInfo@streamattributes are set to this value. -
In v2, the
rfc@submissionTypeis set to this value
Set document consensus type via the consensus document attribute.
These values are accepted: false, true.
-
In v3, this is the value set for the
rfc@consensusattribute. -
In v2, this is the value set for the
rfc@consensusattribute, butfalseis converted tonoandtrueis converted toyes.
Set the document language using the xml-lang document attribute.
By default this is en.
-
In v3 and v2, this is the value set for the
rfc@xml:langattribute.
While v3 supports marking specific elements with their own xml:lang attribute, this is not yet supported by our gem.
These attributes are only supported for the v2 converter.
| Attribute | Purpose | RFC XML v3 element |
|---|---|---|
|
Optional. The document series is defined by the "category" attribute; "seriesNo" is only applicable to the values "info" ("FYI" series), "std" ("STD" series), and "bcp" ("BCP" series). |
|
These attributes are only supported for the v3 converter.
| Attribute | Purpose | RFC XML v3 element |
|---|---|---|
|
Optional. Defaults to |
|
|
Optional. Defaults to |
|
|
Optional. Defaults to |
|
|
Optional. Defaults to |
|
|
Optional. Comma-delimited links to an external document related to this document. There are 4 types of values:
|
|
In an Internet-Draft/RFC, detailed information of an author is necessary, which is not supported by the normal AsciiDoc syntax.
You will need to provide the following information.
Just like a normal AsciiDoc, you can provide author information in the author header (sample of 3 authors):
firstname middlename(s) lastname <email>; firstname middlename(s) lastname <email>; firstname middlename(s) lastname <email>These will be mapped as follows:
| Syntax | Purpose | RFC XML v3/v2 element |
|---|---|---|
|
Mandatory (at least one). Author’s full name. (Middle names are optional.) |
|
|
Author’s last name. |
|
|
Author’s email address. |
|
If any author names deviate from that pattern, e.g. with an honorific like Dr.,
they will not be recognised correctly by the Asciidoc API; use the fullname
document attribute instead.
In asciidoctor-rfc, detailed author attributes are given as document
attributes.
As multiple authors can be specified, the document attribute to specify the
first author uses a unsuffixed attribute name :role, and the second author’s
attributes onwards use a numeric suffix to identify the author: :role_2, :role_3, etc.
Shared RFC XML v3/v2 syntax:
| Attribute | Purpose | RFC XML v3/v2 element |
|---|---|---|
|
Optional. Author’s full name. Can set here instead of document header’s “Author” line. |
|
|
Optional. Author’s initials excluding surname. Defaults to dynamically
calculated initials. Distinct from the AsciiDoc |
|
|
Optional. Author’s last name. Can set here instead of document header’s “Author” line. |
|
|
Optional. Defaults to |
|
|
Optional. Defaults to |
|
|
Optional. Defaults to |
|
|
Note
|
You can provide organization information without providing name information for an author. |
| Attribute | Purpose | RFC XML v2/v3 element |
|---|---|---|
|
Email of author. |
|
|
Fax number of author. Deprecated in v3. |
|
|
URI of author. |
|
|
Author’s phone number. Scheme-specific part of a |
|
|
Address of author, non-city/region/code/country portion.
Multiple lines concatenated with |
|
|
City portion of author’s address |
|
|
Region, state or province portion of author’s address. For US/CA the 2-letter state code. |
|
|
Country of author’s address |
|
|
Postal code of author’s address |
|
Only available for RFC XML v3:
Attribute |
Purpose |
RFC XML v3 element |
|
For those who want to directly format their postal addresses without regard
to the prior types. Ignored in v2. Multiple lines are concatenated with |
|
Example. This source:
:street: 57 Mt Pleasant St\ Technology Park
:city: Dullsville
:region: NSW
:country: Australia
:code: 3333Produces:
<address>
<postal>
<street>57 Mt Pleasant St</street>
<street>Technology Park</street>
<city>Dullsville</city>
<region>NSW</region>
<code>3333</code>
<country>Australia</country>
</postal>
</address>Any paragraphs following the document header are treated as the abstract
(front/abstract), whether or not they are in abstract style. The abstract is
terminated by either the first section header (which ends the document
preamble), or an admonition (e.g. note).
Any admonitions before the first section header are treated as notes (front/note).
[[abstract-id]] (1)
[abstract]
This is an abstract (2)
NOTE: This is a note (3)
[NOTE,remove-in-rfc=true] (4)
.Note 2 Title (5)
===
This is another note (3)
===-
v3 only:
front/abstract@anchor(attribute only available in v3) -
front/abstract -
front/note -
v3 only:
front/note@removeInRFC(attribute only available in v3) -
v3:
front/note/name; v2:front/note@title(mandatory attribute; if not provided,NOTEis supplied)
:sectnums: (1)
[[id]] (2)
[remove-in-rfc=true,toc=include|exclude|default] (3)
== Section title (4)
First paragraph of section (5)
Second paragraph of section (5)
:sectnums!: (6)
=== Subsection title (7)
First paragraph of subsection (8)
==== Subsubsection title (9)
Content content content (10)-
middle/section@numbered=true(attribute only available in v3) -
middle/section@anchor -
v3 only:
middle/section@removeInRFC,middle/section@toc(attributes only available in v3) -
v3:
middle/section/name; v2:middle/section@title -
middle/section/t -
middle/section@numbered=false(attribute only available in v3) (toggle) -
v3:
middle/section/section/name; v2:middle/section/section@title -
middle/section/section/t -
v3:
middle/section/section/section/name; v2:middle/section/section/section@title -
middle/section/section/section/t
Content content content
<<crossreference>> (1)
<<crossreference,text>> (2)
<<crossreference,format=(counter|title|none|default): text>> (3)
http://example.com/[linktext] (4)
The following represent the v3 relref element
<<crossreference,section_number (of|comma|parens|bare)>> (5)
<<crossreference,section_number (of|comma|parens|bare): text>> (6)
<<crossreference#fragment,section_number (of|comma|parens|bare)>> (7)
<<crossreference#fragment,section_number (of|comma|parens|bare): text>> (8)-
<xref target="crossreference"/> -
<xref target="crossreference">text</xref> -
<xref format="counter|title|none|default" target="crossreference">text</xref> -
<eref href="http://example.com/">linktext</eref> -
v3 only:
<relref displayFormat="of|comma|parens|bare" section="section_number" target="crossreference"/>(element only available in v3) -
v3 only:
<relref displayFormat="of|comma|parens|bare" section="section_number" target="crossreference">text</relref>(element only available in v3) -
v3 only:
<relref relative="fragment" displayFormat="of|comma|parens|bare" section="section_number" target="crossreference"/>(element only available in v3) -
v3 only:
<relref relative="fragment" displayFormat="of|comma|parens|bare" section="section_number" target="crossreference">text</relref>(element only available in v3)
In v2, the relref style crossreferences are rendered as equivalent xref crossreferences,
inserting section numbers as appropriate.
Note that fragments (e.g. crossreference#fragment) are not supported on the xref@target attribute,
in either v2 or v3: the RFC XML specification requires that the xref@target attribute equals
the value of an anchor attribute elsewhere in the document.
Internal crossreferences and bibliographic references are marked up in the same way; but bibliographic references are marked up separately from the main flow of Asciidoctor, and are processed later.
|
Note
|
Normally, Asciidoctor attempts to match a crossreference to a section title, if it does not find a matching anchor ID. This behaviour has become optional as of Asciidoctor 1.5.7, and is suppressed in this gem. If you have a citation of a bibliographic item which is identical to a section title (e.g. you have a bibliographic citation with the anchor "WHIRLPOOL", and a section with the title "WHIRLPOOL"), this gem will correctly pick the former as the target of the reference, so long as that section has a different anchor ID: |
[[hash_whirlpool]]
=== WHIRLPOOL
The WHIRLPOOL hash function is defined in <<WHIRLPOOL>>.
This section should actually be referenced as <<hash_whirlpool>>.
...
[bibliography]
== Informative References
++++
<reference anchor='WHIRLPOOL' target='http://www.larc.usp.br/~pbarreto/WhirlpoolPage.html'>
...
++++This ((<indexterm>)) (1)
is visible in the text,
this one is not (((indexterm, index-subterm))). (2)-
<iref item="indexterm">indexterm</iref> -
<iref item="indexterm" subitem="index-subterm"/>
Linebreak: + (1)
_Italic_ (2)
*Bold* (3)
`Monospace` (4)
~subscript~ (5)
^superscript^ (6)
[bcp14]#MUST NOT# (7)
*MUST NOT* (8)
stem:[sqrt(4) = 2]-
That is, "+ " at the end of a line. v3:
<br/>; v2:<vspace/>. -
v3:
<em>Italic</em>; v2:<spanx style="emph">Italic</spanx> -
v3:
<strong>Bold</strong>; v2:<spanx style="strong">Bold</spanx> -
v3:
<tt>Monospace</tt>; v2:<spanx style="verb">Monospace</spanx> -
v3 only:
<sub>subscript</sub>. Not supported in v2; rendered as_subscript_ -
v3 only:
<sup>superscript</sup>. Not supported in v2; rendered as^superscript^ -
v3 only:
<bcp14>MUST NOT</bcp14>. Not supported in v2; rendered as<spanx style="strong">MUST NOT</spanx>. -
v3: if document flag
:no-rfc-bold-bcp14:is present, then<strong>MUST NOT</strong>, else (by default) any BCP14/RFC2119 phrase in boldface and capitals is assumed to be intended to be tagged in<bcp14>. v2:<spanx style="strong">MUST NOT</spanx>. -
Stem expressions are treated identically to monospace expressions; they are not currently rendered as MathML or any other notation.
|
Note
|
The delimiters must occur within the one line; the following is invalid in Asciidoctor: |
*WOULD
PROBABLY*Any formatting XML spans within spanx elements are stripped in postprocessing.
[[id]] (1)
[keep-with-next=true,keep-with-previous=true] (2)
Paragraph text (3)-
t@anchor -
v3 only:
t@keepWithNext,t@keepWithPrevious(attributes only available in v3) -
<t>Paragraph text</t>
[[id]] (1)
[quote, attribution, citation info] (2)
Quotation (3)-
blockquote@anchor -
blockquote@quotedFrom,blockquote@cite. In v3,citation infois limited to a URL. -
<blockquote>Quotation</blockquote>
Asciidoctor implements both inline comments (prefixed with //)
and block comments (prefixed with ////). Both are ignored by
the Asciidoctor processor, and are not rendered in any output,
including RFC XML.
Asciidoctor also permits paragraphs and open blocks (which can contain
multiple paragraphs) to be treated as Asciidoctor comments, if
they have the style attribute [comment]:
// This is an inline Asciidoctor comment, which will not be output to XML.
[comment]
This is a single paragraph Asciidoctor comment,
which will not be output to XML.
////
This is a block Asciidoctor comment,
which will not be output to XML.
////
[comment]
--
This is a
multiple paragraph
Asciidoctor comment, which will not be output to XML.
--XML inline comments may be introduced into XML through the [comment]
formatting macro: any such comments may not span more than one line.
Text [comment]#This is a comment# TextThe foregoing will be rendered in RFC XML as:
<t>Text <!-- This is a comment --> Text</t>XML block comments are introduced through the role attribute
[.comment], which can be prefied to a paragraph or an open
block (which can contain multiple paragraphs):
[.comment]
This is a single paragraph XML comment.
[.comment]
--
This is a
multiple paragraph
XML comment.
--RFC XML provides for editorial comments which may optionally appear
in the published text (subject to either the v3 cref@display
attribute, or the comments processing instruction).
In v2 RFC XML, comment text is stripped of all formatting.
NOTE: Any admonition inside the body of the text is a comment. (1)
// Note that actual AsciiDoc comments are ignored by the converter.
[[id]] (2)
[NOTE,display=true|false,source=name] (3)
.Note Title (4)
====
Any admonition inside the body of the text is a comment.
====-
<cref>Any admonition inside the body of the text is a comment.</cref> -
cref@anchor -
v3 only:
cref@display(not supported in v2); v2:cref@source -
v3 only:
cref/name(not suppported in v2)
In RFC XML, sourcecode (v3) and artwork (v2) elements only occur within a
figure wrapper; this gem supplies that wrapper if it is not provided
explicitly.
[[id]] (1)
.Source code listing title (2)
[source,type,src=uri,align,alt] (3)
----
begin() {
source code listing (4)
}
-----
v3:
figure/sourcecode@anchor; v2:figure@anchor(moved into supplied wrapper: anchors not supported onartwork) -
v3:
figure/sourcecode@name; v2:figure/artwork@name -
v3:
figure/sourcecode@type;figure/sourcecode@src(alignandaltnot supported). Ifsrcis present, the listing is not expected to have any content: content is taken from the hyperlink in the attribute. v2:figure/artwork@type,figure/artwork@src,figure/artwork@align,figure/artwork@alt. -
v3:
figure/sourcecode; v2:figure/artwork
[[id]] (1)
[align,alt,suppress-title] (2)
.Figure 1 (3)
====
Preamble text (4)
[[id1]] (5)
.Source code listing title (6)
[source,type,src=uri,align,alt] (7)
----
begin() {
source code listing (8)
}
----
Postamble text (9)
====-
figure@anchor -
v2 only:
figure/artwork@align,figure/artwork@alt,figure@suppress-title(attributes only available in v2) -
figure/name -
v2 only:
figure/preamble(only available in v2) -
v3:
figure/sourcecode@anchor; v2: Not supported: usefigure@anchor -
v3:
figure/sourcecode@name; v2:figure/artwork@name -
v3:
figure/sourcecode@type;figure/sourcecode@src(alignandaltnot supported). Ifsrcis present, the listing is not expected to have any content: content is taken from the hyperlink in the attribute. v2:figure/artwork@type,figure/artwork@src,figure/artwork@align,figure/artwork@alt. -
v3:
figure/sourcecode; v2:figure/artwork -
v2 only:
figure/postamble(only available in v2)
In RFC XML, artwork elements only occur within a
figure wrapper; this gem supplies that wrapper if it is not provided
explicitly.
[[id]] (1)
.Figure2.jpg (2)
[align=left|center|right,alt=Ascii Art,type=text/plain] (3)
....
------------------------
| Ascii Art |
------------------------ (4)
....-
v3 only:
figure/artwork@anchor; v2:figure@anchor(moved into supplied wrapper: anchors not supported onartwork) -
figure/artwork@name -
figure/artwork@align,figure/artwork@alt;figure@type(attribute only available in v2) -
figure/artwork
[[id]] (1)
.Figure2.jpg (2)
[align=left|center|right,alt=alt_text,type=img/jpeg] (3)
image::filename.jpg[alt_text,700,200] (4)-
v3 only:
figure/artwork@anchor; v2:figure@anchor(moved into supplied wrapper: anchors not supported onartwork) -
figure/artwork@name -
figure/artwork@align,figure/artwork@alt;figure/artwork@type(only available in v2, intended to be a MIME type; v3: populated as eithersvgorbinary-artdepending on file suffix) -
figure/artwork@src,figure/artwork@alt,figure/artwork@width(deprecated in v3),figure/artwork@height(deprecated in v3)
[[id]] (1)
[align,alt,suppress-title] (2)
.Figure 1 (3)
====
Preamble text (4)
[[id]] (5)
.Figure2.jpg (8)
[align=left|center|right,alt=alt_text,type=text/plain] (6)
....
Figures are
only permitted to contain listings (sourcecode),
images (artwork),
or literal (artwork) (7)
....
[[id]] (5)
.Figure2.jpg (8)
[align=left|center|right,alt=alt_text,type=img/jpeg] (9)
image::filename.jpg[alt_text,700,200] (10)
Postamble text (11)
====-
figure@anchor -
v2 only:
figure/artwork@align,figure/artwork@alt,figure@suppress-title(attributes only available in v2) -
figure/name -
v2 only:
figure/preamble(only available in v2) -
v3:
figure/artwork@anchor; v2: Not supported: usefigure@anchor -
figure/artwork@align,figure/artwork@alt;figure@type(attribute only available in v2) -
figure/artwork -
figure/artwork@name -
figure/artwork@align,figure/artwork@alt;figure/artwork@type(only available in v2, intended to be a MIME type; v3: populated as eithersvgorbinary-artdepending on file suffix) -
figure/artwork@src,figure/artwork@alt,figure/artwork@width(deprecated in v3),figure/artwork@height(deprecated in v3) -
v2 only:
figure/postamble(only available in v2)
In order for mathematical formatting to be recognised in Asciidoc, the document attribute :stem: needs to be set.
:stem:
[stem]
++++
sqrt(4) = 2
++++Mathematical examples are treated identically to literals, and are rendered as artwork in both v2 and v3;
however their default alignment is set as center. As with inline stem expressions, they are treated identically
to monospace expressions in the RFC XML output; they are not currently rendered as MathML or any other notation.
[[id]] (1)
[empty=true,spacing=normal|compact,hang-indent=n] (2)
* Unordered list 1 (3)
* Unordered list 2 (3)
** Nested list (4)
[[id]] (5)
[spacing=compact,empty=true,start=n,group=n,counter=token,hang-indent=n,format=List #%d,arabic|loweralpha|upperralpha|lowerroman|upperroman] (6)
. A (7)
. B (7)-
v3:
ul@anchor; attribute only available in v3 -
v3:
ul@empty,ul@spacing(hangIndentnot available); v2:ul@style = empty,ul@hangIndent(spacingnot available) -
v2:
list[@style="symbols"]/t; v3: ul/li -
v2:
list[@style="symbols"]/t/list[@style="symbols"]/t; v3:ul/li/ul/li -
v3:
ol@anchor; attribute only available in v3 -
v2:
list/counter,list@hangIndent,list@style = format List %d,list@style(for arabic|loweralpha|upperralpha|lowerroman|upperroman) (spacing,start,emptyandgroupnot available) v3:ol@spacing,ol@empty,ol@start,ol@group,ol@type = "%d", `ol@type(for arabic|loweralpha|upperralpha|lowerroman|upperroman) (counter,hangIndentnot available) -
v2:
list/t; v3:ol/li
|
Note
|
Asciidoctor does not permit anchors on list items: the anchors in the following are ignored. |
* [[id1]] A
. [[id2]] A|
Note
|
RFC XML v2 does not support multiparagraph list items. Following the specification recommendation,
paragraphs within v2 list items are replaced with vspace tages.
|
[[id]] (1)
[horizontal,compact,hang-indent=n] (2)
A:: B (3)-
v3 only:
dl@anchor(attribute only available in v3) -
v3 only:
dl@hanging,dl@spacing(attributes only available in v3); v2 only:list@hangIndent(attribute only available in v2). Note that thecompactandhorizontalattributes are mutually exclusive in AsciiDoc. -
v3:
dl/dt,dl/dd; v2:list[@style="hanging"]/t@hangText,list[@style="hanging"]/t
|
Note
|
Asciidoctor does not permit anchors on either definition list terms, or definition list definitions: the anchors in the following are ignored. |
|
Note
|
In RFC XML v2, idnits considers inline definition lists invalid; the gem
renders them as paragraphed definition lists. The gem option :inline-definition-lists
disables this behaviour.
|
[[id1]] A:: [[id2]]B|
Note
|
RFC XML v2 does not support multiparagraph list items. Following the specification recommendation,
paragraphs within v2 list items are replaced with vspace tages.
|
The converter respects the AsciiDoc (horizontal) align attributes of cells (v2,
v3), column widths (v2), and colspan, rowspan attributes (v3).
(Exceptionally,
column widths specified for v2 as "1,1,1,1,1,1…." will be ignored, since Asciidoctor
internally treats them identically to unspecified column widths on a table.)
[[id]] (1)
[suppress-title=true|false,align=left|center|right,grid=all|cols|none|rows] (2)
.Table Title (3)
|===
|[[id]] head | head (4)
h|header cell | body cell (5)
| | [[id]] body cell (6)
|foot | foot (7)
|===-
v3:
table@anchor; v2:texttable@anchor -
v2:
texttable@suppress-title,texttable@align,texttable@style(attributes only available in v2). Mapping of Asciidoc grid attribute to RFC XML style attribute is:all>all,cols>full,none>none,rows>headers(although the two are not strictly equivalent). -
v3:
table/name; v2:texttable@title -
v3:
table/thead/tr/td; v2:texttable/ttcol@id(attribute only available in v2),texttable/ttcol -
v3:
table/tbody/tr/th,table/tbody/tr/td; v2:texttable/c,texttable/c -
v3:
table/tbody/tr/td@anchor(attribute only available in v3) -
v3:
table/tfoot/tr/td; v2:texttable/c
|
Note
|
v3 permits table cells to contain block elements, such as paragraphs and lists. (This is done in Asciidoc by prefixing
the table cell with a|.) However v2 only permits inline tagging, and any block tags are ignored.
|
References are expected to be provided in raw RFC XML v2 format. For v3, a list of crossreferences may
precede the block of references, with alternative text. This will not be rendered, but it will be used
to populate displayreference elements, mapping the reference anchors to display text. For example,
a list entry [] means that any instances of the anchor ref1 should be displayed as alt1,
and is rendered as <displayreference target="ref1" to="alt1"/>.
RFC requires two separate bibliographies, one for normative and one for informative references;
either can be omitted. All bibliography sections in the must be styled with the prefix [bibliography],
and must appear in sequence, before any appendices.
By default, the references cited must be included as raw RFC XML, and separated into the normative and informative sections.
[[id]] (1)
[bibliography]
== Normative References
* [[[ref1,alt1]]] (2)
++++
(raw XML) (3)
++++
[[id]] (1)
[bibliography]
== Informative References
++++
(raw XML) (2)
++++-
back/references@anchor(only in v3) -
back/displayreference@target,back/displayreference@to(only in v3) -
back/references/reference
In postprocessing, bibliographic entries available from http://xml.resource.org/public/rfc are replaced with external references to that entry, using XML entities in RFC XML v2, and XML includes in RFC XML v3. Do not insert your own entities or XML includes into the references; the gem will have difficulty processing them.
As an alternative, the document attribute :biblio-dir: can nominate a directory in which separate XML files can be placed, one for each reference to be included. (RFC XML v3 referencegroup elements will also be recognised as files.) The gem will read in from that directory only the files that have actually been cited, and insert them into the appropriate bibliography, without the references needing to be given under the bibliographies as above. (In fact, any XML already provided will be deleted.) By default, references will be considered informative; the document attribute :normative: can be used to specify a comma-delimited list of normative references.
The gem will issue a warning if any cited reference is not included in the directory. However, external references do not have to be included in the directory: they will be recognised by comparing their anchors against the external bibliography cache, and referenced as entities or includes. However, particular drafts of Internet-Draft documents do still need to be included as separate documents (see Lookup of external references.)
For example:
= The Holy Hand Grenade of Antioch
Arthur Pendragon
:doctype: internet-draft
:workgroup: silly
:biblio-dir: refs (1)
:normative: RFC2119, AsciiDoc (1)
[[xyz]]
== Hello
Hello
* a <<RFC2119,2.3 of: See internet draft subsection>> (3)
* b <<I-D.abarth-cake>>
* b2 <<I-D.abarth-cake,what>>
* b1 <<I-D.abarth-cake,2.3 of: See internet draft subsection>> (3)
* c <<xyz,format=counter: xyzzy>> (4)
* d <<biblio>> (4)
* e <<AsciiDoc,AsciiDoctor>>
* f <<mathrefs>>
[[biblio]]
=== Biblio
See biblio
[bibliography]
== Normative References (5)
[bibliography]
== Informative References (6)-
The RFC XML references are included in the directory
./refs, with one file per reference. For example, we would expect it to contain a file corresponding to the referencemathrefs. A file corresponding toRFC2119is optional, and in fact will be ignored, since the anchor is recognised as an external reference. A file corresponding toI-D.abarth-cakewill not be ignored, if that file contains aseriesInfoelement nominating a specific draft version. -
The references in the
./refsdirectory are by default considered informative; this attribute indicates thatRFC2119andAsciiDocare to be considered normative. -
References are recognised in
relrefas well asxrefelements. -
The gem differentiates between bibliographic references and crossreferences to other anchors within the document.
-
The bibliographic headers need to be provided as above, and its titles are expected to be "Normative References" and "Informative References"; the gem will look for those titles specifically in order to insert the references it identifies from the file. However, no XML content is expected to be provided under each heading, and any XML content that is provided will be ignored.
[[id]] (1)
[appendix]
== Appendix 1 (2)
Content (3)-
back/section@anchor -
v3:
back/section/name; v2:back/section@title -
back/section/t
The following RFC XML v3/v2 elements are not (yet) supported through asciidoctor commands:
| RFC XML element | RFC XML v3 | RFC XML v2 |
|---|---|---|
|
Not added |
N/A |
|
N |
N |
|
Supported only as pass-through or through asciidoc-bibliography gem |
|
|
Deprecated |
N |
|
Deprecated |
N |
|
Only on images |
Only on images |
|
Only on images |
Only on images |
These asciidoctor features are not supported in output of these formats:
| asciidoctor feature | RFC XML v2 | RFC XML v3 |
|---|---|---|
Rendered as normal paragraph |
Supported |
|
Quote: Non-URL Citations |
Ignored |
|
Rendered as normal paragraph |
Rendered as Quote |
|
Rendered as normal paragraph |
Supported |
|
Index Term: Tertiary |
Ignored |
|
List: Ordered List numbering |
Treated as |
|
Ignored |
||
Ignored |
Supported |
|
Formatting: Floating Title |
Rendered as strong paragraph |
|
Formatting: Page Break |
Ignored |
|
Formatting: Horizontal Rule |
Ignored |
|
Formatting: Line breaks |
Supported |
Only supported within table cells |
Media: Audio |
Ignored |
|
Media: Video |
Ignored |
|
Media: Inline images |
Ignored |
|
Macro: Keyboard shortcuts |
Ignored |
|
Macro: Menu selections |
Ignored |
|
Macro: UI buttons |
Ignored |
|
No |
Supported |
|
Table: Multiple table header rows |
No |
Supported |
Table: Table borders: grid = rows |
Rendered as |
Ignored |
Supported |
Ignored |
|
Table: Table borders: frame |
Ignored |
|
Table: Table cells: rowspan |
Ignored |
Supported |
Table: Table cells: colspan |
Ignored |
Supported |
Table: Table cells: Asciidoctor formatting (blocks within cells) |
Ignored |
Supported |
Table: Table columns: width |
Supported |
Ignored |
In order to speed the lookup of references on the http://xml.resource.org/public/rfc website for external
references, a cache of references is built the first time the gem is run, in the user’s home directory:
~/.asciidoc-rfc-biblio-cache.json. This maps all the canonical anchors for external references as defined
by the IETF, such as RFC2119 or CCITT.E163.1988, to the URLs that their RFC reference is stored on.
References are detected for replacement in the Asciidoc document by matching the references@anchor
attribute to one of those canonical anchors; the content of the local RFC XML reference is not checked.
(For rebuilding the cache, see Caches.)
Rather than hand crafting RFC XML references for RFC documents, or other references hosted at http://xml.resource.org/public/rfc/,
you need only create a dummy <reference> element containing the IETF-defined anchor for that citation. In postprocessing, any
references that are hosted at xml.resource.org will be identified by their anchor, and replaced by entities or XML includes,
for RFC XML v2 and v3 respectively. (The complete list of authoritative
RFC XML bibliographies is available from https://xml2rfc.tools.ietf.org , online and in zipped form.)
Because the content of any externally defined <reference> element is overwritten with an entity or include,
you do not need to provide a full reference. You can supply a minimal reference like <reference anchor="RFC2119"/>,
but note that such a reference is invalid in the RFC XML schema, and the gem will report a missing element during processing.
(The document will still be processed successfully.) To prevent any validation error reports, the minimal syntactically valid reference is:
<reference anchor="RFC2119">
<front>
<title/>
<author/>
<date/>
</front>
</reference>If you wish to cite a specific version of an Internet-Draft, you will need to include the seriesInfo element
in the reference that identifies the specific version; the anchor is the same for all internet drafts. For example:
<reference anchor="I-D.abarth-cake">
<front>
<title/>
<author/>
<date/>
</front>
<seriesInfo name="Internet-Draft" value="draft-abarth-cake-00"/>
</reference>As discussed under References: External Directory, any citations of specific versions of an Internet-Draft need to be included as explicit files in an external directory of RFC XML references, since the seriesInfo draft information cannot be recovered by the anchor. However, any other external references do not require a corresponding directory file (although normative references do still need to be named in the :normative: document attribute.)
We follow Sandi Metz’s Rules for this gem, you can read the description of the rules here.
All new code should follow these rules. If you make changes in a pre-existing file that violates these rules you should fix the violations as part of your contribution.
First, thank you for contributing! We love pull requests from everyone. By participating in this project, you hereby grant Ribose Inc. the right to grant or transfer an unlimited number of non exclusive licenses or sub-licenses to third parties, under the copyright covering the contribution to use the contribution by all means.
Here are a few technical guidelines to follow:
-
Open an issue to discuss a new feature.
-
Write tests to support your new feature.
-
Make sure the entire test suite passes locally and on CI.
-
Open a Pull Request.
-
Squash your commits after receiving feedback.
-
Party!
This gem is developed, maintained and funded by Ribose Inc.