Network Working Group P. Hoffman Internet-Draft VPN Consortium Intended status: Informational T. Hansen Expires: May 7, 2016 AT&T Laboratories November 4, 2015 Examples of the 'XML2RFC' Version 2 and 3 Vocabularies draft-hoffman-rfcexamples-04 Abstract This document gives examples of use of the "XML2RFC" vocabulary. The examples cover both version 2 and version 3. The purposes of this draft is to give developers of tools that process v2 and/or v3 documents a corpus to test against. Editorial Note (To be removed by RFC Editor) Discussion of this draft takes place on the rfc-interest mailing list (rfc-interest@rfc-editor.org), which has its home page at . Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at http://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on May 7, 2016. Copyright Notice Copyright (c) 2015 IETF Trust and the persons identified as the document authors. All rights reserved. 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 Hoffman & Hansen Expires May 7, 2016 [Page 1] Internet-Draft RFC XML Examples November 2015 publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Example of a v2 Document . . . . . . . . . . . . . . . . . . 2 3. Example of a v3 Document . . . . . . . . . . . . . . . . . . 10 4. Security Considerations . . . . . . . . . . . . . . . . . . . 17 5. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 17 6. Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . 17 7. Normative References . . . . . . . . . . . . . . . . . . . . 17 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 17 1. Introduction This document gives examples of use of the "XML2RFC" vocabulary. The examples cover both version 2 [XML2RFCv2] and version 3 [XML2RFCv3]. The purpose of this document is to help developers of tools that process v2 and/or v3 documents to see examples of the documents. Earlier versions of this document said that it was to help people with v2 documents transition to v3. The authors have backed off from that goal. Instead, we point out that the changes from v2 to v3 are listed in detail in Section 1.2 of [XML2RFCv3]. Also, we expect that there will be additional documents created later describing the v2-to-v3 conversion, as well as tools that will do as much of the conversion as possible. This is meant to be a short-lived document. It is not expected that this document will be published as an RFC. 2. Example of a v2 Document The following is a v2 document that has all the elements that are needed for typical Internet-Drafts. ]> Hoffman & Hansen Expires May 7, 2016 [Page 2] Internet-Draft RFC XML Examples November 2015 An Example of Using XML for an Internet Draft ExampleCorp
123 Exemplar Way Anytown California 95060 US +1 123-456-7890 +1 123-456-7890 chrissmith@example.com http://www.example.com/corporate/
jk@lmn.op
General Imaginary WG XML Hoffman & Hansen Expires May 7, 2016 [Page 3] Internet-Draft RFC XML Examples November 2015 Imagination 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. This isn't a real RFC, just an example.
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 , and one to , both of which appear later in the document.
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 .
This is a reference to . Actually, the reference itself is not all that interesting, but the Hoffman & Hansen Expires May 7, 2016 [Page 4] Internet-Draft RFC XML Examples November 2015 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 IETF web site is quite nice, isn't it? Unlike other web sites, it doesn't use gratuitous vertical space.
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: Hoffman & Hansen Expires May 7, 2016 [Page 5] Internet-Draft RFC XML Examples November 2015 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. These are bigger plants These are smaller plants And the always-interesting "format" for lists. An element that gets a funny bullet.
The following is a figure with a caption. Also, it uses the ampersand (&) and less than (<) characters in the example text.
The ampersand (&) and less than (<) are two characters that need escaping.
Here are two short figures with no titles and with odd alignment.
Hoffman & Hansen Expires May 7, 2016 [Page 6] Internet-Draft RFC XML Examples November 2015 This might appear in the center.
This might appear right-aligned.
Here is a figure that is actually pulled from somewhere else. Remember to check whether that file still exists.
The following is a table example. These are sometimes called "inert" gasses. Name Symbol Atomic Number Helium He 2 Neon Ne 10 Argon Ar 18 Krypton Kr 36 Xenon Xe 54 Radon Hoffman & Hansen Expires May 7, 2016 [Page 7] Internet-Draft RFC XML Examples November 2015 Rn 86 Source: Chemistry 101 The following is a right-aligned table with "full" (but not "all") lines between cells. Time Mood Morning Happy! Afternoon Happy! Evening Somber
None.
There are no security considerations for an imaginary Internet Draft.
Some of the things included in this draft came from Elwyn Davies' templates.
Hoffman & Hansen Expires May 7, 2016 [Page 8] Internet-Draft RFC XML Examples November 2015 &RFC2119; RFC Series Format Requirements and Future Development This is a primary reference work. Random Early Detection (RED) gateways for Congestion Avoidance LBL LBL
Hoffman & Hansen Expires May 7, 2016 [Page 9] Internet-Draft RFC XML Examples November 2015 3. Example of a v3 Document The following is a v3 document that has all the elements that are needed for typical Internet-Drafts. It was converted from the example in Section 2. An Example of Using XML for an Internet Draft ExampleCorp
123 Exemplar Way Anytown California 95060 US +1 123-456-7890 +1 123-456-7890 chrissmith@example.com http://www.example.com/corporate/
jk@lmn.op
Hoffman & Hansen Expires May 7, 2016 [Page 10] Internet-Draft RFC XML Examples November 2015 General Imaginary WG XML Imagination 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. This isn't a real RFC, just an example.
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 , and one to , both of which appear later in the document.
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 .
Hoffman & Hansen Expires May 7, 2016 [Page 11] Internet-Draft RFC XML Examples November 2015
The Protocol Being Described This is a reference to . 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 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:
  1. This is the first item.
  2. This is the second item. Here comes a sub-list, but Hoffman & Hansen Expires May 7, 2016 [Page 12] Internet-Draft RFC XML Examples November 2015 with letters:
    1. This is the first sub-item.
    2. This is the second sub-item
  3. This is the item after the sub-list.
And an example of hanging indent.
Trees
These are bigger plants
Lichen
These are smaller plants
And the always-interesting "format" for lists.
  1. 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.
This could be haiku The ampersand (&) and less than (<) are two characters that need escaping.
Hoffman & Hansen Expires May 7, 2016 [Page 13] Internet-Draft RFC XML Examples November 2015 Here are two short figures with no titles and with odd alignment.
This might appear in the center.
This might appear right-aligned.
Here is a figure that is actually pulled from somewhere else. Remember to check whether that file still exists.
Tables The following is a table example. These are sometimes called "inert" gasses. Hoffman & Hansen Expires May 7, 2016 [Page 14] Internet-Draft RFC XML Examples November 2015
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.
Time Mood
Morning Happy!
Afternoon Happy!
Evening Somber
IANA Considerations None.
Security Considerations There are no security considerations for an imaginary Internet Draft.
Acknowledgements Some of the things included in this draft came from Elwyn Davies' templates. Hoffman & Hansen Expires May 7, 2016 [Page 15] Internet-Draft RFC XML Examples November 2015
Normative References Informative References RFC Series Format Requirements and Future Development This is a primary reference work. Random Early Detection (RED) gateways for Congestion Avoidance LBL LBL Hoffman & Hansen Expires May 7, 2016 [Page 16] Internet-Draft RFC XML Examples November 2015
4. Security Considerations The examples in this document do not introduce any new security considerations. 5. IANA Considerations There are no IANA considerations for this document. 6. Acknowledgments The ideas for the examples in this document come from many people over a long period of time. Special thanks go to the Alice Russo and other members of the RFC Design Team for suggestions and debugging help. 7. Normative References [XML2RFCv2] Reschke, J., "The 'XML2RFC' version 2 Vocabulary", draft- reschke-xml2rfc (work in progress), 2014. [XML2RFCv3] Hoffman, P., "The 'XML2RFC' version 3 Vocabulary", draft- hoffman-xml2rfc (work in progress), 2014. Authors' Addresses Paul Hoffman VPN Consortium EMail: paul.hoffman@vpnc.org Tony Hansen AT&T Laboratories 200 Laurel Ave. South Middletown, NJ 07748 USA EMail: tony+rfcv3@maillennium.att.com Hoffman & Hansen Expires May 7, 2016 [Page 17]