Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 3.88 KB

drafting-in-xml.md

File metadata and controls

53 lines (38 loc) · 3.88 KB
Raw
title description published date tags editor dateCreated
Drafting in XML
true
2022-03-01 03:16:19 UTC
markdown
2021-08-18 10:56:56 UTC

Introduction

For an introduction to RFCXML see the RFCXML overview and background and for detailed documentation on each element and attribute see the RFCXML vocabulary reference.

Modern XML toolchains include advanced features that support XML editing including schema validation and schema-aware editing. The templates provided at Templates and schemas contain the necessary code to make this work.

Quick start guide

  1. Choose your RFCXML toolchain from the list below
  2. Clone or download the RFCXML template repository.
  3. Edit the Standard (or Annotated) template.
  4. If you require automated builds then consider the Github workflow.
  5. Process your edited I-D using the IETF Author Tools web service.

RFCXML toolchains

The following XML toolchains have been reported as in use by IETF community members. These are all interactive XML editors.

Emacs editor in nXML Mode

The popular open source editor Emacs includes nXML Mode, which enables validation and schema-sensitive editing when you use an RNC schema.

OxygenXML

Oxygen XML Editor is a commercial XML editor. This tool comes in different versions with a number of different licensing options, though all versions support RELAX NG validation and some support syntax highlighting and intelligent auto-completion. The premium version also supports collaborative edIting, including tracked changes and comment review.

The same company also makes Oxygen Content Fusion, which support web-based collaborative editing and document review.

XMLmind XML Editor (XXE) with xml2rfc-xxe

XMLmind XML Editor (XXE) is a commercial near-WYSIWYG XML editor with a free edition for personal use. XXE supports RNC schema validation and context-sensitive editing.

A community developed configuration for XXE, xml2rfc-xxe is available, providing additional context-sensitive editing features, however this does not support the latest version of RFCXML and is unsupported.

Text editor wtih xmllint

IETF community members report using a range of text editors with varying support for XML editing, and and validating the RFCXML externally using xmllint, a common open source, command line tool.

Supporting tools

Authors writing in XML may find the following tools helpful:

Add XML tags for RFC2119 keywords

This script adds <bcp14> tags around RFC 2119 keywords in XML source.

bibtex2rfc

bibtex2rfc converts BibTeX citations into BibXML references. See References in RFCXML for more details.

i-d-template

Drafting in Markdown describes the use of the i-d-template and internet-draft-template projects for managing I-Ds. These tools can be used to manage RFCXML I-Ds, with most of the same automation features.