Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 3.12 KB

drafting-in-other-markup-languages.md

File metadata and controls

59 lines (40 loc) · 3.12 KB
title description published date tags editor dateCreated
Drafting in other markup languages
true
2021-12-14 20:45:17 UTC
markdown
2021-08-19 09:01:14 UTC

There are many other lightweight text markup languages with their own processing systems. Those listed here are supported by a toolchain that produces either a plaintext or an RFCXML Internet-Draft.

Most of these toolchains are not widely used and in some cases rely on tools that are unmaintained.

AsciiDoc

AsciiDoc is a text document format similar to Markdown.

AsciiRFC with metanorma-ietf

AsciiRFC is an AsciiDoc syntax for writing IETF documents. The metanorma-ietf tool converts documents in AsciiRFC into RFCXML.

LaTeX

LaTeX is an open source typesetting system designed for the production of technical and scientific documentation. An out of date LaTeX template is available.

Lyx with lyx2rfc

Lyx is an open source what-you-see-is-what-you-mean (WYSIWYM) GUI editor for LaTeX documents. lyx2rfc is a plugin to Lyx that converts LyX XHTML output to RFC XML.

lyx2rfc is unmaintained and was last updated in 2014.

nroff format

nroff is a text formatting program that produces output suitable for fixed-width files. An out of date Nroff template is available with a similarly out of date tutorial.

Emacs editor in nroff mode

The popular open source editor Emacs includes Nroff mode.

nroff with Nroff Edit

nroff Edit is a Java based WYSIWYG editor for writing and editing Internet-Drafts in nroff. The nroff based Internet-Draft file is edited in the left window while the resulting compiled text version is instantly shown in the right Window as a result of any edit changes.

Nroff Edit is unmaintained and was last updated in 2015.

nroff with nroff2xml

nroff2xml is a Python script that converts a file in nroff format into v2 RFCXML.

nroff2xml is unmaintained and was last updated in 2013.

Org Mode

Org is a highly flexible structured plaintext file format that is used mainly in the Emacs editor in Org Mode.

Org Mode RFC XML Exporter

Org Mode RFC XML Exporter is an Emacs plugin that exports Org Mode files to RFCXML.

reStructuredText

reStructuredText (RST) is a text document format similar to Markdown. It is used for technical documentation by Python developers, by the Linux kernel community, and by CMake developers, among others.

RST with rst2xmlrfc

rst2rfcxml is a processing tool that converts files in RST format into v3 RFCXML.