Repository files navigation

This repository is for files associated with the RFCXML language. For more information on RFCXML see theauthors.ietf.org site, particularlyRFCXML Overview and Background andRFCXML Vocabulary Reference.

When raising issues, please add appropriate labels:

• bug,enhancement orquestion for the type of issue
• RFCXML,grammar files ortemplates for the subject of the issue. UseRFCXML when talking about the language itself, not any instantiation of it.

Issues withxml2rfc should be reported in that repository.

RFCXML is defined in two RelaxNG Compact (RNC) schema files:

• rfc7991bis.rnc is the RelaxNG Compact schema for the current version of RFCXML. XML editors that validate against a schema and which support schema-aware editing, require a local copy of this schema and the following processing instruction in the RFCXML file:

<?xml-model href="rfc7991bis.rnc"?>

• SVG-1.2-RFC.rnc is the RelaxNG Compact schema for the subset of SVG allowed in RFCXML documents (SVG 1.2 RFC). This schema is referenced in rfc7991bis.rnc and so no specific processing instruction is required to include it but a local copy must be present.

The files in the root of this repository are the latest versions of those files.

The current official templates and schema files for RFCXML can be found in thetemplates folder:

• draft-rfcxml-general-template-standard-00.xml is an RFCXML template that includes examples of the most commonly used features of RFCXML with comments explaining how to customise them. This template can be quickly turned into an I-D by editing the examples provided.
• draft-rfcxml-general-template-bare-00.xml is an RFCXML template for experienced authors who want to start from the barest template possible. This template validates correctly but is not a valid I-D as many key sections are missing.
• draft-rfcxml-general-template-annotated-00.xml is an RFCXML template that includes examples for almost all of the features of RFCXML and many examples of how to achieve specific formatting, along with ample comments to explain the examples.

All of the templates above include the RFCXML processing instruction and so will support schema validation and schema-aware editing out of the box provided that the two grammar files above are in the validation path (generally in the same directory).

SeeTemplates and Schemas for more details.

Old versions of the RFCXML grammar file (not the SVG grammar file) can be found in theold folder. This includes both .rnc (RelaxNG Compact) and .rng (RelaxNG) versions. Note that inxml2rfc, the main tool for processing RFCXML files, these files are named v3.rnc and v3.rng though only the .rnc file is used. These files were never assigned a version number when created and so the snapshots here have been renamed by appending the version number of thexml2rfc release that first introduced the change (e.g. the version of v3.rnc that was released with v2.32.0 of xml2rfc has been renamed v3-2.32.0.rnc).

Changes to the grammar were initially frequent and then in recent years have become infrequent and so there are normally multiple versions ofxml2rfc that use the same grammar. The table below lists the versions of the grammar and the versions of xml2rfc that used each version.

For more information onxml2rfc changes, see theCHANGELOG

The files found in thelegacy folder are for those working with very old I-Ds or RFCs and should not be used for any new I-Ds.

• rfc7991.rnc is the RelaxNG Compact Schema for the first release of v3 of RFCXML as documented inRFC7991. Use rfc7991bis.rnc instead.
• rfc7749.rnc is the RelaxNG Compact Schema for v2 of RFCXML as documented inRFC7749. When originally published, this file was called v2.rnc.
• rfc2629.dtd is the DTD for v1 of RFCXML as documented inRFC2629.
• rfc2629-other.ent is a small set of character entities. This file is no longer needed as the special processing of non-ASCII character has been superseded by direct support for non-ASCII characters in RFCXML.
• rfc2629-xhtml.ent is a larger set of character entities. This file is no longer needed as the special processing of non-ASCII character has been superseded by direct support for non-ASCII characters in RFCXML.