Markdown for XML2RFC v3 - Update

December 18, 2014

docs

And another update (2015-01-12)

This is a follow up the previous article about using markdown for XML2RFC. The syntax has been changed and more features have been implement. And my blackfriday fork has been renamed mmark.

See this document for an up to date syntax of mmark. A short summery will be given here.

New features are:

Also the possibility to convert pandoc2rfc documents to mmark has been added (as a quick and dirty perl script + pandoc!):

For example converting the middle section from some other draft:

% pandoc --atx-headers -t markdown_phpextra < ~/i-d/nsec4/middle.mkd |\
    ./parts.pl | tee part.md

For a first pass for getting a (non) perfect title block you could use convert/titleblock.pl.

Citations

Syntax has been changed slightly.

Use the reference syntax: [@RFC2535 p. 23].

They can optionally have ‘!’ or ‘?’ modifier to normative or informative reference. The reference section is automatically generated. Here is a normative and informative reference: [@!RFC2335] and [@?RFC2335].

The default is informative. This only have to be done once, after that you can just use [@RFC2535]. And an even shorter syntax has been added, just @RFC2535, works once a citation has been defined.

Abstract

Start the section with the special header syntax .#. The section’s name must be abstract (case insensitive). (Colophon and friends might be added as well).

Notes and Asides

Asides is created with prefixing each line of a paragraph with A>, notes: N>.

Index

Using triple parentheses, like so: (((Cats, Tiger))). You can now only add a primary index with !: (((!Cats, Tiger))).

Parts

Use -# as a header to start a new part.

Math

The double $$ is detected and anything inside is math. If an entire paragraph consists out of math, display mode is used.

XML  Mmark  Markdown  XML2RFC