Skip to content

Commit edffaef

Browse files
committed
merge and regen
Signed-off-by: Miek Gieben <[email protected]>
1 parent b2ef861 commit edffaef

File tree

3 files changed

+46
-46
lines changed

3 files changed

+46
-46
lines changed

mmark-syntax-images.7

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,6 @@ using the \fB\fCascii-art\fR version. This is true for all included imagery; onl
6464
included in the output.
6565

6666
.PP
67-
By some happy co-incidence a browser will not show the \fB\fCascii-art\fR version of the image when
67+
By some happy co\-incidence a browser will not show the \fB\fCascii-art\fR version of the image when
6868
generating HTML. It remains to be seen if we need some code to actually filter these out.
6969

mmark-syntax.7

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Callouts
2424

2525
.RS
2626
.IP \(en 4
27-
\fIalways\fP rendered and require double greater/less-than signs, \fB\fC<<1>>\fR.
27+
\fIalways\fP rendered and require double greater/less\-than signs, \fB\fC<<1>>\fR.
2828
.IP \(en 4
2929
\fIalways\fP require a comment in the code, i.e. \fB\fC//<<1>>\fR will be rendered as a callout, a plain
3030
\fB\fC<<1>>\fR will not.
@@ -51,7 +51,7 @@ maintain.
5151
.PP
5252
Because of the abstract syntax tree it will also be easier to write helper tools, like, for instance
5353
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
5555
could be build into the \fB\fCmmark\fR binary itself. See some fun
5656
ideas
5757
\[la]https://github.com/mmarkdown/filter\[ra] here.
@@ -102,7 +102,7 @@ extensions
102102
.IP \(bu 4
103103
\fISmartypants\fP, expand \fB\fC--\fR and \fB\fC---\fR into ndash and mdashes.
104104
.IP \(bu 4
105-
\fISuperSubscript\fP, parse super- and subscript: H\d2\uO is water and 2\u10\d is 1024.
105+
\fISuperSubscript\fP, parse super\- and subscript: H\d2\uO is water and 2\u10\d is 1024.
106106
.IP \(bu 4
107107
\fITables\fP, parse tables.
108108
.IP \(bu 4
@@ -148,7 +148,7 @@ Asides
148148
\[la]#asides\[ra].
149149
.IP \(bu 4
150150
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
152152
well as giving a single image metadata (a link, attributes, etc.). See Images in
153153
Mmark
154154
\[la]/syntax/images\[ra] for more details.
@@ -168,7 +168,7 @@ In document cross references
168168
\[la]#cross-references\[ra], short form of referencing a section in the
169169
document.
170170
.IP \(bu 4
171-
Super- and Subscript
171+
Super\- and Subscript
172172
\[la]#super-and-subscript\[ra]
173173
.IP \(bu 4
174174
Callouts
@@ -195,13 +195,13 @@ will only assume inline elements and not parse the includes (which are block lev
195195
A bibliography is \fIonly added\fP if a \fB\fC{backmatter}\fR has been specified, because we need to add just
196196
before that point.
197197
.IP \(bu 4
198-
Intra-work emphasis is enabled so a string like \fB\fCSSH_MSG_KEXECDH_REPLY\fR is interpreted as
198+
Intra\-work emphasis is enabled so a string like \fB\fCSSH_MSG_KEXECDH_REPLY\fR is interpreted as
199199
\fB\fCSSH<em>MSG</em>...\fR. You need to escape the underscores: \fB\fCSSH\_MSG...\fR.
200200

201201

202202
.SS "RFC 7991 XML OUTPUT"
203203
.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
205205
be processed by another tool (xml2rfc) to generate to official (final) output. The XML from \fImmark\fP
206206
can be used directly to upload to the IETF tools website.
207207

@@ -310,7 +310,7 @@ found.
310310
.TP
311311
Images:
312312
See Images in Mmark
313-
\[la]/syntax/images\[ra] for details, \fB\fCascii-art\fR images from a sub-figure are
313+
\[la]/syntax/images\[ra] for details, \fB\fCascii-art\fR images from a sub\-figure are
314314
included.
315315
.TP
316316
References and citations:
@@ -350,51 +350,51 @@ title = "Foo Bar"
350350

351351
.SS "ELEMENTS OF THE TITLE BLOCK"
352352
.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:
354354

355355
.IP \(bu 4
356-
\fB\fCtitle\fR - the main title of the document.
356+
\fB\fCtitle\fR \- the main title of the document.
357357
.IP \(bu 4
358-
\fB\fCabbrev\fR - abbreviation of the title.
358+
\fB\fCabbrev\fR \- abbreviation of the title.
359359
.IP \(bu 4
360-
\fB\fCupdates/obsoletes\fR - array of integers.
360+
\fB\fCupdates/obsoletes\fR \- array of integers.
361361
.IP \(bu 4
362362
\fB\fCseriesInfo\fR, containing:
363363

364364
.RS
365365
.IP \(en 4
366-
\fB\fCname\fR - \fB\fCRFC\fR, \fB\fCInternet-Draft\fR, \fB\fCDOI\fR, or \fB\fCFYI\fR.
366+
\fB\fCname\fR \- \fB\fCRFC\fR, \fB\fCInternet-Draft\fR, \fB\fCDOI\fR, or \fB\fCFYI\fR.
367367
.IP \(en 4
368-
\fB\fCvalue\fR - draft name or RFC number
368+
\fB\fCvalue\fR \- draft name or RFC number
369369
.IP \(en 4
370-
\fB\fCstream\fR - \fB\fCIETF\fR (default), \fB\fCIAB\fR, \fB\fCIRTF\fR or \fB\fCindependent\fR.
370+
\fB\fCstream\fR \- \fB\fCIETF\fR (default), \fB\fCIAB\fR, \fB\fCIRTF\fR or \fB\fCindependent\fR.
371371
.IP \(en 4
372-
\fB\fCstatus\fR - \fB\fCstandard\fR, \fB\fCinformational\fR, \fB\fCexperimental\fR, \fB\fCbcp\fR, \fB\fChistoric\fR, or \fB\fCfull-standard\fR.
372+
\fB\fCstatus\fR \- \fB\fCstandard\fR, \fB\fCinformational\fR, \fB\fCexperimental\fR, \fB\fCbcp\fR, \fB\fChistoric\fR, or \fB\fCfull-standard\fR.
373373

374374
.RE
375375
.IP \(bu 4
376-
\fB\fCipr\fR - usually just set \fB\fCtrust200902\fR.
376+
\fB\fCipr\fR \- usually just set \fB\fCtrust200902\fR.
377377
.IP \(bu 4
378-
\fB\fCarea\fR - usually just \fB\fCInternet\fR.
378+
\fB\fCarea\fR \- usually just \fB\fCInternet\fR.
379379
.IP \(bu 4
380-
\fB\fCworkgroup\fR - the workgroup the document is created for.
380+
\fB\fCworkgroup\fR \- the workgroup the document is created for.
381381
.IP \(bu 4
382-
\fB\fCkeyword\fR - array with keywords (optional).
382+
\fB\fCkeyword\fR \- array with keywords (optional).
383383
.IP \(bu 4
384-
\fB\fCauthor(s)\fR - define all the authors.
384+
\fB\fCauthor(s)\fR \- define all the authors.
385385
.IP \(bu 4
386-
\fB\fCcontact(s)\fR - define all the contacts.
386+
\fB\fCcontact(s)\fR \- define all the contacts.
387387
.IP \(bu 4
388-
\fB\fCdate\fR - the date for this I-D/RFC.
388+
\fB\fCdate\fR \- the date for this I\-D/RFC.
389389
.IP \(bu 4
390-
\fB\fClanguage\fR - the language for this document, this uses localized names for \fB\fCIndex\fR, \fB\fCFootnotes\fR
390+
\fB\fClanguage\fR \- the language for this document, this uses localized names for \fB\fCIndex\fR, \fB\fCFootnotes\fR
391391
and \fB\fCReferences\fR, etc. Valid values are from BCP47
392392
\[la]https://tools.ietf.org/html/bcp47\[ra]. This
393393
defaults to \fB\fCen\fR (English). See the current
394394
list
395395
\[la]https://github.com/mmarkdown/mmark/blob/master/lang/lang.go\[ra].
396396
.IP \(bu 4
397-
\fB\fCindexInclude\fR - set to true when you want to include an index (defaults to true).
397+
\fB\fCindexInclude\fR \- set to true when you want to include an index (defaults to true).
398398

399399

400400
.PP
@@ -461,7 +461,7 @@ fullname="R. (Miek) Gieben"
461461

462462
.PP
463463
You can then \fIreference\fP this contact using a \fIcitation\fP via the \fB\fCfullname\fR: \fB\fC[@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
465465
needs to happen in the titleblock.
466466

467467
.PP
@@ -818,7 +818,7 @@ delimiter can be either \fB\fC.\fR or \fB\fC)\fR. When a parenthesis is used the
818818
any block level attributes take precedence.
819819

820820
.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:
822822

823823
.PP
824824
.RS
@@ -871,42 +871,42 @@ The first seen modifier determines the type (suppressed, normative or informativ
871871
citation can separated with a semicolon: \fB\fC[@RFC1034;@RFC1035]\fR.
872872

873873
.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
875875
muck about with an \fB\fC<reference>\fR block). This is to say:
876876

877877
.PP
878-
Any reference starting with \fIRFC\fP, \fII-D.\fP or \fIW3C.\fP will be automatically added to the correct
878+
Any reference starting with \fIRFC\fP, \fII\-D.\fP or \fIW3C.\fP will be automatically added to the correct
879879
reference section.
880880

881881
.PP
882-
For I-Ds you may want to add a draft sequence number, which can be done as such: \fB\fC[@?I-D.blah#06]\fR.
883-
If you reference an I-D \fIwithout\fP a sequence number it will create a reference to the \fIlast\fP I-D in
882+
For I\-Ds you may want to add a draft sequence number, which can be done as such: \fB\fC[@?I-D.blah#06]\fR.
883+
If you reference an I\-D \fIwithout\fP a sequence number it will create a reference to the \fIlast\fP I\-D in
884884
citation index.
885885

886886
.PP
887887
A bibliography section is created by default if a \fB\fC{backmatter}\fR is given, but you can suppress it
888888
by using the command line flag \fB\fC-bibliography=false\fR.
889889

890890
.PP
891-
A non-suppressed reference to the \fIfull name\fP of an author or contact will insert the referenced
892-
person as a \fB\fCcontact\fR. See https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#section-5.4
891+
A non\-suppressed reference to the \fIfull name\fP of an author or contact will insert the referenced
892+
person as a \fB\fCcontact\fR. See https://www.rfc\-editor.org/materials/FAQ\-xml2rfcv3.html#section\-5.4
893893
\[la]https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#section-5.4\[ra].
894894

895895
.SS "REFERENCE TEXT SUFFICES"
896896
.PP
897897
You can specify extra text after the citation using a comma: \fB\fC[@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
899899
\[la]https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#name-how-do-i-link-to-multiple-se\[ra].
900900
This is used in the following manner:
901901

902902
.IP \(bu 4
903-
\fB\fC[@RFC2535, section 5]\fR -> sectionFormat="of"
903+
\fB\fC[@RFC2535, section 5]\fR \-> sectionFormat="of"
904904
.IP \(bu 4
905-
\fB\fC[@RFC2525, see, section 5]\fR -> sectionFormat="comma"
905+
\fB\fC[@RFC2525, see, section 5]\fR \-> sectionFormat="comma"
906906
.IP \(bu 4
907-
\fB\fC[@RFC2525, (see) section 5]\fR -> sectionFormat="parens"
907+
\fB\fC[@RFC2525, (see) section 5]\fR \-> sectionFormat="parens"
908908
.IP \(bu 4
909-
\fB\fC[@RFC2525, 5]\fR -> sectionFormat="bare"
909+
\fB\fC[@RFC2525, 5]\fR \-> sectionFormat="bare"
910910

911911

912912
.PP
@@ -949,7 +949,7 @@ citation
949949
.RE
950950

951951
.PP
952-
Note that for citing I-Ds and RFCs you \fIdon't\fP need to include any XML, as Mmark will pull these
952+
Note that for citing I\-Ds and RFCs you \fIdon't\fP need to include any XML, as Mmark will pull these
953953
automatically from their online location: or technically more correct: the xml2rfc post processor
954954
will do this.
955955

@@ -1014,7 +1014,7 @@ And then reference the same \fB\fC(#myid)\fR, the formatter (\fB\fCxml2rfc\fR) w
10141014
.PP
10151015
Just like
10161016
\[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
10181018
\[la]https://www.rfc-editor.org/materials/FAQ-xml2rfcv3.html#section-3.11\[ra]
10191019
it will allow you to set the format attribute. The following is supported:
10201020

@@ -1025,9 +1025,9 @@ title
10251025
.IP \(bu 4
10261026
default
10271027
.IP \(bu 4
1028-
\fB\fC(#myid, use counter)\fR -> format="counter"
1028+
\fB\fC(#myid, use counter)\fR \-> format="counter"
10291029
.IP \(bu 4
1030-
\fB\fC(#myid, use title)\fR -> format="title"
1030+
\fB\fC(#myid, use title)\fR \-> format="title"
10311031

10321032

10331033
.PP
@@ -1038,7 +1038,7 @@ supported for instance.
10381038
Also note these strings need to be literary typed as shown here (we may become more lenient in the
10391039
future).
10401040

1041-
.SS "SUPER- AND SUBSCRIPT"
1041+
.SS "SUPER\- AND SUBSCRIPT"
10421042
.PP
10431043
For superscript use \fB\fC^\fR and for subscripts use \fB\fC~\fR. For example:
10441044

@@ -1052,7 +1052,7 @@ H~2~O is a liquid. 2^10^ is 1024.
10521052
.RE
10531053

10541054
.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
10561056
subscripts, use \fB\fCP~a\ cat~\fR, not \fB\fCP~a cat~\fR.
10571057

10581058
.SS "CALLOUTS"

mmark.1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
.SH "NAME"
55
.PP
6-
mmark \\- generate XML, HTML or manual pages from mmark markdown documents.
6+
mmark \- generate XML, HTML or manual pages from mmark markdown documents.
77

88
.SH "SYNOPSIS"
99
.PP

0 commit comments

Comments
 (0)