metanorma-bipm 0.0.4 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f7ed7028b4a5bd6a311aff675bd47272c2170dad7adfcf59457ca3f4a55d218
-  data.tar.gz: 96e9451da240b36fe420324838d69a0d5fde69cb956d74977f83b7ca9c736cae
+  metadata.gz: 70abc01a43829c12c4870dc4072a2a5f919cd2a5a7d306e579b3fa619020f851
+  data.tar.gz: 7ef810393fb2f5d107554fd45195f0297a3421d4deb0d314b6d9820456fbe93d
 SHA512:
-  metadata.gz: 98b7383018c3822867381823ed9d19bc4cd02e5db2fbf97862014bde19079e13f28fc1e0342b3d41986b3a0d249104746a14f475db05fe6a273bb8c860bc8df6
-  data.tar.gz: 531be848c577965373bdbab1408304b06fc292998b89e2fdc3f81948ba93799a4a9f0a4b19897974ea6fb38518738ab6ac9cb33196dee90fd04305ef5825d16b
+  metadata.gz: cd67915975f6dc2107e1868bc62bb6942ba9f1fe4f6dcee81d48334d45b2e02053513d51f3fe792e439f66387208ac33d288713513015761b1e27a5dbae24329
+  data.tar.gz: ede610fd77af7ea69e3073e88fde59c0bd567699fbda50b51bfcb3fad47f4aad00a3bf1e59b4597fa9c2a0485e9ea69c1dcb5b5a7bf430794e78cbd1667a3dab

data/.github/workflows/rake.yml

@@ -36,7 +36,10 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
 
-      - uses: actions/cache@v1
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
+
+      - uses: actions/cache@v2
         with:
           path: vendor/bundle
           key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
@@ -48,16 +51,15 @@ jobs:
 
       - run: bundle exec rake
 
-  notify:
-    name: Trigger notify workflow
+  tests-passed:
     needs: rake
     runs-on: ubuntu-latest
     steps:
-      - name: Trigger notify workflow
+      - name: Trigger tests passed event
         uses: Sibz/github-status-action@v1
         with:
-          authToken: ${{ secrets.GITHUB_TOKEN }}
+          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           context: 'tests-passed-successfully'
           description: 'Tests passed successfully'
           state: 'success'
-          sha: ${{ github.event.pull_request.head.sha || github.sha }}
+          sha: ${{ github.event.pull_request.head.sha || github.sha }}

data/lib/asciidoctor/bipm/basicdoc.rng

@@ -596,6 +596,7 @@
       <ref name="bookmark"/>
       <ref name="image"/>
       <ref name="index"/>
+      <ref name="index-xref"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -728,13 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
       <optional>
-        <attribute name="secondary"/>
+        <attribute name="to">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="index-xref">
+    <element name="index-xref">
+      <attribute name="also">
+        <data type="boolean"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
       <optional>
-        <attribute name="tertiary"/>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
+      <element name="target">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
     </element>
   </define>
   <!-- bare ID element, used for referencing arbitrary spans of text -->

data/lib/asciidoctor/bipm/bipm.rng

@@ -42,6 +42,16 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="nosee">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="nopage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -209,9 +219,9 @@
         <oneOrMore>
           <ref name="committee"/>
         </oneOrMore>
-        <oneOrMore>
+        <zeroOrMore>
           <ref name="workgroup"/>
-        </oneOrMore>
+        </zeroOrMore>
       </element>
     </define>
     <define name="structuredidentifier">
@@ -333,7 +343,9 @@
       <optional>
         <ref name="boilerplate"/>
       </optional>
-      <ref name="preface"/>
+      <optional>
+        <ref name="preface"/>
+      </optional>
       <oneOrMore>
         <ref name="sections"/>
       </oneOrMore>

data/lib/asciidoctor/bipm/boilerplate-en.xml

@@ -1,7 +1,7 @@
 <boilerplate>
   <copyright-statement>
     <clause>
-      <p align="center"> © Bureau International des poids et mesures {{ docyear }} all rights reserved</p>
+      <p align="center"> © Bureau International des Poids et Mesures {{ docyear }} all rights reserved</p>
     </clause>
   </copyright-statement>
   <license-statement>

data/lib/asciidoctor/bipm/boilerplate-fr.xml

@@ -1,7 +1,7 @@
 <boilerplate>
   <copyright-statement>
     <clause>
-      <p align="center"> © Bureau International des poids et mesures {{ docyear }} tous droits réservés</p>
+      <p align="center"> © Bureau international des poids et mesures {{ docyear }} tous droits réservés</p>
     </clause>
   </copyright-statement>
   <license-statement>

data/lib/asciidoctor/bipm/boilerplate-jcgm-en.xml

@@ -0,0 +1,37 @@
+<boilerplate>
+  <copyright-statement>
+    <clause>
+      <p> © JCGM {{ docyear }} </p>
+      <p>Copyright of this JCGM guidance document is shared jointly by the JCGM member organizations (BIPM, IEC, 
+        IFCC, ILAC, ISO, IUPAC, IUPAP and OIML).</p>
+    </clause>
+  </copyright-statement>
+  <license-statement>
+    <clause>
+      <title>Copyright</title>
+      <p>Even if electronic versions are available free of charge on the website of one or more of the JCGM member organizations, economic and moral copyrights related to all JCGM publications are internationally protected. The JCGM does not, without its written authorisation, permit third parties to rewrite or re-brand issues, to sell copies to the public, or to broadcast or use on-line its publications. Equally, the JCGM also objects to distortion, augmentation or mutilation of its publications, including its titles, slogans and logos, and those of its member organizations.</p>
+    </clause>
+    <clause>
+      <title>Official versions and translations</title>
+      <p>The only official versions of documents are those published by the JCGM, in their original languages.</p>
+
+      <p>The JCGM’s publications may be translated into languages other than those in which the documents were originally published by the JCGM. Permission must be obtained from the JCGM before a translation can be made. All translations should respect the original and official format of the formulae and units (without any conversion to other formulae or units), and contain the following statement (to be translated into the chosen language):</p>
+
+      <quote>All JCGM’s products are internationally protected by copyright. This translation of the original JCGM document has been produced with the permission of the JCGM. The JCGM retains full internationally protected copyright on the design and content of this document and on the JCGM’s titles, slogan and logos. The member organizations of the JCGM also retain full internationally protected right on their titles, slogans and logos included in the JCGM’s publications. The only official version is the document published by the JCGM, in the original languages.</quote>
+
+      <p>The JCGM does not accept any liability for the relevance, accuracy, completeness or quality of the information and materials offered in any translation. A copy of the translation shall be provided to the JCGM at the time of publication.</p>
+    </clause>
+    <clause>
+      <title>Reproduction</title>
+      <p>The JCGM’s publications may be reproduced, provided written permission has been granted by the JCGM. A sample of any reproduced document shall be provided to the JCGM at the time of reproduction and contain the following statement:</p>
+      <quote>This document is reproduced with the permission of the JCGM, which retains full internationally protected copyright on the design and content of this document and on the JCGM’s titles, slogans and logos. The member organizations of the JCGM also retain full internationally protected right on their titles, slogans and logos included in the JCGM’s publications. The only official versions are the original versions of the documents published by the JCGM.</quote>
+    </clause>
+  </license-statement>
+  <legal-statement>
+    <clause>
+    <title>Disclaimer</title>
+    <p>The JCGM and its member organizations have published this document to enhance access to information about metrology. They endeavor to update it on a regular basis, but cannot guarantee the accuracy at all times and shall not be responsible for any direct or indirect damage that may result from its use. Any reference to commercial products of any kind (including but not restricted to any software, data or hardware) or links to websites, over which the JCGM and its member organizations have no control and for which they assume no responsibility, does not imply any approval, endorsement or recommendation by the JCGM and its member organizations.</p>
+  </clause>
+  </legal-statement>
+</boilerplate>
+

data/lib/asciidoctor/bipm/converter.rb

@@ -10,6 +10,18 @@ module Asciidoctor
         Metanorma::BIPM.configuration
       end
 
+      def org_name_long
+        configuration.organization_name_long[@lang]
+      end
+
+      def default_publisher
+        org_name_long
+      end
+
+      def org_abbrev
+          { org_name_long => configuration.organization_name_short }
+      end
+
       def metadata_committee(node, xml)
         return unless node.attr("committee-en") || node.attr("committee-fr")
         xml.editorialgroup do |a|
@@ -30,14 +42,10 @@ module Asciidoctor
 
       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"
+        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
           i += 1
         end
@@ -96,13 +104,11 @@ module Asciidoctor
         ["en", "fr"].each do |lang|
           at = { language: lang, format: "text/plain" }
           xml.title **attr_code(at.merge(type: "main")) do |t1|
-            t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(
-              node.attr("title-#{lang}"))
+            t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-#{lang}"))
+          end
+          %w(cover appendix annex part subpart).each do |w|
+            typed_title(node, xml, lang, w)
           end
-          typed_title(node, xml, lang, "cover")
-          typed_title(node, xml, lang, "appendix")
-          typed_title(node, xml, lang, "part")
-          typed_title(node, xml, lang, "subpart")
         end
       end
 
@@ -110,7 +116,7 @@ module Asciidoctor
         at = { language: lang, format: "text/plain" }
         return unless title = node.attr("title-#{type}-#{lang}")
         xml.title **attr_code(at.merge(type: type)) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(title)
+          t1 << Metanorma::Utils::asciidoc_sub(title)
         end
       end
 
@@ -123,11 +129,15 @@ module Asciidoctor
       end
 
       def inline_anchor_xref_attrs(node)
-        if /pagenumber%/.match(node.text)
-          node.text = node.text.sub(/pagenumber%/, "")
-          page = true
+        flags = %w(pagenumber nosee nopage).each_with_object({}) do |w, m|
+          if /#{w}%/.match(node.text)
+            node.text = node.text.sub(/#{w}%/, "")
+            m[w] = true
+          end
         end
-        page ? super.merge(pagenumber: true) : super
+        ret = super
+        flags.keys.each { |k| ret[k.to_sym] = true }
+        ret
       end
 
       def clause_parse(attrs, xml, node)
@@ -162,6 +172,11 @@ module Asciidoctor
         end
       end
 
+      def boilerplate_file(xmldoc)
+        return super unless xmldoc&.at("//bibdata/ext/editorialgroup/committee/@acronym")&.value == "JCGM"
+        baselocation("lib/asciidoctor/bipm/boilerplate-jcgm-en.xml")
+      end
+
       def mathml_mi_italics
         { uppergreek: false, upperroman: false,
           lowergreek: false, lowerroman: true }

data/lib/asciidoctor/bipm/isodoc.rng

@@ -55,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>
@@ -246,6 +253,12 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -764,6 +777,21 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="colgroup">
+    <element name="colgroup">
+      <oneOrMore>
+        <ref name="col"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="col">
+    <element name="col">
+      <attribute name="width"/>
+    </element>
+  </define>
+  <define name="BibItemType" combine="choice">
+    <value>internal</value>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -814,6 +842,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -869,9 +900,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -1041,6 +1074,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1094,6 +1130,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1196,6 +1235,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1524,6 +1566,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1554,6 +1597,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>

data/lib/isodoc/bipm/base_convert.rb

@@ -7,16 +7,64 @@ module IsoDoc
         Metanorma::BIPM.configuration
       end
 
+      def convert1(docxml, filename, dir)
+        @jcgm = docxml&.at(ns("//bibdata/ext/editorialgroup/committee/@acronym"))&.value == "JCGM"
+        super
+      end
+
       def middle(isoxml, out)
-        middle_title(out)
-        middle_admonitions(isoxml, out)
-        clause isoxml, out
-        annex isoxml, out
-        bibliography isoxml, out
+        if @jcgm
+          super
+        else
+          middle_title(isoxml, out)
+          middle_admonitions(isoxml, out)
+          clause isoxml, out
+          annex isoxml, out
+          bibliography isoxml, out
+        end
+      end
+
+      def middle_clause(docxml)
+        if @jcgm
+          super
+        else
+          "//sections/*"
+        end
+      end
+
+      def render_identifier(id)
+        ret = super
+        ret[1] = nil if !id[1].nil? && id[1]["type"] == "BIPM"
+        ret[2] = nil if !id[2].nil? && id[2]["type"] == "BIPM"
+        ret
+      end
+
+      def nonstd_bibitem(list, b, ordinal, biblio)
+        list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
+          ids = bibitem_ref_code(b)
+          identifiers = render_identifier(ids)
+          if biblio then ref_entry_code(ref, ordinal, identifiers, ids)
+          else
+            ref << "#{identifiers[0] || identifiers[1]}"
+            ref << " #{identifiers[1]}" if identifiers[0] && identifiers[1]
+          end
+          ref << " " unless biblio && !identifiers[1]
+          reference_format(b, ref)
+        end
       end
 
-      def middle_clause
-        "//sections/*"
+      def std_bibitem_entry(list, b, ordinal, biblio)
+        list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
+          identifiers = render_identifier(bibitem_ref_code(b))
+          if biblio then ref_entry_code(ref, ordinal, identifiers, nil)
+          else
+            ref << "#{identifiers[0] || identifiers[1]}"
+            ref << " #{identifiers[1]}" if identifiers[0] && identifiers[1]
+          end
+          date_note_process(b, ref)
+          ref << " " unless biblio && !identifiers[1]
+          reference_format(b, ref)
+        end
       end
     end
   end