metanorma / rfc-asciirfc-minimal

Template for creating an Internet-Draft / RFC in AsciiRFC using Metanorma

AsciiRFC Template For Writing RFC / Internet Drafts

This document is available in its rendered forms here:

• AsciiRFC Template For Writing RFC (HTML)

• TXT

• NITS

• RFC XML v2

This Internet-Draft is written in AsciiRFC using the Metanorma framework, via the metanorma-ietf gem.

Quick Start

For a blank slate start of your Internet-Draft written in AsciiRFC:

1. Clone this repository

2. Copy out all the files (including the dot-files)

3. Done!

Usage

Fetching The Document

git clone https://github.com/metanorma/rfc-asciirfc-minimal

Installing Build Tools

You will need to install Metanorma, xml2rfc and idnits (for submission preflight).

Please see https://www.metanorma.com for installation instructions.

On macOS

brew install idnits
brew install python
easy_install pip
pip install -r requirements.txt
gem install bundler
bundle install

Building The Document

make all

Checking Against idnits

idnits is the RFC checking tool prior to submissions.

The make target finds exactly the document name from the :name: document attribute and puts the file in the right place before calling idnits to prevent it complaining about the location.

export ID_NAME=asciirfc-minimal
make draft-${ID_NAME}.nits

Checking For Invalid / Unicode Characters

export ID_NAME=asciirfc-minimal
pcregrep --color='auto' -n "[\x80-\xFF]" draft-${ID_NAME}.xml

Iterating The Document

export ID_NAME=asciirfc-minimal
make clean all; open draft-${ID_NAME}.txt