metanorma-bipm 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 198062ce879f6837f948e113c1985c8bbdcc2aa1e753ce633bcca8c2eb580b00
-  data.tar.gz: 771c26b923ee4adf5ddd09b77c469910b382a215bb0d0938f1616bd0d6f3e979
+  metadata.gz: 0d8436644152700b4a7927bd706cefb128e019ea7592721852bb227df1f3e304
+  data.tar.gz: 72bb82f202b91f9f31ea74718b972b315c1f69d02f66b03f7d52424d6955e274
 SHA512:
-  metadata.gz: 75194ca626816201d59884e40fcead12afaa115f1935a8a4722c18591c4a7ae91565c7166b7cab75fa10e948f740e11acbea53845055a9cc64bff9cbb92750cf
-  data.tar.gz: 0531d6c46349852dfc6253563d6dc1ce14a4fe771626bc375b130962a9d162071216f1cd112197b19a7daaae24d8f259387abf055fec6cf9acd3633ccfbe6893
+  metadata.gz: 2e3c3175ef01047372bbcd0f22807d5ac04cb61a87d51c4fc05faf12af40a066c3e8d1ee5a34d31b77f7c66cc2f82f556b214bc365c3e45f49f187726d269332
+  data.tar.gz: 032ceebe7c4688f8c617998b8b3aa2a047be8fb0c8b20914a3d4927d6cfafaa6a26bc1c9cb6ec191233b978721cc3152b2312d8a17daaf29ebc3c2ddb2d75060

data/.github/workflows/rake.yml

@@ -0,0 +1,44 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '2.7'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+
+      - name: Use Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Update gems
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Run specs
+        run: bundle exec rake

data/README.adoc

@@ -86,10 +86,17 @@ metadata about the document. These include:
 the document was issued
 
 `:supersedes:`:: One or more BIPM document that this BIPM document standard supersedes; the superseded
-document may still remain in effect. Comma delimited.
+document may still remain in effect. Identified with document identifier. Comma delimited.
 
 `:superseded-by:`:: One or more BIPM document that this BIPM document standard is superseded by; this
-document may still remain in effect. Comma delimited.
+document may still remain in effect. Identified with document identifier. Comma delimited.
+
+`:supersedes-date_{i}:`:: Date of the document draft or version which this document supersedes. 
+Assumes superseded document does not have distinct identifier.
+`:supersedes-draft_{i}:`:: Draft of the document which this document supersedes.
+Assumes superseded document does not have distinct identifier.
+`:supersedes-edition{i}:``:: Version of the document which this document supersedes.
+Assumes superseded document does not have distinct identifier.
 
 `:doctype:`:: The document type (mandatory). The permitted types are:
 +
@@ -110,29 +117,32 @@ document may still remain in effect. Comma delimited.
 `:status:``:: The document status. The permitted types are: `draft-proposal`,
 `draft-development`, `in-force`, `retired`.
 
-`:committee:`:: The name of the relevant committee (mandatory):
+`:committee-en:`:: The name of the relevant committee in English (mandatory)
+`:committee-fr:`:: The name of the relevant committee in French (mandatory)
+`:committee-acronym:`:: The acronym of the relevant committee (mandatory)
 +
 --
-* CGPM: General Conference on Weights and Measures
-* CIPM: International Committee for Weights and Measures
-* BIPM: International Bureau of Weights and Measures
-* CCAUV: Consultative Committee for Acoustics, Ultrasound and Vibration
-* CCEM: Consultative Committee for Electricity and Magnetism
-* CCL: Consultative Committee for Length
-* CCM: Consultative Committee for Mass and Related Quantities
-* CCPR: Consultative Committee for Photometry and Radiometry
-* CCQM: Consultative Committee for Amount of Substance:: Metrology in Chemistry and Biology
-* CCRI: Consultative Committee for Ionizing Radiation
-* CCT: Consultative Committee for Thermometry
-* CCTF: Consultative Committee for Time and Frequency
-* CCU: Consultative Committee for Units
+* CGPM: General Conference on Weights and Measures / Conférence générale des poids et mesures
+* CIPM: International Committee for Weights and Measures / Comité international des poids et mesures
+* BIPM: International Bureau of Weights and Measures / Bureau International des Poids et Mesures
+* CCAUV: Consultative Committee for Acoustics, Ultrasound and Vibration / Comité consultatif de l'acoustique, des ultrasons et des vibrations
+* CCEM: Consultative Committee for Electricity and Magnetism / Comité consultatif d'électricité et magnétisme
+* CCL: Consultative Committee for Length / Comité consultatif des longueurs
+* CCM: Consultative Committee for Mass and Related Quantities / Comité consultatif pour la masse et les grandeurs apparentées
+* CCPR: Consultative Committee for Photometry and Radiometry / Comité consultatif de photométrie et radiométrie
+* CCQM: Consultative Committee for Amount of Substance: Metrology in Chemistry and Biology / Comité consultatif pour la quantité de matière : métrologie en chimie et biologie
+* CCRI: Consultative Committee for Ionizing Radiation / Comité consultatif des rayonnements ionisants
+* CCT: Consultative Committee for Thermometry / Comité consultatif de thermométrie
+* CCTF: Consultative Committee for Time and Frequency / Comité consultatif du temps et des fréquences
+* CCU: Consultative Committee for Units / Comité consultatif des unités
 * CCL-CCTF: Frequency Standards Working Group
-* JCGM: Joint Committee for Guides in Metrology
-* JCRB: Joint Committee of the Regional Metrology Organizations and the BIPM
-* JCTLM: Joint Committee for Traceability in Laboratory Medicine
-* INetQI: International Network on Quality Infrastructure
+* JCGM: Joint Committee for Guides in Metrology / Comité commun pour les guides en métrologie
+* JCRB: Joint Committee of the Regional Metrology Organizations and the BIPM / Comité mixte des organisations régionales de métrologie et du BIPM
+* JCTLM: Joint Committee for Traceability in Laboratory Medicine / Comité commun pour la traçabilité en médecine de laboratoire
+* INetQI: International Network on Quality Infrastructure 
 --
 `:workgroup:`:: The name of the relevant workgroup (mandatory)
+`:workgroup-acronym:`:: The acronym of the relevant workgroup (mandatory)
 
 `:language:` :: The language of the document (`en` or `fr`)  (mandatory)
 
@@ -142,6 +152,16 @@ document may still remain in effect. Comma delimited.
 `:obsoleted-date:`:: The date a document was superseded
 `:implemented-date:`:: The date a document became effective
 
+`:meeting-note:`:: Note on when and where a guide was adopted.
+
+`:role_{i}:`:: If provided and is other than "author" or "editor" (e.g. "WG-N co-chair"),
+is treated as a subclass of "editor".
+
+`:supersedes-date_{i}:`:: Date of the document draft or version which this document supersedes.
+`:supersedes-draft_{i}:`:: Draft of the document which this document supersedes.
+`:supersedes-version_{i}:``:: Version of the document which this document supersedes.
+
+
 The attribute `:draft:`, if present, includes review notes in the XML output;
 these are otherwise suppressed.
 
@@ -150,6 +170,10 @@ these are otherwise suppressed.
 Cross-references formatted as `<<{{anchor}},pagenumber%>>` are rendered in PDF as just the page number;
 they are used for tables of content. In HTML output, they are treated as normal cross-references.
 
+Clauses and annexes may be marked as `[%unnumbered]`, in which case they do not receive section numbering, and are cross-referenced by their title.
+
+Unlike the Metanorma default, ordered lists do not have a fixed sequence of numbering styles: the type set for each ordered list (including nested lists) is respected. The default numbering style for ordered lists is always arabic.
+
 == Data Models
 
 The document model for BIPM is given in https://github.com/metanorma/metanorma-model-bipm[metanorma-model-bipm].

data/lib/asciidoctor/bipm/bipm.rng

@@ -45,6 +45,150 @@
         <text/>
       </element>
     </define>
+    <define name="Clause-Section">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="inline-header">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="obligation">
+          <choice>
+            <value>normative</value>
+            <value>informative</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <ref name="section-title"/>
+      </optional>
+      <group>
+        <choice>
+          <group>
+            <zeroOrMore>
+              <ref name="BasicBlock"/>
+            </zeroOrMore>
+            <zeroOrMore>
+              <ref name="note"/>
+            </zeroOrMore>
+          </group>
+          <ref name="amend"/>
+        </choice>
+        <zeroOrMore>
+          <choice>
+            <ref name="clause-subsection"/>
+            <ref name="terms"/>
+            <ref name="definitions"/>
+          </choice>
+        </zeroOrMore>
+      </group>
+    </define>
+    <define name="Annex-Section">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="inline-header">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="obligation">
+          <choice>
+            <value>normative</value>
+            <value>informative</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <ref name="section-title"/>
+      </optional>
+      <group>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <zeroOrMore>
+          <choice>
+            <ref name="annex-subsection"/>
+            <ref name="terms"/>
+            <ref name="definitions"/>
+            <ref name="references"/>
+          </choice>
+        </zeroOrMore>
+      </group>
+    </define>
+    <define name="ol">
+      <element name="ol">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <attribute name="type">
+          <choice>
+            <value>roman</value>
+            <value>alphabet</value>
+            <value>arabic</value>
+            <value>roman_upper</value>
+            <value>alphabet_upper</value>
+          </choice>
+        </attribute>
+        <optional>
+          <attribute name="start"/>
+        </optional>
+        <oneOrMore>
+          <ref name="li"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="DocumentType">
       <choice>
         <value>brochure</value>
@@ -98,6 +242,9 @@
       <optional>
         <ref name="si-aspect"/>
       </optional>
+      <optional>
+        <ref name="meeting-note"/>
+      </optional>
       <ref name="structuredidentifier"/>
     </define>
   </include>
@@ -132,30 +279,41 @@
   </define>
   <define name="committee">
     <element name="committee">
-      <choice>
-        <value>CGPM</value>
-        <value>CIPM</value>
-        <value>BIPM</value>
-        <value>CCAUV</value>
-        <value>CCEM</value>
-        <value>CCL</value>
-        <value>CCM</value>
-        <value>CCPR</value>
-        <value>CCQM</value>
-        <value>CCRI</value>
-        <value>CCT</value>
-        <value>CCTF</value>
-        <value>CCU</value>
-        <value>CCL-CCTF</value>
-        <value>JCGM</value>
-        <value>JCRB</value>
-        <value>JCTLM</value>
-        <value>INetQI</value>
-      </choice>
+      <attribute name="acronym">
+        <choice>
+          <value>CGPM</value>
+          <value>CIPM</value>
+          <value>BIPM</value>
+          <value>CCAUV</value>
+          <value>CCEM</value>
+          <value>CCL</value>
+          <value>CCM</value>
+          <value>CCPR</value>
+          <value>CCQM</value>
+          <value>CCRI</value>
+          <value>CCT</value>
+          <value>CCTF</value>
+          <value>CCU</value>
+          <value>CCL-CCTF</value>
+          <value>JCGM</value>
+          <value>JCRB</value>
+          <value>JCTLM</value>
+          <value>INetQI</value>
+        </choice>
+      </attribute>
+      <ref name="LocalizedString"/>
     </element>
   </define>
   <define name="workgroup">
     <element name="workgroup">
+      <optional>
+        <attribute name="acronym"/>
+      </optional>
+      <text/>
+    </element>
+  </define>
+  <define name="meeting-note">
+    <element name="meeting-note">
       <text/>
     </element>
   </define>

data/lib/asciidoctor/bipm/converter.rb

@@ -3,9 +3,6 @@ require 'asciidoctor/generic/converter'
 
 module Asciidoctor
   module BIPM
-    # A {Converter} implementation that generates RSD output, and a document
-    # schema encapsulation of the document for validation
-    #
     class Converter < Asciidoctor::Generic::Converter
       register_for "bipm"
 
@@ -14,23 +11,85 @@ module Asciidoctor
       end
 
       def metadata_committee(node, xml)
-        return unless node.attr("committee")
+        return unless node.attr("committee-en") || node.attr("committee-fr")
         xml.editorialgroup do |a|
-          a.committee node.attr("committee")
-          i = 2
-          while node.attr("committee_#{i}") do
-            a.committee node.attr("committee_#{i}")
-            i += 1
+          metadata_committee1(node, a)
+          metadata_committee2(node, a)
+          metadata_workgroup(node, a)
+        end
+      end
+
+      def metadata_committee1(node, a)
+        a.committee **attr_code(acronym: node.attr("committee-acronym")) do |c|
+          e = node.attr("committee-en") and
+            c.variant e, language: "en", script: "Latn"
+          e = node.attr("committee-fr") and
+            c.variant e, language: "fr", script: "Latn"
+        end
+      end
+
+      def metadata_committee2(node, a)
+        i = 2
+        while node.attr("committee-en_#{i}") || node.attr("committee-fr_#{i}")  do
+          a.committee **attr_code(acronym: node.attr("committee-acronym_#{i}")) do |c|
+            e = node.attr("committee-en_#{i}") and
+              c.variant e, language: "en", script: "Latn"
+            e = node.attr("committee-fr_#{i}") and
+              c.variant e, language: "fr", script: "Latn"
           end
-          a.workgroup node.attr("workgroup")
-          i = 2
-          while node.attr("workgroup_#{i}") do
-            a.workgroup node.attr("workgroup_#{i}")
-            i += 1
+          i += 1
+        end
+      end
+
+      def metadata_workgroup(node, a)
+        a.workgroup node.attr("workgroup"),
+          **attr_code(acronym: node.attr("workgroup-acronym"))
+        i = 2
+        while node.attr("workgroup_#{i}") do
+          a.workgroup node.attr("workgroup_#{i}"),
+            **attr_code(acronym: node.attr("workgroup-acronym_#{i}"))
+          i += 1
+        end
+      end
+
+      def metadata_relations(node, xml)
+        super
+        relation_supersedes_self(node, xml, "")
+        i = 2
+        while relation_supersedes_self(node, xml, "_#{i}")
+          i += 1
+        end
+      end
+
+      def relation_supersedes_self(node, xml, suffix)
+        d = node.attr("supersedes-date#{suffix}")
+        draft = node.attr("supersedes-draft#{suffix}")
+        edition = node.attr("supersedes-edition#{suffix}")
+        return false unless d || draft || edition
+        relation_supersedes_self1(xml, d, edition, draft)
+      end
+
+      def relation_supersedes_self1(xml, d, edition, draft)
+        xml.relation **{ type: "supersedes" } do |r|
+          r.bibitem do |b|
+            d and b.date d, **{ type: edition ? "published" : "circulated" }
+            edition and b.edition edition
+            draft and b.version do |v|
+              v.draft draft
+            end
           end
         end
       end
 
+      def personal_role(node, c, suffix)
+        role = node.attr("role#{suffix}") || "author"
+        unless %w(author editor).include?(role.downcase)
+          desc = role
+          role = "editor"
+        end
+        c.role desc, **{ type: role.downcase }
+      end
+
       def title(node, xml)
         ["en", "fr"].each do |lang|
           at = { language: lang, format: "text/plain" }
@@ -67,6 +126,20 @@ module Asciidoctor
         page ? super.merge(pagenumber: true) : super
       end
 
+      def clause_parse(attrs, xml, node)
+        node.option?("unnumbered") and attrs[:unnumbered] = true
+        super
+      end
+
+      def annex_parse(attrs, xml, node)
+        node.option?("unnumbered") and attrs[:unnumbered] = true
+        super
+      end
+
+      def ol_attrs(node)
+        super.merge(start: node.attr("start"))
+      end
+
       def outputs(node, ret)
         File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
         presentation_xml_converter(node).convert(@filename + ".xml")