metanorma-iso 1.9.5 → 1.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3710d3b53ba9f99228d2305a92fc2ae20f8aee71f555a06b3273a029df82dc9
-  data.tar.gz: 14d71fa2b1cac17b6097d6601bc05a36096cce50ae6dd0ace99cbee759fe8d47
+  metadata.gz: 697a2f88d09f6183604f8ead7682575df682e59c09c211b3482404bbb5b7c5bf
+  data.tar.gz: 452e1127517360903e4406ab81d443903f2490350b4a1df7b2dd114221c454a1
 SHA512:
-  metadata.gz: 9fd09732d19307285a7f4068b97be6c0bb5ca9a15028f10241c778e56eaf3d2d55093015d16f56c9cde30715d0c8842f345abd1bbeea0a208fd499c98fa303b2
-  data.tar.gz: b7abcda89ee9c7b390fbfef096b5403a1e507d9ed4e70071ccc3679c6cdc9c9c440c68b931634470407b85bc6acf562248713ff81d1ec25fc85d90d7bf8fd653
+  metadata.gz: '09ac021eb3cd2c87f722f3b4c2033e0c5188f814609ff389018b7f65026a61f4f9c51f15650904b742a540a0c719f7742afedab5d0b89770c6913f02d38dfa44'
+  data.tar.gz: d04e4234d13815cdb41168a18887610a2700611519cf3c9748cc492181ce28bafbfc95cfc094ca478d5dac461487992b822ebcec50bf385f9a998a28003fe34e

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,41 @@
+name: ubuntu
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup prerequisites
+        run: |
+          sudo apt-get update
+          sudo apt-get -y install xsltproc
+
+      - run: make xsd_doc
+        env:
+          GITHUB_USERNAME: ${{ github.actor }}
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - uses: actions/upload-artifact@master
+        with:
+          name: xsd_doc
+          path: xsd_doc
+
+  deploy-gh-pages:
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - uses: actions/checkout@master
+
+    - uses: actions/download-artifact@master
+      with:
+        name: xsd_doc-ubuntu
+        path: xsd_doc
+

data/Gemfile

@@ -4,11 +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"
+# 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
+if File.exist? "Gemfile.devel"
+  eval File.read("Gemfile.devel"), nil, "Gemfile.devel" # rubocop:disable Security/Eval
 end
-

data/Makefile

@@ -8,6 +8,15 @@ SHELL := /bin/bash
 # Ensure the xml2rfc cache directory exists locally
 IGNORE := $(shell mkdir -p $(HOME)/.cache/xml2rfc)
 
+TRANG_RELEASE := https://github.com/relaxng/jing-trang/releases/download/V20181222/trang-20181222.zip
+TOOLS_DIR := ${CURDIR}/tools
+TRANG_JAR := $(TOOLS_DIR)/trang.jar
+XSDVIPATH := $(TOOLS_DIR)/xsdvi.jar
+XSLT_FILE := $(TOOLS_DIR)/xs3pxsl
+XSLT_FILE_MERGE := $(TOOLS_DIR)/xsdmerge.xsl
+RNG_FILE_SRC := lib/asciidoctor/iso/isostandard.rng
+XSD_FILE_DEST := ${CURDIR}/xsd_doc/isostandard.xsd
+
 all: $(TXT) $(HTML) $(XML) $(NITS)
 
 clean:
@@ -37,3 +46,38 @@ clean:
 open:
 	open *.txt
 
+
+$(XSDVIPATH):
+	mkdir -p $(dir $@); \
+	curl -sSL https://sourceforge.net/projects/xsdvi/files/latest/download > $(dir $@)/xsdvi.zip; \
+	unzip -p $(dir $@)/xsdvi.zip dist/lib/xercesImpl.jar > $(dir $@)/xercesImpl.jar; \
+	curl -sSL https://github.com/metanorma/xsdvi/releases/download/v1.0/xsdvi-1.0.jar > $@
+
+$(XSLT_FILE):
+	mkdir -p $(dir $@)
+	curl -sSL https://raw.githubusercontent.com/metanorma/xs3p/main/xsl/xs3p.xsl > $@
+
+$(XSLT_FILE_MERGE):
+	mkdir -p $(dir $@)
+	curl -sSL https://raw.githubusercontent.com/metanorma/xs3p/main/xsl/xsdmerge.xsl > $@
+
+$(TRANG_JAR):
+	mkdir -p $(dir $@); \
+	cd $(dir $@); \
+	curl -sSL $(TRANG_RELEASE) > trang.zip; \
+ 	unzip -p trang.zip trang-20181222/trang.jar > $@
+
+
+$(XSD_FILE_DEST): $(TRANG_JAR)
+	mkdir -p $(dir $@); \
+	java -jar $< $(RNG_FILE_SRC) $@
+
+xsd_doc:  $(XSD_FILE_DEST) $(XSDVIPATH) $(XSLT_FILE) $(XSLT_FILE_MERGE)
+	mkdir -p $@/diagrams; \
+	cd $@; \
+	java -jar $(XSDVIPATH) $< -rootNodeName all -oneNodeOnly -outputPath diagrams; \
+	xsltproc --nonet --stringparam rootxsd iso-standard --output $@.tmp $(XSLT_FILE_MERGE) $<;\
+	xsltproc --nonet --param title "'Metanorma XML Schema Documentation, ISO Standard'" \
+		--output index.html $(XSLT_FILE) $@.tmp;\
+	rm $@.tmp
+

data/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-require 'isodoc/gem_tasks'
+require "isodoc/gem_tasks"
 
 IsoDoc::GemTasks.install
 RSpec::Core::RakeTask.new(:spec)

data/bin/rspec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-  
+
 # This file was generated by Bundler.
 #
 # The application 'rspec' is installed as part of a gem, and
@@ -15,4 +15,3 @@ require "rubygems"
 require "bundler/setup"
 
 load Gem.bin_path("rspec-core", "rspec")
-

data/lib/asciidoctor/iso/basicdoc.rng

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+<grammar xmlns="http://relaxng.org/ns/structure/1.0" xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <include href="biblio.rng">
     <start>
       <ref name="document"/>
@@ -19,6 +19,7 @@
   </define>
   <define name="bibdata">
     <element name="bibdata">
+      <a:documentation>Document attributes</a:documentation>
       <ref name="BibData"/>
     </element>
   </define>
@@ -104,10 +105,12 @@
   </define>
   <define name="paragraph">
     <element name="p">
+      <a:documentation>Paragraph</a:documentation>
       <ref name="ParagraphType"/>
     </element>
   </define>
   <define name="Alignments">
+    <a:documentation>Text alignment</a:documentation>
     <choice>
       <value>left</value>
       <value>right</value>
@@ -215,6 +218,7 @@
   </define>
   <define name="quote">
     <element name="quote">
+      <a:documentation>Block quotes</a:documentation>
       <attribute name="id">
         <data type="ID"/>
       </attribute>
@@ -249,6 +253,7 @@
   </define>
   <define name="sourcecode">
     <element name="sourcecode">
+      <a:documentation>Source code, a pre-formatted source snippet to be rendered in monospace font, and with spaces preserved</a:documentation>
       <attribute name="id">
         <data type="ID"/>
       </attribute>
@@ -624,6 +629,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -634,6 +642,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -641,7 +652,12 @@
   <define name="tt">
     <element name="tt">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -822,7 +838,9 @@
       <attribute name="alt"/>
     </optional>
     <ref name="CitationType"/>
-    <text/>
+    <oneOrMore>
+      <ref name="PureTextElement"/>
+    </oneOrMore>
   </define>
   <define name="hyperlink">
     <element name="link">
@@ -835,7 +853,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="xref">
@@ -849,7 +869,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="fn">
@@ -1030,6 +1052,7 @@
   </define>
   <define name="ul">
     <element name="ul">
+      <a:documentation>Unordered list</a:documentation>
       <attribute name="id">
         <data type="ID"/>
       </attribute>
@@ -1043,6 +1066,7 @@
   </define>
   <define name="li">
     <element name="li">
+      <a:documentation>List item</a:documentation>
       <optional>
         <attribute name="id">
           <data type="ID"/>
@@ -1080,6 +1104,7 @@
   </define>
   <define name="dl">
     <element name="dl">
+      <a:documentation>Definition list</a:documentation>
       <attribute name="id">
         <data type="ID"/>
       </attribute>
@@ -1094,6 +1119,7 @@
   </define>
   <define name="dt">
     <element name="dt">
+      <a:documentation>Definition term</a:documentation>
       <zeroOrMore>
         <ref name="TextElement"/>
       </zeroOrMore>
@@ -1101,6 +1127,7 @@
   </define>
   <define name="dd">
     <element name="dd">
+      <a:documentation>Definition description</a:documentation>
       <zeroOrMore>
         <ref name="paragraph-with-footnote"/>
       </zeroOrMore>

data/lib/asciidoctor/iso/biblio.rng

@@ -76,12 +76,14 @@
   <define name="script">
     <a:documentation>ISO-639</a:documentation>
     <element name="script">
+        <a:documentation>ISO-639</a:documentation>
       <text/>
     </element>
   </define>
   <define name="edition">
     <a:documentation>ISO-15924: Latn</a:documentation>
     <element name="edition">
+      <a:documentation>ISO-15924: Latn</a:documentation>
       <optional>
         <attribute name="number"/>
       </optional>

data/lib/asciidoctor/iso/cleanup.rb

@@ -8,7 +8,7 @@ module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
       PRE_NORMREF_FOOTNOTES = "//preface//fn | "\
-        "//clause[@type = 'scope']//fn".freeze
+                              "//clause[@type = 'scope']//fn".freeze
 
       NORMREF_FOOTNOTES =
         "//references[@normative = 'true']//fn".freeze
@@ -41,7 +41,7 @@ module Asciidoctor
         xmldoc.xpath("//bibdata/contributor[role/@type = 'publisher']"\
                      "/organization").each do |x|
           x1 = x.at("abbreviation")&.text || x.at("name")&.text
-          x1 == "ISO" and prefix.unshift("ISO") or prefix << x1
+          (x1 == "ISO" and prefix.unshift("ISO")) or prefix << x1
         end
         prefix
       end
@@ -64,14 +64,15 @@ module Asciidoctor
         super
       end
 
-      TERM_CLAUSE = "//sections//terms | "\
+      TERM_CLAUSE =
+        "//sections//terms | "\
         "//sections//clause[descendant::terms][not(descendant::definitions)]"
-        .freeze
+          .freeze
 
       PUBLISHER = "./contributor[role/@type = 'publisher']/organization".freeze
 
       OTHERIDS = "@type = 'DOI' or @type = 'metanorma' or @type = 'ISSN' or "\
-        "@type = 'ISBN'".freeze
+                 "@type = 'ISBN'".freeze
 
       def pub_class(bib)
         return 1 if bib.at("#{PUBLISHER}[abbreviation = 'ISO']")
@@ -111,7 +112,7 @@ module Asciidoctor
           bib&.at("./title")&.text || bib&.at("./formattedref")&.text
         "#{pubclass} :: #{type} :: "\
           "#{num.nil? ? abbrid : sprintf('%09d', num.to_i)} :: "\
-          "#{partid} :: #{id&.text} :: #{title}"
+          "#{sprintf('%09d', partid.to_i)} :: #{id&.text} :: #{title}"
       end
 
       def sections_cleanup(xml)

data/lib/asciidoctor/iso/front.rb

@@ -116,7 +116,7 @@ module Asciidoctor
 
         xml.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(
-            node.attr("title-amendment-#{lang}")
+            node.attr("title-amendment-#{lang}"),
           )
         end
       end
@@ -144,6 +144,14 @@ module Asciidoctor
           title_amd(node, xml, lang, at) if @amd
         end
       end
+
+      def relaton_relations
+        super + %w(obsoletes)
+      end
+
+      def relaton_relation_descriptions
+        super.merge("amends" => "updates")
+      end
     end
   end
 end