.\" automatically generated by xml2rfc v2.4.3.dev on 2013-11-13T17:20:46Z

.pl 10.0i
.po 0
.ll 7.2i
.lt 7.2i
.nr LL 7.2i
.nr LT 7.2i
.hy 0
.ad l
.ds LH Internet-Draft
.ds CH Abbreviated Title
.ds RH March 2007
.ds LF Davies & Quintin Zhao
.ds CF Expires September 2, 2007
.ds RF FORMFEED[Page %]
.in 0
.nf
Internet Engineering Task Force                           E. Davies, Ed.
Internet-Draft                                          Folly Consulting
Intended status: Informational                              Quintin Zhao
Expires: September 2, 2007                             Huawei Technology
                                                              March 2007
.fi


.ce 1
Put Your Internet Draft Title Here
.ce 1
draft-ietf-xml2rfc-template-05

.ti 0
Abstract

.in 3
Insert an abstract: MANDATORY.  This template is for creating an
Internet Draft.

.ti 0
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 September 2, 2007.

.ti 0
Copyright Notice

Copyright (c) 2007 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
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\04.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
.bp
.ti 0
Table of Contents
.in 0
.nf

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
     1.1.  Requirements Language . . . . . . . . . . . . . . . . . .   2
   2.  Simple List . . . . . . . . . . . . . . . . . . . . . . . . .   2
   3.  Figures . . . . . . . . . . . . . . . . . . . . . . . . . . .   2
   4.  Subsections and Tables  . . . . . . . . . . . . . . . . . . .   3
     4.1.  A Subsection  . . . . . . . . . . . . . . . . . . . . . .   3
     4.2.  Tables  . . . . . . . . . . . . . . . . . . . . . . . . .   3
   5.  More about Lists  . . . . . . . . . . . . . . . . . . . . . .   3
     5.1.  Numbering Lists across Lists and Sections . . . . . . . .   4
     5.2.  Where the List Numbering Continues  . . . . . . . . . . .   4
     5.3.  nested lists  . . . . . . . . . . . . . . . . . . . . . .   5
     5.4.  List Formats  . . . . . . . . . . . . . . . . . . . . . .   5
   6.  Example of Code or MIB Module To Be Extracted . . . . . . . .   8
   7.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .   9
   8.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   9
   9.  Security Considerations . . . . . . . . . . . . . . . . . . .   9
   10. References  . . . . . . . . . . . . . . . . . . . . . . . . .   9
     10.1.  Normative References . . . . . . . . . . . . . . . . . .   9
     10.2.  Informative References . . . . . . . . . . . . . . . . .  10
   Appendix A.  Additional Stuff . . . . . . . . . . . . . . . . . .  10
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  10
.fi
.in 3

.ti 0
1.  Introduction

The original specification of xml2rfc format is in RFC\02629
[RFC2629].

.ti 0
1.1.  Requirements Language

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 RFC 2119 [RFC2119].

.ti 0
2.  Simple List

List styles: 'empty', 'symbols', 'letters', 'numbers', 'hanging',
\'format'.

.in 6
.ti 3
o  First bullet

.ti 3
o  Second bullet

.in 3
You can write text here as well.

.ti 0
3.  Figures
.bp
Figures should not exceed 69 characters wide to allow for the indent
of sections.

.ce 1
Preamble text - can be omitted or empty.
.nf

                       +-----------------------+
                       | Use XML, be Happy :-) |
                       |_______________________|
.fi

.ce 1
Cross-references allowed in pre- and postamble. [min_ref].

.ce 1
Figure 1

The CDATA means you don't need to escape meta-characters (especially
<\0(&lt;) and &\0(&amp;)) but is not essential.  Figures may also
have a title attribute but it won't be displayed unless there is also
an anchor.  White space, both horizontal and vertical, is significant
in figures even if you don't use CDATA.

.ti 0
4.  Subsections and Tables

.ti 0
4.1.  A Subsection

By default 3 levels of nesting show in table of contents but that can
be adjusted with the value of the "tocdepth" processing instruction.

.ti 0
4.2.  Tables

\&.. are very similar to figures:

.ce 2
Tables use ttcol to define column headers and widths.  Every cell
then has a "c" element for its content.
.nf

                        +----------+----------+
                        | ttcol #1 | ttcol #2 |
                        +----------+----------+
                        |   c #1   |   c #2   |
                        |   c #3   |   c #4   |
                        |   c #5   |   c #6   |
                        +----------+----------+
.fi

.ce 1
which is a very simple example.

.ce 1
Table 1: A Very Simple Table

.ti 0
5.  More about Lists

Lists with 'hanging labels': the list item is indented the amount of
.bp
the hangIndent:

.in 11
.ti 3
short   With a label shorter than the hangIndent.

.ti 3
fantastically long label  With a label longer than the hangIndent.

.ti 3
vspace_trick
.sp 0
Forces the new item to start on a new line.

.in 3
Simulating more than one paragraph in a list item using <vspace>:

.in 7
.ti 3
a.  First, a short item.

.ti 3
b.  Second, a longer list item.
.sp 1
And something that looks like a separate pararaph..

.in 3
Simple indented paragraph using the "empty" style:

.in 6
The quick, brown fox jumped over the lazy dog and lived to fool
many another hunter in the great wood in the west.

.ti 0
5.1.  Numbering Lists across Lists and Sections

.in 3
Numbering items continuously although they are in separate <list>
elements, maybe in separate sections using the "format" style and a
"counter" variable.

First list:

.in 7
.ti 3
R1  #1

.ti 3
R2  #2

.ti 3
R3  #3

.in 3
Specify the indent explicitly so that all the items line up nicely.

Second list:

.in 7
.ti 3
R4  #4

.ti 3
R5  #5

.ti 3
R6  #6

.ti 0
5.2.  Where the List Numbering Continues
.bp
.in 3
List continues here.

Third list:

.in 7
.ti 3
R7  #7

.ti 3
R8  #8

.ti 3
R9  #9

.ti 3
R10 #10

.in 3
The end of the list.

.ti 0
5.3.  nested lists

Simulating more than one paragraph in a list item using <vspace>:

.in 7
.ti 3
a.  First, a short item.

.ti 3
b.  Second, a longer list item.
.sp 1
And something that looks like a separate paragraph.

.ti 3
c.  and a sublist, also with letters

.in 11
.ti 7
A.  first subitem

.ti 7
B.  second subitem

.ti 7
C.  and a sub-sublist, also with letters

.in 15
.ti 11
a.  first sub-subitem

.ti 11
b.  second sub-subitem

.ti 0
5.4.  List Formats

.in 3
many formats

.in 6
.ti 3
a  first %c-item

.ti 3
b  more %c-items

.ti 3
A  first %C-item

.ti 3
B  more %C-items
.bp
.ti 3
1  first %d-item.

.ti 3
2  more %d-items.

.ti 3
i    first %i-item

.ti 3
ii   more %i-items

.ti 3
iii  more %i-items

.ti 3
iv   more %i-items

.ti 3
v    more %i-items

.ti 3
vi   more %i-items

.ti 3
vii  more %i-items

.ti 3
viii more %i-items

.ti 3
ix   more %i-items

.ti 3
I    first %I-item

.ti 3
II   more %I-items

.ti 3
III  more %I-items

.ti 3
IV   more %I-items

.ti 3
V    more %I-items

.ti 3
VI   more %I-items

.ti 3
VII  more %I-items

.ti 3
VIII more %I-items

.ti 3
IX   more %I-items

.ti 3
1   first %o-item

.ti 3
2   more %o-items

.ti 3
3   more %o-items

.ti 3
4   more %o-items
.bp
.ti 3
5   more %o-items

.ti 3
6   more %o-items

.ti 3
7   more %o-items

.ti 3
10  more %o-items

.ti 3
11  more %o-items

.ti 3
1   first %x-item

.ti 3
2   more %x-items

.ti 3
3   more %x-items

.ti 3
4   more %x-items

.ti 3
5   more %x-items

.ti 3
6   more %x-items

.ti 3
7   more %x-items

.ti 3
8   more %x-items

.ti 3
9   more %x-items

.ti 3
a   more %x-items

.ti 3
b   more %x-items

.ti 3
c   more %x-items

.ti 3
d   more %x-items

.ti 3
e   more %x-items

.ti 3
f   more %x-items

.ti 3
10  more %x-items

.ti 3
11  more %x-items

.ti 3
1   first %X-item

.ti 3
2   more %X-items
.bp
.ti 3
3   more %X-items

.ti 3
4   more %X-items

.ti 3
5   more %X-items

.ti 3
6   more %X-items

.ti 3
7   more %X-items

.ti 3
8   more %X-items

.ti 3
9   more %X-items

.ti 3
A   more %X-items

.ti 3
B   more %X-items

.ti 3
C   more %X-items

.ti 3
D   more %X-items

.ti 3
E   more %X-items

.ti 3
F   more %X-items

.ti 3
10  more %X-items

.ti 3
11  more %X-items

.ti 0
6.  Example of Code or MIB Module To Be Extracted

.in 3
The <artwork> element has a number of extra attributes that can be
used to substitute a more aesthetically pleasing rendition into HTML
output while continuing to use the ASCII art version in the text and
nroff outputs (see the xml2rfc README for details).  It also has a
"type" attribute.  This is currently ignored except in the case
\'type="abnf"'.  In this case the "artwork" is expected to contain a
piece of valid Augmented Backus-Naur Format (ABNF) grammar.  This
will be syntax checked by xml2rfc and any errors will cause a fatal
error if the "strict" processing instruction is set to "yes".  The
ABNF will also be colorized in HTML output to highlight the syntactic
components.  Checking of additional "types" may be provided in future
versions of xml2rfc.
.nf
.bp
/**** an example C program */

#include <stdio.h>

void
main(int argc, char *argv[])
{
    int i;

    printf("program arguments are:\\n");
    for (i = 0; i < argc; i++) {
        printf("%d: \\"%s\\"\\n", i, argv[i]);
    }

    exit(0);
} /* main */

/* end of file */

.fi

.ti 0
7.  Acknowledgements

This template was derived from an initial version written by Pekka
Savola and contributed by him to the xml2rfc project.

This document is part of a plan to make xml2rfc indispensable
[DOMINATION].  This document may be shared as needed [SHARING].

.ti 0
8.  IANA Considerations

This memo includes no request to IANA.

All drafts are required to have an IANA considerations section (see
the update of RFC 2434 \%[I-D.narten-iana-considerations-rfc2434bis]
for a guide).  If the draft does not require IANA to do anything, the
section contains an explicit statement that this is the case (as
above).  If there are no requirements for IANA, the section will be
removed during conversion into an RFC by the RFC Editor.

.ti 0
9.  Security Considerations

All drafts are required to have a security considerations section.
See RFC 3552 [RFC3552] for a guide.

.ti 0
10.  References

.ti 0
10.1.  Normative References
.bp
.in 14
.ti 3
[RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.

.ti 3
[min_ref]  authSurName, authInitials., "Minimal Reference", 2006.

.ti 0
10.2.  Informative References

.in 3
[DOMINATION]
.in 14
Mad Dominators, Inc., "Ultimate Plan for Taking Over the
World", 1984, <http://www.example.com/dominator.html>.

.in 3
[I-D.narten-iana-considerations-rfc2434bis]
.in 14
Narten, T. and H. Alvestrand, "Guidelines for Writing an
IANA Considerations Section\0in RFCs",
draft-narten-iana-considerations-rfc2434bis-09 (work in
progress), March 2008.

.ti 3
[RFC2629]  Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629,
June 1999.

.ti 3
[RFC3552]  Rescorla, E. and B. Korver, "Guidelines for Writing RFC
Text on Security Considerations", BCP 72, RFC 3552, July
2003.

.ti 3
[SHARING]  Sesame Street, "I Learned to Share in Kindergarten", 1972,
<http://www.example.com/sharing.html>.

.ti 0
Appendix A.  Additional Stuff

.in 3
This becomes an Appendix.

.ti 0
Authors' Addresses
.nf

Elwyn Davies (editor)
Folly Consulting
Soham
UK

Phone: +44 7889 488 335
Email: elwynd@dial.pipex.com
.fi

.nf
.bp
Quintin Zhao
Huawei Technology
125 Nagog Technology Park
Acton, MA  01719
US

Email: quintin.zhao@huawei.com
.fi
