metanorma-bipm 0.0.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 198062ce879f6837f948e113c1985c8bbdcc2aa1e753ce633bcca8c2eb580b00
-  data.tar.gz: 771c26b923ee4adf5ddd09b77c469910b382a215bb0d0938f1616bd0d6f3e979
+  metadata.gz: 3acf341b606e1c45ba970fa51074d7ff9cb2cfb424a0a4439821af1b5f76f6bf
+  data.tar.gz: 15d7d12f963aee720825f1a4481670efde7430dd02aaca56cebecdb1d7190999
 SHA512:
-  metadata.gz: 75194ca626816201d59884e40fcead12afaa115f1935a8a4722c18591c4a7ae91565c7166b7cab75fa10e948f740e11acbea53845055a9cc64bff9cbb92750cf
-  data.tar.gz: 0531d6c46349852dfc6253563d6dc1ce14a4fe771626bc375b130962a9d162071216f1cd112197b19a7daaae24d8f259387abf055fec6cf9acd3633ccfbe6893
+  metadata.gz: cb967276a656a03fde3b69145a43ce1b01805bac6123ca205127317943c89d3154276a4cffd526dde879cc561bc7cf97eba895cd2f9d5b8b8390ddd3041b0e05
+  data.tar.gz: 3d8075a9b34a50e72009eb55498ec16fdab6b075a63af4638dcb95e2c61408bc20199fac99115449c4234c4d8afe3050d3040883a1bd3f2933fd43fb6cb8dc84

data/.github/workflows/rake.yml

@@ -0,0 +1,62 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main  ]
+    tags: [ v* ]
+  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
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
+
+      - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger tests passed event
+        uses: Sibz/github-status-action@v1
+        with:
+          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 }}

data/README.adoc

@@ -1,17 +1,14 @@
 = Metanorma for BIPM: Metanorma processor for Bureau International de Poids et Mesures
 
-image:https://img.shields.io/gem/v/metanorma-bimp.sbimp["Gem Version", link="https://rubygems.org/gems/metanorma-bimp"]
-image:https://github.com/metanorma/metanorma-bimp/workflows/macos/badge.sbimp["Build Status (macOS)", link="https://github.com/metanorma/metanorma-bimp/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-bimp/workflows/ubuntu/badge.sbimp["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-bimp/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-bimp/workflows/windows/badge.sbimp["Build Status (Windows)", link="https://github.com/metanorma/metanorma-bimp/actions?workflow=windows"]
-image:https://codeclimate.com/github/metanorma/metanorma-bimp/badges/gpa.sbimp["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-bimp"]
-image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-bimp.sbimp["Pull Requests", link="https://github.com/metanorma/metanorma-bimp/pulls"]
-image:https://img.shields.io/github/commits-since/metanorma/metanorma-bimp/latest.sbimp["Commits since latest",link="https://github.com/metanorma/metanorma-bimp/releases"]
+image:https://img.shields.io/gem/v/metanorma-bipm.svg["Gem Version", link="https://rubygems.org/gems/metanorma-bipm"]
+image:https://github.com/metanorma/metanorma-bipm/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-bipm/actions?workflow=rake"]
+image:https://codeclimate.com/github/metanorma/metanorma-bipm/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-bipm"]
+image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-bipm.svg["Pull Requests", link="https://github.com/metanorma/metanorma-bipm/pulls"]
+image:https://img.shields.io/github/commits-since/metanorma/metanorma-bipm/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-bipm/releases"]
 
 == Functionality
 
-This gem processes http://asciidoctor.org/[Asciidoctor] documents following
-a template for generating BIPM standards.
+This gem processes https://www.metanorma.com[Metanorma documents] following a template for generating BIPM standards.
 
 == Usage
 
@@ -42,114 +39,10 @@ scripts such as this one. You need only run the following in a Terminal console:
 [source,console]
 ----
 $ bash <(curl -s https://raw.githubusercontent.com/riboseinc/metanorma-macos-setup/master/metanorma-setup)
-$ gem install metanorma-vg
+$ gem install metanorma-bipm
 ----
 
 
-== Document Attributes
-
-The gem relies on Asciidoctor document attributes to provide necessary
-metadata about the document. These include:
-
-`:edition:`:: The document edition
-
-`:revdate:`:: The date the document was last updated
-
-`:title-en:`:: The title of the document in English (mandatory)
-`:title-fr:`:: The title of the document in French (mandatory)
-`:title-cover-en:`:: The title of the front cover of the document in English (where different from the title proper)
-`:title-cover-fr:`:: The title of the front cover of the document in French (where different from the title proper)
-`:title-appendix-en:`:: The title of the appendix in English, if this document is an appendix published separately; `title-en` becomes the title of the main document, as presented within the standalone appendix.
-`:title-appendix-fr:`:: The title of the appendix in English, if this document is an appendix published separately; `title-en` becomes the title of the main document, as presented within the standalone appendix.
-
-`:appendix-id:`:: The number of the appendix, if this document is an appendix published separately
-
-`:si-aspect:`:: The domain of SI covered by the document; used to select logo in PDF cover page. The logo nominates one primary SI base units, and defining consonants for that unit and possibly others as well. The permitted values are:
-+
---
-* A_e_deltanu (ampere; time)
-* A_e (ampere)
-* cd_Kcd_h_deltanu (candela; mass, time)
-* cd_Kcd (candela)
-* full (all units)
-* K_k_deltanu (kelvin; mass, time)
-* K_k (kelvin)
-* kg_h_c_deltanu (kilogram; length, time)
-* kg_h (kilogram)
-* m_c_deltanu (metre; time)
-* m_c (metre)
-* mol_NA (mole)
-* s_deltanu (second)
---
-
-`:copyright-year:`:: The year which will be claimed as when the copyright for
-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.
-
-`:superseded-by:`:: One or more BIPM document that this BIPM document standard is superseded by; this
-document may still remain in effect. Comma delimited.
-
-`:doctype:`:: The document type (mandatory). The permitted types are:
-+
---
-* brochure (default)
-* mise-en-pratique
-* rapport
-* monographie
-* guide
-* meeting-report
-* technical-report
-* working-party-note
-* strategy
-* cipm-mra
-* resolution
---
-
-`:status:``:: The document status. The permitted types are: `draft-proposal`,
-`draft-development`, `in-force`, `retired`.
-
-`:committee:`:: The name 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
-* 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
---
-`:workgroup:`:: The name of the relevant workgroup (mandatory)
-
-`:language:` :: The language of the document (`en` or `fr`)  (mandatory)
-
-`:comment-period-from:`:: Start of the period during which comments are allowed on the document draft
-`:comment-period-to:`:: End of the period during which comments are allowed on the document draft (optional)
-
-`:obsoleted-date:`:: The date a document was superseded
-`:implemented-date:`:: The date a document became effective
-
-The attribute `:draft:`, if present, includes review notes in the XML output;
-these are otherwise suppressed.
-
-== Markup
-
-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.
-
 == Data Models
 
 The document model for BIPM is given in https://github.com/metanorma/metanorma-model-bipm[metanorma-model-bipm].

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,15 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
+      <attribute name="to">
+        <data type="IDREF"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
       <optional>
-        <attribute name="secondary"/>
+        <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>
   </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>
+        <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 -->
   <define name="bookmark">
     <element name="bookmark">

data/lib/asciidoctor/bipm/bipm.rng

@@ -42,9 +42,163 @@
             <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>
+    <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>
@@ -65,9 +219,9 @@
         <oneOrMore>
           <ref name="committee"/>
         </oneOrMore>
-        <oneOrMore>
+        <zeroOrMore>
           <ref name="workgroup"/>
-        </oneOrMore>
+        </zeroOrMore>
       </element>
     </define>
     <define name="structuredidentifier">
@@ -98,6 +252,9 @@
       <optional>
         <ref name="si-aspect"/>
       </optional>
+      <optional>
+        <ref name="meeting-note"/>
+      </optional>
       <ref name="structuredidentifier"/>
     </define>
   </include>
@@ -132,30 +289,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>
@@ -175,7 +343,9 @@
       <optional>
         <ref name="boilerplate"/>
       </optional>
-      <ref name="preface"/>
+      <optional>
+        <ref name="preface"/>
+      </optional>
       <oneOrMore>
         <ref name="sections"/>
       </oneOrMore>