WriteID

Writing Internet-Draft Source

The YANG-I-D repository contains a template for an Internet-Draft, draft.xml.template. The easiest way to start writing the I-D is to copy this template to the file $(I_D).xml, where $(I_D) denotes the value of the I_D variable in the Makefile, and commit this file to git. The template file contains instructions for adapting the I-D source and integrating YANG modules or other external entities into the text.

The XML source of the I-D should follow the schema and rules of xml2rfc. However, this source should be revision independent so that it can be used continually for all revisions. To achieve this, the docName attribute should not be present – the name will be constructed automatically from the I_D and REVNO Makefile variable.

The basic idea is that this revision-independent source is automatically converted to a specific revision of the draft. Before this conversion, all YANG modules, figures and the instance document are wrapped in the <artwork> elements and saved in files with the additional extension .aw. Contents of these files may then be included in appropriate places of the I-D using XML entity references. These external entities are defined in the files yang.ent and figures.ent that are also generated by the Makefile. See the file draft.xml.template for examples.