Skip to content

Commit c762292

Browse files
miekgmiekg
authored
Allow STD and BCP to be easily referenced (#211)
* Allow STD and BCP to be easily referenced Signed-off-by: Miek Gieben <[email protected]> * Make bibliography aware of RFC in std syntax Signed-off-by: Miek Gieben <[email protected]> * Implement the @rfc@RFC syntax Closes: #209 This implements the final bits and adds a testcase. What is not tested is the generation of xi-includes. Signed-off-by: Miek Gieben <[email protected]> --------- Signed-off-by: Miek Gieben <[email protected]>
1 parent f11e061 commit c762292

File tree

7 files changed

+62
-5
lines changed

7 files changed

+62
-5
lines changed

‎Syntax.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -575,11 +575,17 @@ citation to the references, but does not show up in the document as a citation.
575575
The first seen modifier determines the type (suppressed, normative or informative). Multiple
576576
citation can separated with a semicolon: `[@RFC1034;@RFC1035]`.
577577
578-
If you reference an RFC, I-D or W3C document the reference will be added automatically (no need to
579-
muck about with an `<reference>` block). This is to say:
578+
If you reference an RFC, I-D, BCP or STD or W3C document the reference will be added automatically
579+
(no need to muck about with an `<reference>` block). This is to say:
580580
581-
Any reference starting with *RFC*, *I-D.* or *W3C.* will be automatically added to the correct
582-
reference section.
581+
Any reference starting with *RFC*, *BCP*, *STD*, *I-D.* or *W3C.* will be automatically added to the
582+
correct reference section.
583+
584+
Referring to a specific RFC of an STD/BCP can be done using the following syntax:
585+
`[@RFCxxx@STDyy]`, this expands `<xref target="RFCxxx"></xref> of <xref target="STDxx"></xref>`
586+
where both will be added to the automatically generated references. The word "of" will be
587+
translated according to the document language. Note: no attempt is made to validate if the RFC is
588+
actually part of the STD or BCP, i.e. `[@RFCxxx@RFCyyy]` will be happily accepted.
583589
584590
For I-Ds you may want to add a draft sequence number, which can be done as such: `[@?I-D.blah#06]`.
585591
If you reference an I-D *without* a sequence number it will create a reference to the *last* I-D in

‎lang/lang.go

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import (
44
"strings"
55
)
66

7+
// TODO(miek): functions below getting a bit long in the tooth.
8+
79
// New returns a new and initialized Lang.
810
func New(language string) Lang {
911
l := Lang{language: strings.ToLower(language)} // case insensitivity
@@ -13,6 +15,7 @@ func New(language string) Lang {
1315
l.m = map[string]Term{
1416
"en": {
1517
And: "and",
18+
Of: "of",
1619
Authors: "Authors",
1720
Bibliography: "Bibliography",
1821
Footnotes: "Footnotes",
@@ -25,6 +28,7 @@ func New(language string) Lang {
2528
},
2629
"nl": {
2730
And: "en",
31+
Of: "of",
2832
Bibliography: "Bibliografie",
2933
Footnotes: "Voetnoten",
3034
Index: "Index",
@@ -35,6 +39,7 @@ func New(language string) Lang {
3539
},
3640
"de": {
3741
And: "und",
42+
Of: "von",
3843
Bibliography: "Literaturverzeichnis",
3944
Footnotes: "Fußnoten",
4045
Index: "Index",
@@ -71,6 +76,7 @@ type Lang struct {
7176
// Term contains the specific terms for translation.
7277
type Term struct {
7378
And string
79+
Of string
7480
Authors string
7581
Bibliography string
7682
Footnotes string
@@ -124,6 +130,14 @@ func (l Lang) And() string {
124130
return t.And
125131
}
126132

133+
func (l Lang) Of() string {
134+
t, ok := l.m[l.language]
135+
if !ok {
136+
return l.m["en"].Of
137+
}
138+
return t.Of
139+
}
140+
127141
func (l Lang) WrittenBy() string {
128142
t, ok := l.m[l.language]
129143
if !ok {

‎mparser/bibliography.go

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,22 @@ func CitationToBibliography(doc ast.Node) (normative ast.Node, informative ast.N
3939
// author/contact ref -> exclude
4040
continue Destination
4141
}
42-
4342
}
4443
if _, ok := seen[string(bytes.ToLower(d))]; ok {
4544
continue Destination
4645
}
46+
// if the anchor contains another '@' this is a reference to a specific RFC in a STD
47+
// or BCP. If so we need to a 2 bib items.
48+
if n := bytes.Index(d, []byte("@")); n > 0 && len(d[n+1:]) > 2 {
49+
second := d[n+1:]
50+
ref2 := &mast.BibliographyItem{}
51+
ref2.Anchor = second
52+
ref2.Type = c.Type[i]
53+
seen[string(second)] = ref2
54+
55+
d = d[:n]
56+
}
57+
4758
ref := &mast.BibliographyItem{}
4859
ref.Anchor = d
4960
ref.Type = c.Type[i]

‎render/xml/bibliography.go

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,12 @@ func (r *Renderer) bibliographyItem(w io.Writer, node *mast.BibliographyItem) {
6868
case bytes.HasPrefix(node.Anchor, []byte("W3C.")):
6969
tag = makeXiInclude(BibW3C, fmt.Sprintf("reference.W3C.%s.xml", node.Anchor[4:]))
7070

71+
case bytes.HasPrefix(node.Anchor, []byte("BCP")):
72+
tag = makeXiInclude(BibBCP, fmt.Sprintf("reference.BCP.%s.xml", node.Anchor[3:]))
73+
74+
case bytes.HasPrefix(node.Anchor, []byte("STD")):
75+
tag = makeXiInclude(BibSTD, fmt.Sprintf("reference.STD.%s.xml", node.Anchor[3:]))
76+
7177
case bytes.HasPrefix(node.Anchor, []byte("I-D.")):
7278
hash := bytes.Index(node.Anchor, []byte("#"))
7379
draft := ""
@@ -100,4 +106,6 @@ var (
100106
BibRFC = "https://bib.ietf.org/public/rfc/bibxml"
101107
BibID = "https://bib.ietf.org/public/rfc/bibxml3"
102108
BibW3C = "https://bib.ietf.org/public/rfc/bibxml4"
109+
BibBCP = "https://bib.ietf.org/public/rfc/bibxml9"
110+
BibSTD = "https://bib.ietf.org/public/rfc/bibxml9"
103111
)

‎render/xml/renderer.go

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,13 @@ func (r *Renderer) citation(w io.Writer, node *ast.Citation, entering bool) {
263263
c = c[:hash]
264264
}
265265
}
266+
var stdattr []string
267+
// Detect and parse RFC@STD14, make 'c' contain the first dest and then add a second xref that we
268+
// prepare with the (translated) word of 'of' 'RFC xxxx' <xref ...>
269+
if n := bytes.Index(c, []byte("@")); n > 0 && len(c[n+1:]) > 2 {
270+
stdattr = []string{fmt.Sprintf(`target="%s"`, c[n+1:])}
271+
c = c[:n]
272+
}
266273

267274
attr := []string{fmt.Sprintf(`target="%s"`, c)}
268275

@@ -298,6 +305,14 @@ func (r *Renderer) citation(w io.Writer, node *ast.Citation, entering bool) {
298305

299306
r.outTag(w, "<xref", attr)
300307
r.outs(w, "</xref>")
308+
309+
if stdattr != nil {
310+
r.outs(w, " ")
311+
r.outs(w, r.opts.Language.Of())
312+
r.outs(w, " ")
313+
r.outTag(w, "<xref", stdattr)
314+
r.outs(w, "</xref>")
315+
}
301316
}
302317
}
303318

‎testdata/citation-std.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
See [@RFC8948@STD14]

‎testdata/citation-std.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
<t>See <xref target="RFC8948"></xref> of <xref target="STD14"></xref></t>
2+

0 commit comments

Comments
 (0)