An Example of Using XML for an Internet Draft

category="std"
docName="draft-example-of-xml-00"
ipr="trust200902"
consensus="no"
submissionType="IETF"
updates="1234, 5678"
xml:lang="en"
>

 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.

src="http://www.example.com/~employees/chrissmith/artwork.txt" />

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.

target="http://www.aciri.org/floyd/papers/early.pdf">

Random Early Detection (RED) gateways for Congestion Avoidance

LBL

LBL

value="1(4) 397--413"/>
octets="318703" type="PDF"/>

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.

updates='1234, 5678' xml:lang='en'
xmlns:xi="http://www.w3.org/2001/XInclude">

value='draft-example-of-xml-00'/>

 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:

This is the first item.

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

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.

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.

src='http://www.example.com/~employees/chrissmith/artwork.txt'>

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

'http://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml'/>

Informative References

RFC Series Format Requirements and Future Development

This is a primary reference work.

target='http://www.aciri.org/floyd/papers/early.pdf'>

Random Early Detection (RED) gateways for Congestion Avoidance

LBL

LBL

name='IEEE/ACM Transactions on Networking' value='1(4) 397--413'/>

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]