Merge pull request #304 from metanorma/fix/doi-citation

DOI optional citation: metanorma/metanorma#328
metanorma · Sep 30, 2023 · 5e1fa9a · 5e1fa9a
2 parents 30e0f7c + 1cc88a4
commit 5e1fa9a
Show file tree

Hide file tree

Showing 15 changed files with 356 additions and 332 deletions.
diff --git a/lib/isodoc/ieee/base_convert.rb b/lib/isodoc/ieee/base_convert.rb
@@ -38,6 +38,11 @@ def note_delim
         "&#x2014;"
       end
 
+      def omit_docid_prefix(prefix)
+        prefix == "DOI" and return true
+        super
+      end
+
       def note_p_parse(node, div)
         name = node&.at(ns("./name"))&.remove
         div.p do |p|

diff --git a/lib/metanorma/ieee/basicdoc.rng b/lib/metanorma/ieee/basicdoc.rng
@@ -346,6 +346,8 @@
           <ref name="keyword"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </oneOrMore>
     </element>
@@ -623,6 +625,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -636,6 +640,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -648,14 +654,20 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
   </define>
   <define name="keyword">
     <element name="keyword">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -676,7 +688,11 @@
   <define name="strike">
     <element name="strike">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>

diff --git a/lib/metanorma/ieee/biblio.rng b/lib/metanorma/ieee/biblio.rng
@@ -1283,7 +1283,7 @@
       <value>mergedInto</value>
       <value>splits</value>
       <value>splitInto</value>
-      <value>instance</value>
+      <value>instanceOf</value>
       <value>hasInstance</value>
       <value>exemplarOf</value>
       <value>hasExemplar</value>

diff --git a/lib/metanorma/ieee/isodoc.rng b/lib/metanorma/ieee/isodoc.rng
@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v1.2.4 -->
+<!-- VERSION v1.2.5 -->
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -485,6 +485,8 @@
           <choice>
             <text/>
             <ref name="callout"/>
+            <ref name="xref"/>
+            <ref name="eref"/>
           </choice>
         </oneOrMore>
         <zeroOrMore>
@@ -865,6 +867,7 @@
             <ref name="PureTextElement"/>
             <ref name="stem"/>
             <ref name="index"/>
+            <ref name="index-xref"/>
             <ref name="eref"/>
             <ref name="erefstack"/>
             <ref name="xref"/>
@@ -880,6 +883,7 @@
             <ref name="PureTextElement"/>
             <ref name="stem"/>
             <ref name="index"/>
+            <ref name="index-xref"/>
             <ref name="eref"/>
             <ref name="erefstack"/>
             <ref name="xref"/>
@@ -894,6 +898,7 @@
           <choice>
             <ref name="PureTextElement"/>
             <ref name="index"/>
+            <ref name="index-xref"/>
             <ref name="eref"/>
             <ref name="erefstack"/>
             <ref name="xref"/>
@@ -908,6 +913,7 @@
           <choice>
             <ref name="PureTextElement"/>
             <ref name="index"/>
+            <ref name="index-xref"/>
           </choice>
         </zeroOrMore>
       </element>
@@ -918,6 +924,7 @@
           <choice>
             <ref name="PureTextElement"/>
             <ref name="index"/>
+            <ref name="index-xref"/>
           </choice>
         </zeroOrMore>
       </element>
@@ -928,6 +935,7 @@
           <choice>
             <ref name="PureTextElement"/>
             <ref name="index"/>
+            <ref name="index-xref"/>
           </choice>
         </zeroOrMore>
       </element>
@@ -938,6 +946,7 @@
           <choice>
             <ref name="PureTextElement"/>
             <ref name="index"/>
+            <ref name="index-xref"/>
           </choice>
         </zeroOrMore>
       </element>
@@ -1047,6 +1056,8 @@
         <ref name="keyword"/>
         <ref name="xref"/>
         <ref name="hyperlink"/>
+        <ref name="index"/>
+        <ref name="index-xref"/>
       </choice>
     </element>
   </define>
@@ -1060,6 +1071,8 @@
         <ref name="keyword"/>
         <ref name="xref"/>
         <ref name="hyperlink"/>
+        <ref name="index"/>
+        <ref name="index-xref"/>
       </choice>
     </element>
   </define>
@@ -1126,6 +1139,8 @@
             <choice>
               <ref name="PureTextElement"/>
               <ref name="stem"/>
+              <ref name="index"/>
+              <ref name="index-xref"/>
             </choice>
           </zeroOrMore>
         </element>
@@ -1136,6 +1151,8 @@
             <choice>
               <ref name="PureTextElement"/>
               <ref name="stem"/>
+              <ref name="index"/>
+              <ref name="index-xref"/>
             </choice>
           </zeroOrMore>
         </element>

diff --git a/lib/relaton/render/config.yml b/lib/relaton/render/config.yml
@@ -9,17 +9,17 @@ extenttemplate:
   misc: "{{ volume }}, {{issue}}, {{ page }}, {{ duration }}"
 template:
   # skip authoritative_identifier, it is inserted in front of formattedref within metanorma
-  standard: "{% if home_standard %}{{ title }}.{% else %}{{ creatornames }}, “{{ title }},” {{ extent }},  {{ labels['version'] }}_{{ edition_raw }}, {{date}}, {{labels['updated'] | capitalize }}_{{date_updated}}, {{status }}, {{ authorizer }}, {{ uri }} .{% endif %}"
-  article: "{{creatornames}}, “{{title}},” <em>{{ series }}</em>, {{ extent }}, {{ date }}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
-  book: "{{creatornames}}, <em>{{title}}</em>, {{ edition }}, {{place}}: {{publisher}}, {{date}}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
+  standard: "{% if home_standard %}{{ title }}.{% else %}{{ creatornames }}, “{{ title }},” {{ extent }},  {{ labels['version'] }}_{{ edition_raw }}, {{date}}, {{labels['updated'] | capitalize }}_{{date_updated}}, {{status }}, {{ authorizer }}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} .{% endif %}"
+  article: "{{creatornames}}, “{{title}},” <em>{{ series }}</em>, {{ extent }}, {{ date }}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
+  book: "{{creatornames}}, <em>{{title}}</em>, {{ edition }}, {{place}}: {{publisher}}, {{date}}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
   techreport: book
   booklet: book
   manual: book
   proceedings: book
-  inproceedings: "{{ creatornames }}, “{{ title }},” <em>{{host_title}}</em>, {{place}}, {{extent}}, {{date}}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
-  inbook: "{{ creatornames }}, “{{ title }},” {{ labels['in'] }} {{ host_creatornames}} ({{ host_role}}) : <em>{{host_title}}</em>, {{place}}: {{publisher}}, {{date}}, {{extent}}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
+  inproceedings: "{{ creatornames }}, “{{ title }},” <em>{{host_title}}</em>, {{place}}, {{extent}}, {{date}}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
+  inbook: "{{ creatornames }}, “{{ title }},” {{ labels['in'] }} {{ host_creatornames}} ({{ host_role}}) : <em>{{host_title}}</em>, {{place}}: {{publisher}}, {{date}}, {{extent}}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
   incollection: inbook
-  thesis: "{{ creatornames }} , “{{ title }}.” {{ medium | capitalize }}, {{ publisher }}, {{ date }}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
+  thesis: "{{ creatornames }} , “{{ title }}.” {{ medium | capitalize }}, {{ publisher }}, {{ date }}, {{ labels['viewed'] }}_{{date_accessed}}, {% if uri %}{{ uri }}{% else %}{% if doi %}DOI: {{ doi | join: ', ' }}{% endif %}{% endif %} ."
   unpublished: thesis
   misc: thesis
   website: thesis

diff --git a/spec/isodoc/refs_spec.rb b/spec/isodoc/refs_spec.rb
@@ -244,9 +244,9 @@
                <biblio-tag>[B1], REF4, </biblio-tag>
              </bibitem>
              <bibitem type="book" id="ref2">
-               <formattedref>Aluffi, P., D. Anderson, M. Hering, M. Mustaţă, and S. Payne, <em>Facets of Algebraic Geometry: A Collection in Honor of William Fulton's 80th Birthday</em>, first edition, Cambridge, UK: Cambridge University Press, 2022a.</formattedref>
+               <formattedref>Aluffi, P., D. Anderson, M. Hering, M. Mustaţă, and S. Payne, <em>Facets of Algebraic Geometry: A Collection in Honor of William Fulton's 80th Birthday</em>, first edition, Cambridge, UK: Cambridge University Press, 2022a, DOI: https://doi.org/10.1017/9781108877831.</formattedref>
                <title>Facets of Algebraic Geometry: A Collection in Honor of William Fulton's 80th Birthday</title>
-               <docidentifier type="DOI">DOI https://doi.org/10.1017/9781108877831</docidentifier>
+               <docidentifier type="DOI">https://doi.org/10.1017/9781108877831</docidentifier>
                <docidentifier type="ISBN">ISBN 9781108877831</docidentifier>
                <biblio-tag/>
              </bibitem>
@@ -272,9 +272,9 @@
                <biblio-tag>[B1]<tab/>REF4, </biblio-tag>
              </bibitem>
              <bibitem type="book" id="ref5">
-               <formattedref>Aluffi, P., D. Anderson, M. Hering, M. Mustaţă, and S. Payne, <em>Facets of Algebraic Geometry: A Collection in Honor of William Fulton's 80th Birthday</em>, first edition, Cambridge, UK: Cambridge University Press, 2022b.</formattedref>
+               <formattedref>Aluffi, P., D. Anderson, M. Hering, M. Mustaţă, and S. Payne, <em>Facets of Algebraic Geometry: A Collection in Honor of William Fulton's 80th Birthday</em>, first edition, Cambridge, UK: Cambridge University Press, 2022b, DOI: https://doi.org/10.1017/9781108877831.</formattedref>
                <title>Facets of Algebraic Geometry: A Collection in Honor of William Fulton's 80th Birthday</title>
-               <docidentifier type="DOI">DOI https://doi.org/10.1017/9781108877831</docidentifier>
+               <docidentifier type="DOI">https://doi.org/10.1017/9781108877831</docidentifier>
                <docidentifier type="ISBN">ISBN 9781108877831</docidentifier>
                <docidentifier type="metanorma-ordinal">[B2]</docidentifier>
                <biblio-tag>[B2]<tab/></biblio-tag>