metanorma-iso 1.3.22 → 1.3.27

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f454035889b3408ef910c7bdc28bb3d53cca352078b04459381fbeb48cfe71e
-  data.tar.gz: f9de44382a1a76374569a60fd18807f4a4412222148a7529f42420923b60ffdc
+  metadata.gz: 1f2bd4b15c4295ebf947cb014b8bbc6f53b7c539860613320a00e65f44e918fc
+  data.tar.gz: 2e3741a0bf4f87e702571463f70460d8ba94e54d71a3f1ed910c54735df60b1f
 SHA512:
-  metadata.gz: 638a95ff84fe3bdeec6cb509c3a00f740190dcddfa5765ee585a5c2e79716a86be12cdb5a351fed9133b21d0414b554922aaf8a24ddf317017ac1368d526ca0c
-  data.tar.gz: 8abc4415c4ad990b6cafd3f1bdce2ea93dadaece4cf4f339455d6547ee4c7cb4af2a73ee2b8816d065270c0955c620d739e54dc376c0cb3f1ecb23411298bb0f
+  metadata.gz: 0dab537420c96a7c56e6eaf99d20462e7bf8284ed2e919761df70e1e8b2c3331376001abdf81d14e769f938492ecbe5a4439dc547c050a01e6bb4529ed2f0bab
+  data.tar.gz: 9acb9ac16c1fb230c842d43596af7fd01ee8f08504ab62119ce03379fab9c56e7aa1e878a5114b74c0cf5214656cef47d9b0846eac9e94ca6e282181445bc948

data/.github/workflows/macos.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-macos:
     name: Test on Ruby ${{ matrix.ruby }} macOS
     runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -26,13 +34,6 @@ jobs:
         run: |
           sudo gem install bundler --force
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '8'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer
       - name: Install PlantUML
         run: |
           brew install plantuml

data/.github/workflows/ubuntu.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-linux:
     name: Test on Ruby ${{ matrix.ruby }} Ubuntu
     runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -26,13 +34,6 @@ jobs:
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '8'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer
       - name: Install PlantUML
         run: |
           sudo bash -c "curl -L https://github.com/riboseinc/plantuml-install/raw/master/ubuntu.sh | bash"

data/.github/workflows/windows.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
 
 jobs:
   test-windows:
     name: Test on Ruby ${{ matrix.ruby }} Windows
     runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -27,15 +35,7 @@ jobs:
         run: |
           gem install bundler
           bundle config --local path vendor/bundle
-          bundle update
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '8'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer
       - name: Install PlantUML
         run: |
           cinst -y plantuml

data/Gemfile

@@ -4,8 +4,10 @@ Encoding.default_internal = Encoding::UTF_8
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}" }
 
+#gem "asciimath", git: "https://github.com/asciidoctor/asciimath"
 gemspec
 
 if File.exist? 'Gemfile.devel'
   eval File.read('Gemfile.devel'), nil, 'Gemfile.devel' # rubocop:disable Security/Eval
 end
+

data/lib/asciidoctor/iso/base.rb

@@ -6,6 +6,7 @@ require "open-uri"
 require "pp"
 require "isodoc"
 require "fileutils"
+require 'asciidoctor/iso/macros'
 
 module Asciidoctor
   module ISO
@@ -13,6 +14,10 @@ module Asciidoctor
       XML_ROOT_TAG = "iso-standard".freeze
       XML_NAMESPACE = "https://www.metanorma.org/ns/iso".freeze
 
+      Asciidoctor::Extensions.register do
+        inline_macro Asciidoctor::Iso::TermRefInlineMacro
+      end
+
       def html_converter(node)
         IsoDoc::Iso::HtmlConvert.new(html_extract_attributes(node))
       end
@@ -26,6 +31,21 @@ module Asciidoctor
         IsoDoc::Iso::WordConvert.new(doc_extract_attributes(node))
       end
 
+      def pdf_converter(node)
+        return nil if node.attr("no-pdf")
+        IsoDoc::Iso::PdfConvert.new(doc_extract_attributes(node))
+      end
+
+      def sts_converter(node)
+        return nil if node.attr("no-pdf")
+        IsoDoc::Iso::StsConvert.new(html_extract_attributes(node))
+      end
+
+      def init(node)
+        super
+        @amd = %w(amendment technical-corrigendum).include? node.attr("doctype")
+      end
+
       def document(node)
         init(node)
         ret = makexml(node).to_xml(indent: 2)
@@ -35,6 +55,8 @@ module Asciidoctor
           FileUtils.mv "#{@filename}.html", "#{@filename}_alt.html"
           html_converter(node).convert(@filename + ".xml")
           doc_converter(node).convert(@filename + ".xml")
+          pdf_converter(node)&.convert(@filename + ".xml")
+          sts_converter(node)&.convert(@filename + ".xml")
         end
         @log.write(@localdir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }

data/lib/asciidoctor/iso/biblio.rng

@@ -88,7 +88,7 @@
       <text/>
     </element>
   </define>
-  <define name="LocalizedString">
+  <define name="LocalizedString1">
     <optional>
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
@@ -98,6 +98,16 @@
     </optional>
     <text/>
   </define>
+  <define name="LocalizedString">
+    <choice>
+      <ref name="LocalizedString1"/>
+      <oneOrMore>
+        <element name="variant">
+          <ref name="LocalizedString1"/>
+        </element>
+      </oneOrMore>
+    </choice>
+  </define>
   <!--
     Unlike UML, change type to format: type is overloaded
     Would be need if plain were default value and could omit the attribute
@@ -121,7 +131,7 @@
     </optional>
     <ref name="LocalizedStringOrXsAny"/>
   </define>
-  <define name="LocalizedStringOrXsAny">
+  <define name="LocalizedStringOrXsAny1">
     <optional>
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
@@ -136,6 +146,16 @@
       </choice>
     </oneOrMore>
   </define>
+  <define name="LocalizedStringOrXsAny">
+    <choice>
+      <ref name="LocalizedStringOrXsAny1"/>
+      <oneOrMore>
+        <element name="variant">
+          <ref name="LocalizedStringOrXsAny1"/>
+        </element>
+      </oneOrMore>
+    </choice>
+  </define>
   <define name="contributor">
     <element name="contributor">
       <zeroOrMore>
@@ -512,7 +532,7 @@
   </define>
   <define name="LocalityType">
     <data type="string">
-      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|list|example|volume|issue|time|locality:[a-zA-Z0-9_]+</param>
+      <param name="pattern">section|clause|part|paragraph|chapter|page|whole|table|annex|figure|note|list|example|volume|issue|time|anchor|locality:[a-zA-Z0-9_]+</param>
     </data>
   </define>
   <define name="referenceFrom">
@@ -641,9 +661,9 @@
     <optional>
       <ref name="status"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="copyright"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="docrelation"/>
     </zeroOrMore>
@@ -767,6 +787,8 @@
       <value>unchanged</value>
       <value>circulated</value>
       <value>adapted</value>
+      <value>vote-started</value>
+      <value>vote-ended</value>
     </choice>
   </define>
   <define name="bdate">
@@ -999,7 +1021,17 @@
       <optional>
         <ref name="to"/>
       </optional>
-      <ref name="owner"/>
+      <oneOrMore>
+        <ref name="owner"/>
+      </oneOrMore>
+      <optional>
+        <ref name="copyright_scope"/>
+      </optional>
+    </element>
+  </define>
+  <define name="copyright_scope">
+    <element name="scope">
+      <text/>
     </element>
   </define>
   <define name="from">
@@ -1019,38 +1051,63 @@
   </define>
   <define name="DocRelationType">
     <choice>
-      <value>obsoletes</value>
-      <value>obsoletedBy</value>
-      <value>supersedes</value>
-      <value>supersededBy</value>
-      <value>updates</value>
-      <value>updatedBy</value>
-      <value>complements</value>
-      <value>derivedFrom</value>
-      <value>translatedFrom</value>
-      <value>hasTranslation</value>
-      <value>adoptedFrom</value>
-      <value>equivalent</value>
-      <value>identical</value>
-      <value>nonequivalent</value>
-      <value>includedIn</value>
       <value>includes</value>
-      <value>instance</value>
-      <value>instanceOf</value>
-      <value>partOf</value>
+      <value>includedIn</value>
       <value>hasPart</value>
-      <value>hasDraft</value>
-      <value>draftOf</value>
+      <value>partOf</value>
       <value>merges</value>
+      <value>mergedInto</value>
       <value>splits</value>
-      <value>amends</value>
-      <value>amendedBy</value>
-      <value>corrects</value>
-      <value>correctedBy</value>
-      <value>revises</value>
-      <value>revisedBy</value>
+      <value>splitInto</value>
+      <value>instance</value>
+      <value>hasInstance</value>
+      <value>exemplarOf</value>
+      <value>hasExemplar</value>
+      <value>manifestationOf</value>
+      <value>hasManifestation</value>
+      <value>reproductionOf</value>
+      <value>hasReproduction</value>
+      <value>reprintOf</value>
+      <value>hasReprint</value>
+      <value>expressionOf</value>
+      <value>hasExpression</value>
+      <value>translatedFrom</value>
+      <value>hasTranslation</value>
+      <value>arrangementOf</value>
+      <value>hasArrangement</value>
+      <value>abridgementOf</value>
+      <value>hasAbridgement</value>
+      <value>annotationOf</value>
+      <value>hasAnnotation</value>
+      <value>draftOf</value>
+      <value>hasDraft</value>
+      <value>editionOf</value>
+      <value>hasEdition</value>
+      <value>updates</value>
+      <value>updatedBy</value>
+      <value>derivedFrom</value>
+      <value>derives</value>
       <value>describes</value>
       <value>describedBy</value>
+      <value>catalogues</value>
+      <value>cataloguedBy</value>
+      <value>hasSuccessor</value>
+      <value>successorOf</value>
+      <value>adaptedFrom</value>
+      <value>hasAdaptation</value>
+      <value>adoptedFrom</value>
+      <value>adoptedAs</value>
+      <value>reviewOf</value>
+      <value>hasReview</value>
+      <value>commentaryOf</value>
+      <value>hasCommentary</value>
+      <value>related</value>
+      <value>complements</value>
+      <value>complementOf</value>
+      <value>obsoletes</value>
+      <value>obsoletedBy</value>
+      <value>cited</value>
+      <value>isCitedIn</value>
     </choice>
   </define>
   <define name="docrelation">

data/lib/asciidoctor/iso/cleanup.rb

@@ -5,6 +5,7 @@ require "json"
 require "pathname"
 require "open-uri"
 require "pp"
+require "asciidoctor/iso/term_lookup_cleanup"
 
 module Asciidoctor
   module ISO
@@ -13,12 +14,12 @@ module Asciidoctor
         "//clause[title = 'Scope']//fn".freeze
 
       NORMREF_FOOTNOTES =
-        "//references[title = 'Normative References']//fn".freeze
+        "//references[@normative = 'true']//fn".freeze
 
       POST_NORMREF_FOOTNOTES =
         "//sections//clause[not(title = 'Scope')]//fn | "\
         "//annex//fn | "\
-        "//references[title = 'Bibliography']//fn".freeze
+        "//references[@normative = 'false']//fn".freeze
 
       def other_footnote_renumber(xmldoc)
         seen = {}
@@ -35,6 +36,7 @@ module Asciidoctor
       end
 
       def id_prefix(prefix, id)
+        return id.text if @amd # we're just inheriting the prefixes from parent doc
         prefix.join("/") + ( id.text.match(%{^/}) ? "" :  " " ) + id.text
       end
 
@@ -51,12 +53,14 @@ module Asciidoctor
       # ISO as a prefix goes first
       def docidentifier_cleanup(xmldoc)
         prefix = get_id_prefix(xmldoc)
-        id = xmldoc.at("//bibdata/docidentifier[@type = 'iso']") or return
+        id = xmldoc.at("//bibdata/docidentifier[@type = 'ISO']") or return
         id.content = id_prefix(prefix, id)
         id = xmldoc.at("//bibdata/ext/structuredidentifier/project-number") and
           id.content = id_prefix(prefix, id)
         id = xmldoc.at("//bibdata/docidentifier[@type = 'iso-with-lang']") and
           id.content = id_prefix(prefix, id)
+        id = xmldoc.at("//bibdata/docidentifier[@type = 'iso-reference']") and
+          id.content = id_prefix(prefix, id)
       end
 
       def format_ref(ref, type, isopub)
@@ -86,6 +90,11 @@ module Asciidoctor
         end
       end
 
+      def termdef_cleanup(xmldoc)
+        Asciidoctor::ISO::TermLookupCleanup.new(xmldoc, @log).call
+        super
+      end
+
       # TODO sort by authors
       # sort by: doc class (ISO, IEC, other standard (not DOI &c), other
       # then standard class (docid class other than DOI &c)
@@ -108,6 +117,14 @@ module Asciidoctor
           "#{num.nil? ? abbrid : sprintf("%09d", num.to_i)} :: "\
           "#{partid} :: #{id&.text} :: #{title}"
       end
+
+      def sections_cleanup(x)
+        super
+        return unless @amd
+        x.xpath("//*[@inline-header]").each do |h|
+          h.delete('inline-header')
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/iso/front.rb

@@ -5,110 +5,18 @@ require "json"
 require "pathname"
 require "open-uri"
 require "pp"
+require_relative "front_id"
 
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
-       STAGE_ABBRS = {
-        "00": "PWI",
-        "10": "NWIP",
-        "20": "WD",
-        "30": "CD",
-        "40": "DIS",
-        "50": "FDIS",
-        "60": "IS",
-        "90": "(Review)",
-        "95": "(Withdrawal)",
-      }.freeze
-
-       STAGE_NAMES = {
-        "00": "Preliminary work item",
-        "10": "New work item proposal",
-        "20": "Working draft",
-        "30": "Committee draft",
-        "40": "Draft international standard",
-        "50": "Final draft international standard",
-        "60": "International standard",
-        "90": "Review",
-        "95": "Withdrawal",
-      }.freeze
-
-      def stage_abbr(stage, substage)
-        return nil if stage.to_i > 60
-        return "PRF" if stage == "60" && substage == "00"
-        STAGE_ABBRS[stage.to_sym]
-      end
-
-      def stage_name(stage, substage)
-        return "Proof" if stage == "60" && substage == "00"
-        STAGE_NAMES[stage.to_sym]
-      end
-
-      def metadata_id(node, xml)
-        iso_id(node, xml)
-        node&.attr("tc-docnumber")&.split(/,\s*/)&.each do |n|
-          xml.docidentifier(n, **attr_code(type: "iso-tc"))
-        end
-        xml.docnumber node&.attr("docnumber")
-      end
-
-      def iso_id(node, xml)
-        return unless node.attr("docnumber")
-        part, subpart = node&.attr("partnumber")&.split(/-/)
-        dn = add_id_parts(node.attr("docnumber"), part, subpart)
-        dn = id_stage_prefix(dn, node)
-        xml.docidentifier dn, **attr_code(type: "iso")
-        xml.docidentifier id_langsuffix(dn, node), **attr_code(type: "iso-with-lang")
-      end
-
-      def id_langsuffix(dn, node)
-        lang = node.attr("language") || "en"
-        suffix = case lang
-                 when "en" then "(E)"
-                 when "fr" then "(F)"
-                 else
-                   "(X)"
-                 end
-        "#{dn} #{suffix}"
-      end
-
       def metadata_ext(node, xml)
         super
         structured_id(node, xml)
-        xml.stagename stage_name(get_stage(node), get_substage(node))
-      end
-
-      def structured_id(node, xml)
-        return unless node.attr("docnumber")
-        part, subpart = node&.attr("partnumber")&.split(/-/)
-        xml.structuredidentifier do |i|
-          i.project_number node.attr("docnumber"),
-            **attr_code(part: part, subpart: subpart)
-        end
-      end
-
-      def add_id_parts(dn, part, subpart)
-        dn += "-#{part}" if part
-        dn += "-#{subpart}" if subpart
-        dn
-      end
-
-      def id_stage_abbr(stage, substage, node)
-        IsoDoc::Iso::Metadata.new("en", "Latn", {}).
-          status_abbrev(stage_abbr(stage, substage), substage, node.attr("iteration"),
-                       node.attr("draft"))
-      end
-
-      def id_stage_prefix(dn, node)
-        stage = get_stage(node)
-        substage = get_substage(node)
-        if stage && (stage.to_i < 60)
-          abbr = id_stage_abbr(stage, substage, node)
-          dn = "/#{abbr} #{dn}" unless abbr.nil? || abbr.empty? # prefixes added in cleanup
-        else
-          dn += ":#{node.attr("copyright-year")}" if node.attr("copyright-year")
-        end
-        dn
+        xml.stagename stage_name(get_stage(node), get_substage(node),
+                                 node.attr("doctype"), node.attr("iteration"))
+        @amd && a = node.attr("updates-document-type") and
+          xml.updates_document_type a
       end
 
       def organization(org, orgname)
@@ -157,20 +65,11 @@ module Asciidoctor
         end
       end
 
-      def get_stage(node)
-        stage = node.attr("status") || node.attr("docstage") || "60"
-      end
-
-      def get_substage(node)
-        stage = get_stage(node)
-        node.attr("docsubstage") || ( stage == "60" ? "60" : "00" )
-      end
-
       def metadata_status(node, xml)
         stage = get_stage(node)
         substage = get_substage(node)
         xml.status do |s|
-          s.stage stage, **attr_code(abbreviation: stage_abbr(stage, substage))
+          s.stage stage, **attr_code(abbreviation: stage_abbr(stage, substage, node.attr("doctype")))
           s.substage substage
           node.attr("iteration") && (s.iteration node.attr("iteration"))
         end
@@ -205,12 +104,21 @@ module Asciidoctor
         end
       end
 
+      def title_amd(node, t, lang, at)
+        return unless node.attr("title-amendment-#{lang}")
+        t.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
+          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-amendment-#{lang}"))
+        end
+      end
+
       def title_full(node, t, lang, at)
         title = node.attr("title-main-#{lang}")
         intro = node.attr("title-intro-#{lang}")
         part = node.attr("title-part-#{lang}")
+        amd = node.attr("title-amendment-#{lang}")
         title = "#{intro} -- #{title}" if intro
         title = "#{title} -- #{part}" if part
+        title = "#{title} -- #{amd}" if amd && @amd
         t.title **attr_code(at.merge(type: "main")) do |t1|
           t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(title)
         end
@@ -223,6 +131,7 @@ module Asciidoctor
           title_intro(node, xml, lang, at)
           title_main(node, xml, lang, at)
           title_part(node, xml, lang, at)
+          title_amd(node, xml, lang, at) if @amd
         end
       end
     end