@@ -24,7 +24,7 @@ Callouts
24
24
25
25
.RS
26
26
.IP \(en 4
27
- \fI always \fP rendered and require double greater/less-than signs, \fB \f C <<1>>\fR .
27
+ \fI always \fP rendered and require double greater/less\ - than signs, \fB \f C <<1>>\fR .
28
28
.IP \(en 4
29
29
\fI always \fP require a comment in the code, i.e. \fB \f C //<<1>>\fR will be rendered as a callout, a plain
30
30
\fB \f C <<1>>\fR will not.
@@ -51,7 +51,7 @@ maintain.
51
51
.PP
52
52
Because of the abstract syntax tree it will also be easier to write helper tools, like, for instance
53
53
a tool that checks if all referenced labels in the document are actually defined. Another idea could
54
- be to write a "check-the-code" tool that syntax checks all code in code blocks. Eventually these
54
+ be to write a "check\ - the\ - code" tool that syntax checks all code in code blocks. Eventually these
55
55
could be build into the \fB \f C mmark\fR binary itself. See some fun
56
56
ideas
57
57
\[la ] https://github.com/mmarkdown/filter\[ra ] here.
@@ -102,7 +102,7 @@ extensions
102
102
.IP \(bu 4
103
103
\fI Smartypants \fP , expand \fB \f C --\fR and \fB \f C ---\fR into ndash and mdashes.
104
104
.IP \(bu 4
105
- \fI SuperSubscript \fP , parse super- and subscript: H\d 2\u O is water and 2\u 10\d is 1024.
105
+ \fI SuperSubscript \fP , parse super\ - and subscript: H\d 2\u O is water and 2\u 10\d is 1024.
106
106
.IP \(bu 4
107
107
\fI Tables \fP , parse tables.
108
108
.IP \(bu 4
@@ -148,7 +148,7 @@ Asides
148
148
\[la ] #asides\[ra ] .
149
149
.IP \(bu 4
150
150
Figures and Subfigures
151
- \[la ] #figures-and-subfigures\[ra ] - allows grouping images into subfigures as
151
+ \[la ] #figures-and-subfigures\[ra ] \ - allows grouping images into subfigures as
152
152
well as giving a single image metadata (a link, attributes, etc.). See Images in
153
153
Mmark
154
154
\[la ] /syntax/images\[ra ] for more details.
@@ -168,7 +168,7 @@ In document cross references
168
168
\[la ] #cross-references\[ra ] , short form of referencing a section in the
169
169
document.
170
170
.IP \(bu 4
171
- Super- and Subscript
171
+ Super\ - and Subscript
172
172
\[la ] #super-and-subscript\[ra ]
173
173
.IP \(bu 4
174
174
Callouts
@@ -195,13 +195,13 @@ will only assume inline elements and not parse the includes (which are block lev
195
195
A bibliography is \fI only added \fP if a \fB \f C {backmatter}\fR has been specified, because we need to add just
196
196
before that point.
197
197
.IP \(bu 4
198
- Intra-work emphasis is enabled so a string like \fB \f C SSH_MSG_KEXECDH_REPLY\fR is interpreted as
198
+ Intra\ - work emphasis is enabled so a string like \fB \f C SSH_MSG_KEXECDH_REPLY\fR is interpreted as
199
199
\fB \f C SSH<em>MSG</em>...\fR . You need to escape the underscores: \fB \f C SSH\_ MSG...\fR .
200
200
201
201
202
202
.SS "RFC 7991 XML OUTPUT"
203
203
.PP
204
- This is the output format used for generating Internet-Drafts and RFCs. The generated XML needs to
204
+ This is the output format used for generating Internet\ - Drafts and RFCs. The generated XML needs to
205
205
be processed by another tool (xml2rfc) to generate to official (final) output. The XML from \fI mmark \fP
206
206
can be used directly to upload to the IETF tools website.
207
207
@@ -310,7 +310,7 @@ found.
310
310
.TP
311
311
Images:
312
312
See Images in Mmark
313
- \[la ] /syntax/images\[ra ] for details, \fB \f C ascii-art\fR images from a sub-figure are
313
+ \[la ] /syntax/images\[ra ] for details, \fB \f C ascii-art\fR images from a sub\ - figure are
314
314
included.
315
315
.TP
316
316
References and citations:
@@ -350,51 +350,51 @@ title = "Foo Bar"
350
350
351
351
.SS "ELEMENTS OF THE TITLE BLOCK"
352
352
.PP
353
- An I-D needs to have a Title Block with the following items filled out:
353
+ An I\ - D needs to have a Title Block with the following items filled out:
354
354
355
355
.IP \(bu 4
356
- \fB \f C title\fR - the main title of the document.
356
+ \fB \f C title\fR \ - the main title of the document.
357
357
.IP \(bu 4
358
- \fB \f C abbrev\fR - abbreviation of the title.
358
+ \fB \f C abbrev\fR \ - abbreviation of the title.
359
359
.IP \(bu 4
360
- \fB \f C updates/obsoletes\fR - array of integers.
360
+ \fB \f C updates/obsoletes\fR \ - array of integers.
361
361
.IP \(bu 4
362
362
\fB \f C seriesInfo\fR , containing:
363
363
364
364
.RS
365
365
.IP \(en 4
366
- \fB \f C name\fR - \fB \f C RFC\fR , \fB \f C Internet-Draft\fR , \fB \f C DOI\fR , or \fB \f C FYI\fR .
366
+ \fB \f C name\fR \ - \fB \f C RFC\fR , \fB \f C Internet-Draft\fR , \fB \f C DOI\fR , or \fB \f C FYI\fR .
367
367
.IP \(en 4
368
- \fB \f C value\fR - draft name or RFC number
368
+ \fB \f C value\fR \ - draft name or RFC number
369
369
.IP \(en 4
370
- \fB \f C stream\fR - \fB \f C IETF\fR (default), \fB \f C IAB\fR , \fB \f C IRTF\fR or \fB \f C independent\fR .
370
+ \fB \f C stream\fR \ - \fB \f C IETF\fR (default), \fB \f C IAB\fR , \fB \f C IRTF\fR or \fB \f C independent\fR .
371
371
.IP \(en 4
372
- \fB \f C status\fR - \fB \f C standard\fR , \fB \f C informational\fR , \fB \f C experimental\fR , \fB \f C bcp\fR , \fB \f C historic\fR , or \fB \f C full-standard\fR .
372
+ \fB \f C status\fR \ - \fB \f C standard\fR , \fB \f C informational\fR , \fB \f C experimental\fR , \fB \f C bcp\fR , \fB \f C historic\fR , or \fB \f C full-standard\fR .
373
373
374
374
.RE
375
375
.IP \(bu 4
376
- \fB \f C ipr\fR - usually just set \fB \f C trust200902\fR .
376
+ \fB \f C ipr\fR \ - usually just set \fB \f C trust200902\fR .
377
377
.IP \(bu 4
378
- \fB \f C area\fR - usually just \fB \f C Internet\fR .
378
+ \fB \f C area\fR \ - usually just \fB \f C Internet\fR .
379
379
.IP \(bu 4
380
- \fB \f C workgroup\fR - the workgroup the document is created for.
380
+ \fB \f C workgroup\fR \ - the workgroup the document is created for.
381
381
.IP \(bu 4
382
- \fB \f C keyword\fR - array with keywords (optional).
382
+ \fB \f C keyword\fR \ - array with keywords (optional).
383
383
.IP \(bu 4
384
- \fB \f C author(s)\fR - define all the authors.
384
+ \fB \f C author(s)\fR \ - define all the authors.
385
385
.IP \(bu 4
386
- \fB \f C contact(s)\fR - define all the contacts.
386
+ \fB \f C contact(s)\fR \ - define all the contacts.
387
387
.IP \(bu 4
388
- \fB \f C date\fR - the date for this I-D/RFC.
388
+ \fB \f C date\fR \ - the date for this I\ - D/RFC.
389
389
.IP \(bu 4
390
- \fB \f C language\fR - the language for this document, this uses localized names for \fB \f C Index\fR , \fB \f C Footnotes\fR
390
+ \fB \f C language\fR \ - the language for this document, this uses localized names for \fB \f C Index\fR , \fB \f C Footnotes\fR
391
391
and \fB \f C References\fR , etc. Valid values are from BCP47
392
392
\[la ] https://tools.ietf.org/html/bcp47\[ra ] . This
393
393
defaults to \fB \f C en\fR (English). See the current
394
394
list
395
395
\[la ] https://github.com/mmarkdown/mmark/blob/master/lang/lang.go\[ra ] .
396
396
.IP \(bu 4
397
- \fB \f C indexInclude\fR - set to true when you want to include an index (defaults to true).
397
+ \fB \f C indexInclude\fR \ - set to true when you want to include an index (defaults to true).
398
398
399
399
400
400
.PP
@@ -461,7 +461,7 @@ fullname="R. (Miek) Gieben"
461
461
462
462
.PP
463
463
You can then \fI reference \fP this contact using a \fI citation \fP via the \fB \f C fullname\fR : \fB \f C [@R. (Miek) Gieben]\fR .
464
- This also works when referencing an author of the I-D. Note just like authors, defining contacts
464
+ This also works when referencing an author of the I\ - D. Note just like authors, defining contacts
465
465
needs to happen in the titleblock.
466
466
467
467
.PP
@@ -818,7 +818,7 @@ delimiter can be either \fB\fC.\fR or \fB\fC)\fR. When a parenthesis is used the
818
818
any block level attributes take precedence.
819
819
820
820
.PP
821
- Newlines between list items will create a non-compact list, i.e. compare:
821
+ Newlines between list items will create a non\ - compact list, i.e. compare:
822
822
823
823
.PP
824
824
.RS
@@ -871,42 +871,42 @@ The first seen modifier determines the type (suppressed, normative or informativ
871
871
citation can separated with a semicolon: \fB \f C [@RFC1034;@RFC1035]\fR .
872
872
873
873
.PP
874
- If you reference an RFC, I-D or W3C document the reference will be added automatically (no need to
874
+ If you reference an RFC, I\ - D or W3C document the reference will be added automatically (no need to
875
875
muck about with an \fB \f C <reference>\fR block). This is to say:
876
876
877
877
.PP
878
- Any reference starting with \fI RFC \fP , \fI I-D. \fP or \fI W3C. \fP will be automatically added to the correct
878
+ Any reference starting with \fI RFC \fP , \fI I \ -D. \fP or \fI W3C. \fP will be automatically added to the correct
879
879
reference section.
880
880
881
881
.PP
882
- For I-Ds you may want to add a draft sequence number, which can be done as such: \fB \f C [@?I-D.blah#06]\fR .
883
- If you reference an I-D \fI without \fP a sequence number it will create a reference to the \fI last \fP I-D in
882
+ For I\ - Ds you may want to add a draft sequence number, which can be done as such: \fB \f C [@?I-D.blah#06]\fR .
883
+ If you reference an I\ - D \fI without \fP a sequence number it will create a reference to the \fI last \fP I\ - D in
884
884
citation index.
885
885
886
886
.PP
887
887
A bibliography section is created by default if a \fB \f C {backmatter}\fR is given, but you can suppress it
888
888
by using the command line flag \fB \f C -bibliography=false\fR .
889
889
890
890
.PP
891
- A non-suppressed reference to the \fI full name \fP of an author or contact will insert the referenced
892
- person as a \fB \f C contact\fR . See https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#section-5.4
891
+ A non\ - suppressed reference to the \fI full name \fP of an author or contact will insert the referenced
892
+ person as a \fB \f C contact\fR . See https://www.rfc\ - editor.org/materials/FAQ\ - xml2rfcv3.html#section\ - 5.4
893
893
\[la ] https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#section-5.4\[ra ] .
894
894
895
895
.SS "REFERENCE TEXT SUFFICES"
896
896
.PP
897
897
You can specify extra text after the citation using a comma: \fB \f C [@RFC2535, section 5]\fR , see
898
- https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#name-how-do-i -link-to-multiple-se
898
+ https://www.rfc\ - editor.org/materials/FAQ\ - xml2rfcv3.html#name\ - how\ - do\- i \ - link\ - to\ - multiple\ - se
899
899
\[la ] https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#name-how-do-i-link-to-multiple-se\[ra ] .
900
900
This is used in the following manner:
901
901
902
902
.IP \(bu 4
903
- \fB \f C [@RFC2535, section 5]\fR -> sectionFormat="of"
903
+ \fB \f C [@RFC2535, section 5]\fR \ - > sectionFormat="of"
904
904
.IP \(bu 4
905
- \fB \f C [@RFC2525, see, section 5]\fR -> sectionFormat="comma"
905
+ \fB \f C [@RFC2525, see, section 5]\fR \ - > sectionFormat="comma"
906
906
.IP \(bu 4
907
- \fB \f C [@RFC2525, (see) section 5]\fR -> sectionFormat="parens"
907
+ \fB \f C [@RFC2525, (see) section 5]\fR \ - > sectionFormat="parens"
908
908
.IP \(bu 4
909
- \fB \f C [@RFC2525, 5]\fR -> sectionFormat="bare"
909
+ \fB \f C [@RFC2525, 5]\fR \ - > sectionFormat="bare"
910
910
911
911
912
912
.PP
@@ -949,7 +949,7 @@ citation
949
949
.RE
950
950
951
951
.PP
952
- Note that for citing I-Ds and RFCs you \fI don't \fP need to include any XML, as Mmark will pull these
952
+ Note that for citing I\ - Ds and RFCs you \fI don't \fP need to include any XML, as Mmark will pull these
953
953
automatically from their online location: or technically more correct: the xml2rfc post processor
954
954
will do this.
955
955
@@ -1014,7 +1014,7 @@ And then reference the same \fB\fC(#myid)\fR, the formatter (\fB\fCxml2rfc\fR) w
1014
1014
.PP
1015
1015
Just like
1016
1016
\[la ] #reference-text-suffices\[ra ] , you can add a suffix text to a reference, to influence how
1017
- xml2rfc will render it, see https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#section-3.11
1017
+ xml2rfc will render it, see https://www.rfc\ - editor.org/materials/FAQ\ - xml2rfcv3.html#section\ - 3.11
1018
1018
\[la ] https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#section-3.11\[ra ]
1019
1019
it will allow you to set the format attribute. The following is supported:
1020
1020
@@ -1025,9 +1025,9 @@ title
1025
1025
.IP \(bu 4
1026
1026
default
1027
1027
.IP \(bu 4
1028
- \fB \f C (#myid, use counter)\fR -> format="counter"
1028
+ \fB \f C (#myid, use counter)\fR \ - > format="counter"
1029
1029
.IP \(bu 4
1030
- \fB \f C (#myid, use title)\fR -> format="title"
1030
+ \fB \f C (#myid, use title)\fR \ - > format="title"
1031
1031
1032
1032
1033
1033
.PP
@@ -1038,7 +1038,7 @@ supported for instance.
1038
1038
Also note these strings need to be literary typed as shown here (we may become more lenient in the
1039
1039
future).
1040
1040
1041
- .SS "SUPER- AND SUBSCRIPT"
1041
+ .SS "SUPER\ - AND SUBSCRIPT"
1042
1042
.PP
1043
1043
For superscript use \fB \f C ^\fR and for subscripts use \fB \f C ~\fR . For example:
1044
1044
@@ -1052,7 +1052,7 @@ H~2~O is a liquid. 2^10^ is 1024.
1052
1052
.RE
1053
1053
1054
1054
.PP
1055
- Inside a super- or subscript you must escape spaces. Thus, if you want the letter P with 'a cat' in
1055
+ Inside a super\ - or subscript you must escape spaces. Thus, if you want the letter P with 'a cat' in
1056
1056
subscripts, use \fB \f C P~a\ cat~\fR , not \fB \f C P~a cat~\fR .
1057
1057
1058
1058
.SS "CALLOUTS"
0 commit comments