Malformed reference anchors

From https://github.com/metanorma/metanorma/issues/75, TC 211

This may be a data source issue, but: Metanorma is quite specific about what goes into the fetch code of a bibliographic reference. If it is not a standard identifier, then a full bibliographic reference needs to be given, following one of the conventions in https://www.metanorma.org/author/topics/sections/bibliography/ . The preferred format is https://www.metanorma.org/author/topics/sections/bibliography/#annotated-spans . But that will end up a separate ticket.

In addition, the fetch code needs to be well-formed; that means no ] (since ] is a delimiter in the bibliographic reference), no parenthetic comments (ISO/IEC TR 14252(Adapted from) is not a bibliographic reference, it is a bibliographic reference plus commentary, and it should have been fixed in the YAML), and no discursive chatter.

Metanorma is finding something objectionable in all of the following:

https://www.metanorma.com/author/topics/document-format/bibliography/ ,
https://www.metanorma.com/author/iso/topics/markup/#bibliographies
: [[[19161-1_2020,19161-1:2020]]]
AsciiDoc Input: (ID _bibliography): no anchor on reference, markup may be malformed: see
https://www.metanorma.com/author/topics/document-format/bibliography/ ,
https://www.metanorma.com/author/iso/topics/markup/#bibliographies
: [[[DCAT[8],DCAT[8]]]]
AsciiDoc Input: (ID _bibliography): no anchor on reference, markup may be malformed: see
https://www.metanorma.com/author/topics/document-format/bibliography/ ,
https://www.metanorma.com/author/iso/topics/markup/#bibliographies
: [[[DWBP[7],DWBP[7]]]]
AsciiDoc Input: (ID _bibliography): no anchor on reference, markup may be malformed: see
https://www.metanorma.com/author/topics/document-format/bibliography/ ,
https://www.metanorma.com/author/iso/topics/markup/#bibliographies
: [[[Derived_from_FindLaw_for_“agent”,Derived from FindLaw for “agent”]]]
AsciiDoc Input: (ID _bibliography): no anchor on reference, markup may be malformed: see
https://www.metanorma.com/author/topics/document-format/bibliography/ ,
https://www.metanorma.com/author/iso/topics/markup/#bibliographies
: [[[Derived_from_Palmer_&amp;_Dodge,Derived from Palmer &amp; Dodge]]]
AsciiDoc Input: (ID _bibliography): no anchor on reference, markup may be malformed: see
https://www.metanorma.com/author/topics/document-format/bibliography/ ,
https://www.metanorma.com/author/iso/topics/markup/#bibliographies
: [[[ISO_19107_2003€,ISO 19107:2003€]]]
AsciiDoc Input: (ID _bibliography): no anchor on reference, markup may be malformed: see
https://www.metanorma.com/author/topics/document-format/bibliography/ ,
https://www.metanorma.com/author/iso/topics/markup/#bibliographies
: [[[,]]]
AsciiDoc Input: (ID _bibliography): no anchor on reference, markup may be malformed: see
https://www.metanorma.com/author/topics/document-format/bibliography/ ,
https://www.metanorma.com/author/iso/topics/markup/#bibliographies
: [[[ISO_IEC_TR_14252(Adapted_from),ISO/IEC TR 14252(Adapted from)]]]
AsciiDoc Input: (ID _bibliography): no anchor on reference, markup may be malformed: see
https://www.metanorma.com/author/topics/document-format/bibliography/ ,
https://www.metanorma.com/author/iso/topics/markup/#bibliographies
: [[[Implementation_Specification_—_a_Draught_Information_System_for_the_St._Lawrence_Seaway,Implementation Specification — a Draught Information System for the St. Lawrence Seaway]]]

Of these:

19161-1:2020 is presumably meant to be ISO 19161-1:2020
DCAT[8] should not be an anchor, [ and ] are illegal characters in XML anchors; this should be DCAT_8_ (and in fact, I strongly suspect the "8" is intended as a bibliographic tag in a numbered bibliography). Metanorma::Utils.to_ncname() https://github.com/metanorma/metanorma-utils/blob/8b21b4640c09b11774db754f926a3a1d236bdd50/lib/utils/xml.rb#L30 is the function Metanorma uses to sanitise identifiers for use as XML anchors.
Derived_from_FindLawfor“agent” is not a bibliographic reference, it is a discursive note, and should be marked up as such
ISO_19107_2003€ is an error, the euro sign does not belong there
Derived_fromPalmer&_Dodge should be Palmer__amp;_Dodge, using Metanorma::Utils.to_ncname(), and the "derived from" note should instead be added to the source, as follows: https://www.metanorma.org/author/topics/sections/concepts/#modifying-sourced-concepts https://www.metanorma.org/author/topics/sections/concepts/#complex-source-attributes

[.source]
<<Palmer__amp;_Dodge>>,

(for just ", modified")

[.source,status=modified]
<<Palmer__amp;_Dodge>>

(will end up the same)

[.source,status=unspecified]
<<Palmer__amp;_Dodge>>

(I don't recommend that, but it allows an underspecified relation. I recommend "modified", and that is what ISO expects to see.)

The same applies to ISO_IEC_TR_14252(Adapted_from): that should be ISO_IEC_TR_14252 , and the source reference modified as:

[.source,status=modified]
<<ISO_IEC_TR_14252>>

(Of course, it would be far preferable if the "modified/adapted" were indicated as status attributes on the source in the YAML.

I don't know what's objectionable in ImplementationSpecification—_a_Draught_Information_System_for_the_St._Lawrence_Seaway; probably the em-dash. Again, use Metanorma::Utils.to_ncname()
I see eight references prefixed with "Adapted from". Same story; "Adapted from Albota 2002" is not a bibliographic reference, "Albota 2002" is, and "Adapted from" is source status information.

This may well be forcing a bunch of QA on the termbase. At the risk of callousness, that's not my problem, that's the data provider's. Bibliographic entries like "Adapted from Albota 2002" are simply malformed, and we should not expect them to provide a coherent bibliographic reference. (After all, the expectation is that it links to "Albota 2002" somehow.)

metanorma / metanorma-plugin-glossarist

Malformed reference anchors #31