E. Davies, Ed. | |
Folly Consulting | |
Quintin Zhao | |
Huawei Technology | |
March 1, 2007 |
Put Your Internet Draft Title Here
draft-ietf-xml2rfc-template-05
Insert an abstract: MANDATORY. This template is for creating an Internet Draft.
The original specification of xml2rfc format is in RFC 2629.
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.
List styles: 'empty', 'symbols', 'letters', 'numbers', 'hanging', 'format'.
You can write text here as well.
Figures should not exceed 69 characters wide to allow for the indent of sections.
Preamble text - can be omitted or empty.
+-----------------------+ | Use XML, be Happy :-) | |_______________________|
Cross-references allowed in pre- and postamble. [min_ref].
Figure 1
The CDATA means you don't need to escape meta-characters (especially < (<) and & (&)) 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.
By default 3 levels of nesting show in table of contents but that can be adjusted with the value of the "tocdepth" processing instruction.
.. are very similar to figures:
Tables use ttcol to define column headers and widths. Every cell then has a "c" element for its content.
ttcol #1 | ttcol #2 |
---|---|
c #1 | c #2 |
c #3 | c #4 |
c #5 | c #6 |
which is a very simple example.
Lists with 'hanging labels': the list item is indented the amount of the hangIndent:
Simulating more than one paragraph in a list item using <vspace>:
Simple indented paragraph using the "empty" style:
Numbering items continuously although they are in separate <list> elements, maybe in separate sections using the "format" style and a "counter" variable.
First list:
Specify the indent explicitly so that all the items line up nicely.
Second list:
List continues here.
Third list:
The end of the list.
Simulating more than one paragraph in a list item using <vspace>:
many formats
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.
<CODE BEGINS> file "example.c" /**** 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 */ <CODE ENDS>
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].
This memo includes no request to IANA.
All drafts are required to have an IANA considerations section (see the update of RFC 2434 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.
All drafts are required to have a security considerations section. See RFC 3552 for a guide.
[min_ref] | authSurName, authInitials., "Minimal Reference", 2006. |
[RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997. |
[DOMINATION] | Mad Dominators, Inc., "Ultimate Plan for Taking Over the World", 1984. |
[I-D.narten-iana-considerations-rfc2434bis] | Narten, T. and H. Alvestrand, "Guidelines for Writing an IANA Considerations Section in RFCs", Internet-Draft draft-narten-iana-considerations-rfc2434bis-09, March 2008. |
[RFC2629] | Rose, M., "Writing I-Ds and RFCs using XML", RFC 2629, June 1999. |
[RFC3552] | Rescorla, E. and B. Korver, "Guidelines for Writing RFC Text on Security Considerations", BCP 72, RFC 3552, July 2003. |
[SHARING] | Sesame Street, "I Learned to Share in Kindergarten", 1972. |
This becomes an Appendix.
This becomes an unnumbered section