asciidoctor-rfc 0.2.0 → 0.8.0

data/spec/examples/example-v2.adoc

@@ -4,7 +4,7 @@ David Waitzman <dwaitzman@BBN.COM>; Nick Nicholas <opoudjis@gmail.com>
 :abbrev: IP Datagrams on Avian Carriers
 :obsoletes: 10, 120
 :updates: 2010, 2120
-:status: info
+:status: informational
 :name: rfc-1149
 :ipr: trust200902
 :area: Internet
@@ -139,7 +139,7 @@ measures **MUST** be taken (such as data encryption) when avian carriers
 are used in a tactical environment.<<RFC7253>>, <<ISO.IEC.10118-3>>
 
 [bibliography]
-== References
+== Normative References
 ++++
 <reference anchor='ISO.IEC.10118-3' target='https://www.iso.org/standard/67116.html'>
   <front>
@@ -164,7 +164,11 @@ are used in a tactical environment.<<RFC7253>>, <<ISO.IEC.10118-3>>
     <date day='15' month='September' year='2017'/>
   </front>
 </reference>
+++++
 
+[bibliography]
+== Infomative References
+++++
 <reference anchor='RFC7253' target='https://tools.ietf.org/html/rfc7253'>
   <front>
     <title>Guidelines for Writing an IANA Considerations Section in RFCs</title>

data/spec/examples/example-v3.adoc

@@ -140,7 +140,7 @@ measures [bcp14]#MUST# be taken (such as data encryption) when avian carriers
 are used in a tactical environment.<<RFC7253>>, <<ISO.IEC.10118-3>>
 
 [bibliography]
-== References
+== Normative  References
 * [[[RFC7253,1]]]
 * [[[ISO.IEC.10118-3,2]]]
 ++++
@@ -167,7 +167,11 @@ are used in a tactical environment.<<RFC7253>>, <<ISO.IEC.10118-3>>
     <date day='15' month='September' year='2017'/>
   </front>
 </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>

data/spec/examples/hoffmanv2.xml.adoc

@@ -0,0 +1,247 @@
+= An Example of Using XML for an Internet Draft
+Chris Smith <chrissmith@example.com>; Kim Jones <jk@lmn.op>
+:doctype: internet-draft
+:status: standard
+:name: draft-example-of-xml-00
+:ipr: trust200902
+:consensus: false
+:submision-type: IETF
+:updates: 1234, 5678
+:xml-lang: en
+:abbrev: XML Example
+:forename_initials: C.
+:organization: ExampleCorp
+:organization_abbrev: EC
+:street: 123 Exemplar Way
+:city: Anytown
+:region: California
+:code: 95060
+:country: US
+:phone: +1 123-456-7890
+:fax: +1 123-456-7890
+:email: chrissmith@example.com
+:uri: http://www.example.com/corporate/
+:forename_initials_2: K.
+:revdate: 2014-09
+:area: General
+:workgroup: Imaginary WG
+:keyword: XML, Imagination
+:inline-definition-lists: true
+:toc-include: false
+
+[abstract]
+This is an example of an abstract.  It is a short paragraph that
+gives an overview of the document in order to help the reader
+determine whether or not they are interested in reading further.
+
+[NOTE]
+.Disclaimer
+This isn't a real RFC, just an example.
+
+[#intro]
+== Introduction
+
+This is the first paragraph of the introduction to this document.
+This introduction is probably much shorter than it would be for a
+real Internet Draft.
+
+Something to note about this paragraph is that it has a pointer to
+<<protocol>>, and one to <<haiku>>, both of which appear later in the
+document. (((Introduction, verbiage)))
+
+=== Terminology
+
+The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
+"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
+document are to be interpreted as described in <<RFC2119>>.
+
+[#protocol]
+== The Protocol Being Described
+
+This is a reference to <<RFC6949>>.  Actually, the reference itself is
+not all that interesting, but the way that the reference is
+incorporated is.  Note that the inclusion of RFC 2119 was done at the
+top of the XML, while the information for RFC 6949 is done directly
+in the references section.
+
+The http://www.ietf.org[IETF web site] is _quite_ *nice*, `isn't it`?  Unlike other web sites, it doesn't use
+ +
+ +
+ +
+gratuitous vertical space.
+
+== Basic Lists
+
+Bulleted lists are good for items that are not ordered:
+
+* This is the first item.
+* This is the second item.  Here comes a sub-list:
+**  This is the first sub-item.
+**  This is the second sub-item
++
+and some more detail on the second sub-item.
+
++
+* This is the item after the sub-list.
+
+
+Numbered lists are good for items that are ordered:
+
+.  This is the first item.
+.  This is the second item.  Here comes a sub-list, but with letters:
+[upperalpha]
+.. This is the first sub-item.
+.. This is the second sub-item
+.  This is the item after the sub-list.
+
+And an example of hanging indent.
+
+[hang-indent=15]
+Trees:: These are bigger plants
+Lichen:: These are smaller plants
+
+And the always-interesting "format" for lists.
+
+[format=--%d--]
+.  An element that gets a funny bullet.
+
+==  Figures
+
+The following is a figure with a caption.  Also, it uses the
+ampersand (&) and less than (<) characters in the example text.
+
+[#haiku]
+.This could be haiku
+[type=haiku]
+====
+....
+      The ampersand (&) and
+      less than (<) are two characters
+      that need escaping.
+....
+====
+
+Here are two short figures with no titles and with odd alignment.
+
+[align=center]
+....
+   This might appear in the center.
+....
+
+[align=right]
+....
+This might appear right-aligned.
+....
+
+Here is a figure that is actually pulled from somewhere else.
+[#rememberme]
+[NOTE,source=CS]
+====
+Remember to check whether that file still exists.
+====
+
+[source,src=http://www.example.com/~employees/chrissmith/artwork.txt]
+----
+----
+
+== Tables
+
+The following is a table example.
+
+These are sometimes called "inert" gasses.
+
+.The Noble Gases
+[grid=cols,cols="<25,^50,^25"]
+|===
+| Name    |  Symbol  | Atomic Number 
+
+| Helium  |  He |       2       
+| Neon    |  Ne |       10      
+| Argon   |  Ar |       18      
+| Krypton |  Kr |       36      
+| Xenon   |  Xe |       54      
+| Radon   |  Rn |       86      
+|===
+
+Source: Chemistry 101
+
+The following is a right-aligned table with "full" (but not "all")
+lines between cells.
+
+[align=right,grid=cols]
+[cols="<,>"]
+|===
+| Time      | Mood 
+
+| Morning   | Happy! 
+| Afternoon | Happy! 
+| Evening   | Somber 
+|===
+
+[#IANA]
+==  IANA Considerations
+
+None.
+
+[#Security]
+== Security Considerations
+
+There are no security considerations for an imaginary Internet Draft.
+
+[#Acknowledgements]
+==  Acknowledgements
+
+Some of the things included in this draft came from Elwyn Davies'
+templates.
+
+[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="RFC6949">
+   <front>
+   <title>RFC Series Format Requirements and Future Development</title>
+   <author initials="H." surname="Flanagan" fullname="H. Flanagan">
+   <organization/></author>
+   <author initials="N." surname="Brownlee" fullname="N. Brownlee">
+   <organization/></author>
+   <date year="2013" month="May"/>
+   </front>
+   <seriesInfo name="RFC" value="6949"/>
+   <annotation>This is a primary reference work.</annotation>
+   </reference>
+
+   <reference anchor="RED"
+   target="http://www.aciri.org/floyd/papers/early.pdf">
+   <front>
+   <title>Random Early Detection (RED) gateways for Congestion
+   Avoidance</title>
+   <author fullname="Sally Floyd" initials="S" surname="Floyd">
+   <organization>LBL</organization>
+   </author>
+   <author fullname="Van Jacobson" initials="V" surname="Jacobson">
+   <organization>LBL</organization>
+   </author>
+   <date month="August" year="1993"/>
+   </front>
+   <seriesInfo name="IEEE/ACM Transactions on Networking"
+   value="1(4) 397--413"/>
+   <format target="http://www.aciri.org/floyd/papers/early.pdf"
+   octets="318703" type="PDF"/>
+   </reference>
+++++

data/spec/examples/hoffmanv2.xml.orig

@@ -0,0 +1,339 @@
+<?xml version="1.0" encoding="US-ASCII"?>
+   <!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
+   <!ENTITY RFC2119 SYSTEM
+     "http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml">
+   ]>
+
+   <?xml-stylesheet type="text/xsl" href="rfc2629.xslt" ?>
+   <?rfc strict="yes" ?>
+
+   <rfc
+     category="std"
+     docName="draft-example-of-xml-00"
+     ipr="trust200902"
+     consensus="no"
+     submissionType="IETF"
+     updates="1234, 5678"
+     xml:lang="en"
+   >
+
+   <front>
+   <title abbrev="XML Example">
+   An Example of Using XML for an Internet Draft
+   </title>
+
+   <author fullname="Chris Smith" initials="C." surname="Smith">
+   <organization abbrev="EC">ExampleCorp</organization>
+   <address>
+   <postal>
+   <street>123 Exemplar Way</street>
+   <city>Anytown</city>
+   <region>California</region>
+   <code>95060</code>
+   <country>US</country>
+   </postal>
+   <phone>+1 123-456-7890</phone>
+   <facsimile>+1 123-456-7890</facsimile>
+   <email>chrissmith@example.com</email>
+   <uri>http://www.example.com/corporate/</uri>
+   </address>
+   </author>
+
+   <!-- The following author has no organization and no postal or
+        phone information. -->
+   <author fullname="Kim Jones" initials="K." surname="Jones">
+   <organization/>
+   <address>
+   <email>jk@lmn.op</email>
+   </address>
+   </author>
+
+   <date year="2014" month="September"/>
+
+   <area>General</area>
+   <workgroup>Imaginary WG</workgroup>
+   <keyword>XML</keyword>
+      <keyword>Imagination</keyword>
+
+   <abstract>
+   <t>This is an example of an abstract. It is a short paragraph that
+   gives an overview of the document in order to help the
+   reader determine whether or not they are interested in reading
+   further.</t>
+   </abstract>
+
+   <note title="Disclaimer">
+   <t>This isn't a real RFC, just an example.</t>
+   </note>
+
+   </front>
+
+   <middle>
+
+   <section anchor="intro" title="Introduction">
+
+   <t>This is the first paragraph of the introduction to this
+   document. This introduction is probably much shorter than it would
+   be for a real Internet Draft.</t>
+
+   <t>Something to note about this paragraph is that it has a
+   pointer to <xref target="protocol"/>, and one to
+   <xref target="haiku"/>, both of which appear later in the
+   document.</t>
+
+   <iref item="Introduction" subitem="verbiage" primary="true"/>
+
+   <!-- This is a comment. Comments in the XML do not appear in the
+   output formats. -->
+
+   <section title="Terminology">
+
+   <t>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
+   NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL"
+   in this document are to be interpreted as described in
+   <xref target="RFC2119"/>.</t>
+
+   </section>
+
+   </section>
+
+   <section anchor="protocol" title="The Protocol Being Described">
+
+   <t>This is a reference to <xref target="RFC6949"/>.
+   Actually, the reference itself is not all that interesting, but the
+      way that the reference is incorporated is. Note that the inclusion
+   of RFC 2119 was done at the top of the XML, while the information
+   for RFC 6949 is done directly in the references section.</t>
+
+   <t>The <eref target="http://www.ietf.org">IETF web site</eref> is
+   <spanx style="emph">quite</spanx>
+   <spanx style="strong">nice</spanx>,
+   <spanx style="verb">isn't it</spanx>?
+   Unlike other web sites, it doesn't use
+   <vspace blankLines="2" />gratuitous vertical space.</t>
+
+   </section>
+
+   <section title="Basic Lists">
+
+   <t>Bulleted lists are good for items that
+   are not ordered:
+
+   <list style="symbols">
+
+   <t>This is the first item.</t>
+
+   <t>This is the second item. Here comes a sub-list:
+
+   <list style="symbols">
+
+   <t>This is the first sub-item.</t>
+
+   <t>This is the second sub-item<vspace/>
+   and some more detail on the second sub-item.</t>
+
+   </list></t>
+
+   <t>This is the item after the sub-list.</t>
+
+   </list></t>
+
+   <t>Numbered lists are good for items that are ordered:
+
+   <list style="numbers">
+
+   <t>This is the first item.</t>
+
+   <t>This is the second item. Here comes a sub-list, but
+   with letters:
+
+   <list style="letters">
+   <t>This is the first sub-item.</t>
+
+   <t>This is the second sub-item</t>
+
+   </list></t>
+
+   <t>This is the item after the sub-list.</t>
+
+   </list></t>
+
+   <t>And an example of hanging indent.
+
+   <list style="hanging" hangIndent="15">
+
+   <t hangText="Trees">These are bigger plants</t>
+
+   <t hangText="Lichen">These are smaller plants</t>
+
+   </list></t>
+
+   <t>And the always-interesting "format" for lists.
+
+   <list style="format --%d--">
+
+   <t>An element that gets a funny bullet.</t>
+
+   </list></t>
+
+   </section>
+
+   <section title="Figures">
+
+   <t>The following is a figure with a caption.
+   Also, it uses the ampersand (&amp;) and less than
+   (&lt;) characters in the example text.</t>
+
+   <figure title="This could be haiku" anchor="haiku">
+   <artwork type="haiku" align="left">
+      The ampersand (&amp;) and
+      less than (&lt;) are two characters
+      that need escaping.
+   </artwork>
+   </figure>
+
+   <t>Here are two short figures with no titles and with
+   odd alignment.</t>
+
+   <figure><artwork align="center">
+   This might appear in the center.
+   </artwork></figure>
+
+   <figure><artwork align="right">
+   This might appear right-aligned.
+   </artwork></figure>
+
+   <t>Here is a figure that is actually pulled from somewhere else.
+   <cref source="cs" anchor="rememberme">
+   Remember to check whether that file still exists.</cref></t>
+
+   <figure><artwork
+     src="http://www.example.com/~employees/chrissmith/artwork.txt" />
+   </figure>
+
+   </section>
+
+   <section title="Tables">
+
+   <t>The following is a table example.</t>
+
+   <texttable title="The Noble Gases">
+     <preamble>These are sometimes called "inert" gasses.</preamble>
+     <ttcol>Name</ttcol>
+     <ttcol align="center" width="50%">Symbol</ttcol>
+     <ttcol align="center">Atomic Number</ttcol>
+
+     <c>Helium</c>
+     <c>He</c>
+     <c>2</c>
+
+     <c>Neon</c>
+     <c>Ne</c>
+     <c>10</c>
+
+     <c>Argon</c>
+     <c>Ar</c>
+     <c>18</c>
+
+     <c>Krypton</c>
+     <c>Kr</c>
+     <c>36</c>
+
+     <c>Xenon</c>
+     <c>Xe</c>
+     <c>54</c>
+
+     <c>Radon</c>
+     <c>Rn</c>
+     <c>86</c>
+
+     <postamble>Source: Chemistry 101</postamble>
+   </texttable>
+
+   <t>The following is a right-aligned table with "full" (but not "all")
+   lines between cells.</t>
+
+   <texttable align="right" style="full">
+     <ttcol>Time</ttcol>
+     <ttcol align="right">Mood</ttcol>
+
+     <c>Morning</c>
+     <c>Happy!</c>
+
+     <c>Afternoon</c>
+     <c>Happy!</c>
+
+     <c>Evening</c>
+     <c>Somber</c>
+
+   </texttable>
+
+   </section>
+
+   <section anchor="IANA" title="IANA Considerations">
+
+   <t>None.</t>
+
+   </section>
+
+   <section anchor="Security" title="Security Considerations">
+
+   <t>There are no security considerations for an imaginary
+   Internet Draft.</t>
+
+   </section>
+
+   <section anchor="Acknowledgements" title="Acknowledgements">
+
+   <t>Some of the things included in this draft came from
+   Elwyn Davies' templates.</t>
+
+   </section>
+
+   </middle>
+   <back>
+
+   <references title="Normative References">
+
+   &RFC2119;
+
+   </references>
+
+   <references title="Informative References">
+
+   <reference anchor="RFC6949">
+   <front>
+   <title>RFC Series Format Requirements and Future Development</title>
+   <author initials="H." surname="Flanagan" fullname="H. Flanagan">
+   <organization/></author>
+   <author initials="N." surname="Brownlee" fullname="N. Brownlee">
+   <organization/></author>
+   <date year="2013" month="May"/>
+   </front>
+   <seriesInfo name="RFC" value="6949"/>
+   <annotation>This is a primary reference work.</annotation>
+   </reference>
+
+   <reference anchor="RED"
+   target="http://www.aciri.org/floyd/papers/early.pdf">
+   <front>
+   <title>Random Early Detection (RED) gateways for Congestion
+   Avoidance</title>
+   <author fullname="Sally Floyd" initials="S" surname="Floyd">
+   <organization>LBL</organization>
+   </author>
+   <author fullname="Van Jacobson" initials="V" surname="Jacobson">
+   <organization>LBL</organization>
+   </author>
+   <date month="August" year="1993"/>
+   </front>
+   <seriesInfo name="IEEE/ACM Transactions on Networking"
+   value="1(4) 397--413"/>
+   <format target="http://www.aciri.org/floyd/papers/early.pdf"
+   octets="318703" type="PDF"/>
+   </reference>
+
+   </references>
+
+   </back>
+   </rfc>