metanorma-iso 1.3.23 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e8cbb045e33e2e3403dffc3beac4df18852c29f0bb18edbf579f919ba7923b0
-  data.tar.gz: e38bf3e9fd8169b4ec39110360497a839690d2aed836f80b5033f0c5fc432cba
+  metadata.gz: cf7373ffbae98a68238da9522616ea93b1f80ed8c927351146bba35e3b55d8d3
+  data.tar.gz: 88c3f55c85d8bd6896f70fb8e5d049a23bef8b78ee5fb0dc3013dcdd9352cdd0
 SHA512:
-  metadata.gz: 5ab999ee188ea2819dfe7a7c50192a96a7dfb2353d28ba3790033846d120f5b262c137bf5cfe5ed29f0dfd3e2129d4a2dad031d1d9974b6cf5bfb4e198dc40c3
-  data.tar.gz: c2da9c1dcded9f65252718d00a22c6195f4a403477a91a3dba51572025ee3aaebbcf02e888301b04b461c938498fe5435c62ff0209b3705c57406bdaa903685f
+  metadata.gz: ec1b451def873895ba8d1d92f87ac2bfe3820312dbc36533df5115421b89fd7ac3d1ecd8ec8720c29c8070f210f6c1af1b554360cf668c0fa5a921ee8232d10b
+  data.tar.gz: bf7f4b814a7dfbd3c7daf1f3845ec2da2b0ee3bcb04494eb0b2a5c5346011819d1c386a553250d65cb84b305dde0ffe866f9d7b40ce167390fdfd1274b6824b0

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

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

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

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
@@ -31,20 +36,28 @@ module Asciidoctor
         IsoDoc::Iso::PdfConvert.new(doc_extract_attributes(node))
       end
 
-      def document(node)
-        init(node)
-        ret = makexml(node).to_xml(indent: 2)
-        unless node.attr("nodoc") || !node.attr("docfile")
+      def sts_converter(node)
+        return nil if node.attr("no-pdf")
+        IsoDoc::Iso::StsConvert.new(html_extract_attributes(node))
+      end
+
+      def presentation_xml_converter(node)
+        IsoDoc::Iso::PresentationXMLConvert.new(html_extract_attributes(node))
+      end
+
+      def init(node)
+        super
+        @amd = %w(amendment technical-corrigendum).include? node.attr("doctype")
+      end
+
+      def outputs(node, ret)
           File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-          html_converter_alt(node).convert(@filename + ".xml")
-          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")
-        end
-        @log.write(@localdir + @filename + ".err") unless @novalid
-        @files_to_delete.each { |f| FileUtils.rm f }
-        ret
+          presentation_xml_converter(node).convert(@filename + ".xml")
+          html_converter_alt(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}_alt.html")
+          html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
+          doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
+          pdf_converter(node)&.convert(@filename + ".presentation.xml", nil, false, "#{@filename}.pdf")
+          #sts_converter(node)&.convert(@filename + ".xml")
       end
 
       def load_yaml(lang, script)

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>
@@ -1001,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">

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