TOC |
Name: ion-ion-xml-template
Title: XML2RFC Template for IONs
Draft date: March 12, 2007
To be approved by: IESG
Editor(s): Jari Arkko and Brian Carpenter
Discussion forum: ietf@ietf.org
This note provides an example XML template. This template can be used with XML2RFC to write an ION.
1.
Introduction
2.
Template
3.
References
TOC |
As specified in [ION‑ion‑format] (Carpenter, B. and C. Jennings, “ION Format specification,” January 2007.), IONs can be written using the [RFC2629] (Rose, M., “Writing I-Ds and RFCs using XML,” June 1999.) XML format and converted to HTML via the XML2RFC tool (Rose, M. and C. Levert, “The XML2RFC tool,” .) [XML2RFC]. This note provides an example XML template for such an ION.
TOC |
Use the following template:
<?xml version="1.0" encoding="iso-8859-1" ?> <!DOCTYPE rfc SYSTEM "rfc2629.dtd"> <!-- This is a template for producing IONs with xml2rfc, as an alternative to writing text or HTML directly. By the way, you only generate html - there is no need for both html and txt for the same ION.--> <!-- Create a table of contents --> <?rfc toc="yes"?> <!-- Prefer symbolic references, and sort them --> <?rfc symrefs="yes"?> <?rfc sortrefs="yes"?> <!-- The IPR setting is a no-op. Choose the short name of your ION. --> <rfc ipr="full3978" docName="ion-topic"> <!-- These settings ensure minimal amount of whitespace --> <?rfc compact="yes"?> <?rfc autobreaks="no"?> <?rfc tocindent="yes"?> <?rfc tocompact="yes"?> <?rfc subcompact="yes"?> <!-- Suppress RFC headers --> <?rfc topblock="no"?> <?rfc private="ion"?> <!-- Example RFC citation --> <!ENTITY RFC2026 PUBLIC '' 'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2026'> <!-- Example I-D citation --> <!ENTITY DRAFT-proto SYSTEM 'http://xml.resource.org/public/rfc/bibxml3/reference.I-D.ietf-proto-wgchair-doc-shepherding'> <front> <!-- Choose the title of your ION. --> <!-- Remove the word DRAFT when approved. --> <title abbrev="ion-topic">DRAFT ION: (Topic)</title> <date month="March" year="2007" /> <keyword>topic</keyword> <!-- This is where we generate the required header --> <note title="Status: DRAFT"> <!-- or "Status: Approved" --> <list> <t>Name: ion-(topic)</t> <t>Title: (Topic)</t> <t>Draft date: (Date)</t> <t>To be approved by: IESG</t> <!-- or IAB or IAOC --> <!-- or just Approved by: --> <t>Editor(s): (Editor)</t> <!-- Optional --> <t>Discussion forum: (List)</t> <!-- Optional --> </list> </note> <!-- An abstract is not required but may be helpful --> <abstract> <t>(Abstract)</t> </abstract> </front> <middle> <section title="(Section name)"> <t>Insert content here. In the body, everything is standard xml2rfc, including references <xref target="RFC2026"/>, <xref target="I-D.ietf-proto-wgchair-doc-shepherding"/>, <xref target="ION-ion-format"/>. There are no required sections, and no required boilerplate except for the standard document header above.</t> </section> <!-- We really mustn't have IANA Considerations. If you need IANA assignments, you shouldn't be writing an ION. --> <!-- We don't need Security Considerations unless you *really* want them. --> </middle> <section title="Acknowledgements"> <t>Since we don't list authors, it's nice to mention who contributed.</t> </section> <back> <references title="References"> &RFC2026; &DRAFT-proto; <reference anchor="ION-ion-format"> <front> <title>ION Format specification</title> <author initials='B' surname='Carpenter' fullname='Brian Carpenter'><organization/></author> <author initials='C' surname='Jennings' fullname='Cullen Jennings'><organization/></author> <date month="January" year="2007" /> </front> <seriesInfo name="ION" value="ion-ion-format, IETF" /> <format type='TXT' target= 'http://www.ietf.org/IESG/content/ions/ion-ion-store.html' /> </reference> </references> </back> </rfc>
TOC |
[ION-ion-format] | Carpenter, B. and C. Jennings, “ION Format specification,” ION ion-ion-format, IETF, January 2007. |
[RFC2629] | Rose, M., “Writing I-Ds and RFCs using XML,” RFC 2629, June 1999 (TXT, HTML, XML). |
[XML2RFC] | Rose, M. and C. Levert, “The XML2RFC tool.” |