title | date | aliases | toc | |
---|---|---|---|---|
FAQ |
2018-07-22 14:05:51 +0100 |
|
true |
Mmark Frequently Asked Questions. Also see the XML2RFCv3 FAQ: https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html, section below will have the same questions, but then answered in mmark syntax.
Use the following as starting point for your title block, ipr
and submissiontype
are the important
settings here.
title = "Title"
abbrev = "Title"
ipr = "none"
submissiontype = "independent"
keyword = [""]
[seriesInfo]
name = "Internet-Draft"
value = "draft-00"
stream = "independent"
status = "informational"
Set submissiontype
and stream
in seriesInfo
to IRTF. Items like workgroup
function as they
do for normal Internet-Draft documents.
Set submissiontype
and stream
in seriesInfo
to IAB. Items like workgroup
are (I believe)
ignored for this stream.
Use this as the seriesInfo
:
[seriesInfo]
name = "FYI"
value = "2100"
stream = "IETF"
status = "informational"
Note this makes xml2rfc still complain, but at least creates valid XML.
Use role = "editor"
in the author's section in the titleblock.
Use a [[contact]]
in the toml header:
[[contact]]
initials="D."
surname="Addison"
fullname="David Addison"
[contact.address.postal]
city = "St. Petersburg"
code = "FL 33709-4819"
Using the contact is done by referencing it: [@David Addison]
(using the fullname
property). If
the reference is the first thing after a new paragraph it will be expanded like XML2RFC expands
authors in an Internet-Draft.
You likely forgot to open the back matter with {backmatter}
.
The latest version of xml2rfc is the supported version. As it currently stands, the xml2rfc implementation is the spec. Older versions may happen to work, with newer features unsupported, but this is not guaranteed.
Latest version of xml2rfc can be found at pypi. It can also be found on Github.
Use the standard markdown syntax for unordered, ordered and definition lists.
Use a block level attribute: {type="(%d)"}
, {type="(%c)"}
or {type="REQ%d"}
.
Set the group attribute with a block level attribute.
{type="REQ%d" group="reqs"}
1. do a
2. do b
Here is text in between
{type="REQ%d" group="reqs"}
1. do c
2. do d
First Term
: This is the definition of the first term.
Second Term
: This is one definition of the second term.
A non compact definition list can be done like so: (not the block attribute allows for a newline after the term):
{newline="true"}
First Term
: This is the definition of the first term.
Second Term
: This is one definition of the second term.
Foo validator
: It performs the following actions:
* runs
* jumps
* walks
{type="Step %d:"}
1. Send it to
* Alice
* Bob
* Carol
This is handled for you, mmark will wrap non-ASCII characters in <u>
. The asciiFullname
and
friends used in authors and contacts is currently not implemented.
Use the markdown table syntax.
- bold:
**bold**
- italics
*italics*
- fixed-width, wrap in back-ticks
- subscript:
_2_
- superscript:
^10^
Just use **MUST**
, i.e. make the bcp14 element bold and capital, mmark wraps these in <bcp14>
tags.