DRAFT
Name: ion-ion-formats
Title: ION Format specification
Draft date: 2006-11-24 12:44 UTC
To be approved by: IESG
Editor(s): Brian Carpenter, Cullen Jennings
Discussion forum: ietf@ietf.org
IONs are written in English, normally using only ASCII. However, UTF-8
may be used when needed for proper names, addresses, references and examples.
IONs may be published in 2 formats:
- Text
- HTML
Text format
===========
In this case, the ION starts with a header modelled after
an email header, with field: value pairs. Each field:value is one line.
The required headers for IONs are:
Name:
Title:
Approved by:
Approved date: (in YYYY-MM-DD format)
For ION drafts, the word DRAFT + a blank line appears before the header.
Required headers for drafts are:
Name:
Title:
Draft date: (in YYYY-MM-DD hh:mm UTC format)
To be approved by:
Additional headers that may appear are:
Editor(s):
Discussion forum:
The document name always starts with ion- and is descriptive.
It is also used as a file name, e.g. ion-ion-formats.txt.
After the headers, the text of the document appears.
It should have less than 75 characters per line, but is otherwise free form.
An abstract and table of contents is not required except for long documents.
Apart from the headers, there is no required boilerplate and there are no
mandatory sections.
HTML format
===========
An HTML document needs to be valid HTML, and use no fancy features.
In this case, the ION starts with a table giving the same information as
above; the HTML for this ION (when approved) would be:
ION: ION Format specification
| Name: | ion-ion-formats
|
| Title: | ION Format specification
|
| Approved date: | (to be inserted)
|
| Approved by: | IESG
|
First section of document
An HTML ION can include images, but the URLs for images have to be of the
form - for instance, an image in this document
would be 
.
Javascript or other embedded scripting is not permitted.
Styles, if used, should be CSS1. No external stylesheets are permitted.
(A later version of this document may name one external stylesheet,
based on experience.)
A draft ION will have the word DRAFT in its title and as a H1 section in
front of the initial table:
DRAFT ION: ION Format specification
DRAFT
| Name: | ion-ion-formats
|
| Title: | ION Format specification
|
| Draft date: | (to be inserted)
|
| To be approved by: | IESG
|
First section of document
Tolerance of XML2RFC-generated HTML
===================================
If a draft has been developed using XML2RFC but it is decided to
publish it as an ION, it is acceptable to use the HTML output
from XML2RFC. The following should be done to generate an
approximation to ION HTML format (this example is for a draft ION).
1. Insert after any other commands:
This suppresses all IETF boilerplate.
2. Modify the document name and title accordingly:
DRAFT ION: ION Format specification
3. Insert before the construct:
Name: ion-ion-formats
Title: ION Format specification
Draft date: (to be inserted)
To be approved by: IESG
In this case the generated HTML file is considered to be the
ION but the XML2RFC source should also be stored in the repository.
Other formats
=============
If an XML document format is defined suitable for this application,
more text will come in the next version of this ION.
The first draft of this ION was written by Harald Alvestrand.