Pandoc2rfc translates text written in the Markdown variant Pandoc to documents in xml2rfc format. It's an easy way to write RFCs.
The documentation for Pandoc2rfc can be found at: http://www.rfc-editor.org/rfc/rfc7328.txt.
Note that I consider mmark the logical successor of Pandoc2rfc. Pandoc2rfc can't output XML2RFC v3 XML, so when the IETF switches over to that format, you'll need something else. Mmark can output v3 (and v2 for that matter).
Differences with Pandoc
Although you can type Pandoc just fine, there are two things that differ
- Using Pandoc citations is not supported, you must use internal references for this;
Referencing figures and tables is done by abusing inline footnotes, which are typeset directly after the figure or table. Like so:
^[tab:simple::Demonstration of **simple** table syntax.]
tab:simplewill be the anchor and the text after
::as used for the title.
style=format REG%dare typeset with strikethrough text in the first element, as such:
1. ~~REQ%d~~ First REQ1 item; 2. Second REQ2 item.
An index is done by (yet again) by using a foonote, but the first item is a superscript:
^[ ^list^ format styles]
The rest of the content is the "subitem"
As said, more extensive docs are here: http://www.rfc-editor.org/rfc/rfc7328.txt. But after some setup, it is just typing Pandoc syntax in $EDITOR.
template.xml to your I-D directory. Modify
template.xml according to your needs and run:
pandoc -t docbook -s <yourfile>.mkd | \ xsltproc --nonet transform.xsl - > <yourfile>.xml
And to create a draft.txt
xml2rfc template.xml -f draft.txt --text
And/or create a Makefile.
Or you can install
Pandoc2rfc on your system. Then copy
to your I-D directory. Modify according to your needs and run:
Packages can be found for Debian/Ubuntu at:
https://launchpad.net/~miek/+archive/pandoc2rfc, they should also install in previous Ubuntu versions.
Or see http://pandoc2rfc.implementers.org/ for proper Debian packages.
Note that you don't even need
xsltproc per se, just an XSLT transformer
program. Also note that only
xsltproc is tested.
Pandoc2rfc v2 works with
xml2rfc version 2.x.
Miek Gieben - 2012