metanorma-ogc 1.0.9 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03f9f62da65c53f1c3642b819ca4d736cbdc94374acc379ceb1de60280ef91e6
-  data.tar.gz: 94b9c283c453dbda58e9fd6b8ba7294e2238a8f72fbc07e68e9ce1bf62bbdf27
+  metadata.gz: cfeb15d2577cb48f993bf7a73f58be36077d2b21ca258c17276b0462ec8237c0
+  data.tar.gz: 4b79e2e72a36fe12d542ca20ac64625f261e973a63e1931041b42944d5474a22
 SHA512:
-  metadata.gz: 163148c85ab9d85778b4af7b91d297f6e6885118037a063e84678d8d30904ea6c74112ac8d517c91a4a7ceea9509ebb902bb9b6af69aef43b9dc6c68e146bbd2
-  data.tar.gz: 6a6dfed692bab95234941cb46cba2dc8581acec8ac21a5c8a68e40419b320a2ee0f475eb7c0cccf5f238b60e6f15dbf5d35fc4e4d29beb54ef895019f1ffe077
+  metadata.gz: e51b0f483c42b5ff9225410288821dd21ffb7ac8d6a7deac5ca40658c692e4a6bcd7f6792c04cbb4b091319c23c60d013665be610cbd320609715f9efbbb823c
+  data.tar.gz: 0e8c75fef49d337a48d128374fe7de3b950f575f83fe3ec3d1e87abd1dd7943cce67a3bd7da6856c9c31957cba7d58ba90735b2fe5054e0f2a1cb7a17d0af085

data/.github/workflows/macos.yml

@@ -29,7 +29,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         run: |
           sudo gem install bundler --force

data/.github/workflows/ubuntu.yml

@@ -31,7 +31,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         run: |
           gem install bundler
@@ -39,15 +38,19 @@ jobs:
       - name: Run specs
         run: |
           bundle exec rake
-      - name: Trigger dependent repositories
-        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
+      - name: Trigger repositories
+        if: matrix.ruby == '2.6'
         env:
-          GH_USERNAME: ${{ secrets.PAT_USERNAME }}
-          GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}
+          GH_USERNAME: metanorma-ci
+          GH_ACCESS_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
         run: |
           curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
           [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
-          for repo in $DEPENDENT_REPOS
+          CLIENT_PAYLOAD=$(cat <<EOF
+          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
+          EOF
+          )
+          for repo in $REPOS
           do
-            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "{ \"ref\": \"${GITHUB_REF}\" }"
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "$CLIENT_PAYLOAD"
           done

data/.github/workflows/windows.yml

@@ -29,7 +29,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         shell: pwsh
         run: |

data/Rakefile

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

data/lib/asciidoctor/ogc/converter.rb

@@ -52,21 +52,15 @@ module Asciidoctor
         end
       end
 
-      def document(node)
-        init(node)
-        ret1 = makexml(node)
-        ret = ret1.to_xml(indent: 2)
-        unless node.attr("nodoc") || !node.attr("docfile")
-          filename = node.attr("docfile").gsub(/\.adoc/, ".xml").
-            gsub(%r{^.*/}, "")
-          File.open(filename, "w") { |f| f.write(ret) }
-          html_converter(node).convert filename unless node.attr("nodoc")
-          word_converter(node).convert filename unless node.attr("nodoc")
-          pdf_converter(node)&.convert filename unless node.attr("nodoc")
-        end
-        @log.write(@localdir + @filename + ".err") unless @novalid
-        @files_to_delete.each { |f| FileUtils.rm f }
-        ret
+      def outputs(node, ret)
+        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
+        presentation_xml_converter(node).convert(@filename + ".xml")
+        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")
       end
 
       def validate(doc)
@@ -93,15 +87,16 @@ module Asciidoctor
       end
 
       def clause_parse(attrs, xml, node)
-        clausetype = node&.attr("heading")&.downcase || node.title.downcase
-        if clausetype == "submitters" then submitters_parse(attrs, xml, node)
-        else
-          super
+        case clausetype = node&.attr("heading")&.downcase || node.title.downcase
+        when "submitters" then return submitters_parse(attrs, xml, node)
+        when "conformance" then attrs = attrs.merge(type: "conformance")
         end
+        super
       end
 
       def submitters_parse(attrs, xml, node)
         xml.submitters **attr_code(attrs) do |xml_section|
+          xml_section.title @i18n.submitters
           xml_section << node.content
         end
       end
@@ -118,6 +113,10 @@ module Asciidoctor
         super
       end
 
+      def presentation_xml_converter(node)
+        IsoDoc::Ogc::PresentationXMLConvert.new(html_extract_attributes(node))
+      end
+
       def html_converter(node)
         IsoDoc::Ogc::HtmlConvert.new(html_extract_attributes(node))
       end
@@ -127,7 +126,7 @@ module Asciidoctor
         IsoDoc::Ogc::PdfConvert.new(html_extract_attributes(node))
       end
 
-      def word_converter(node)
+      def doc_converter(node)
         IsoDoc::Ogc::WordConvert.new(doc_extract_attributes(node))
       end
     end

data/lib/asciidoctor/ogc/isodoc.rng

@@ -922,6 +922,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +964,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +992,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1014,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1042,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1183,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>

data/lib/asciidoctor/ogc/validate.rb

@@ -49,35 +49,25 @@ module Asciidoctor
         [
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val: [{ tag: "clause", title: "Scope" }],
+            val: ["./self::clause[@type = 'scope']" ]
           },
           {
             msg: "Scope must be followed by Conformance",
-            val: [{ tag: "clause", title: "Conformance" }],
+            val: ["./self::clause[@type = 'conformance']" ]
           },
           {
             msg: "Normative References must be followed by "\
             "Terms and Definitions",
-            val: [
-              { tag: "terms", title: "Terms and definitions" },
-              { tag: "clause", title: "Terms and definitions" },
-              {
-                tag: "terms",
-                title: "Terms, definitions, symbols and abbreviated terms",
-              },
-              {
-                tag: "clause",
-                title: "Terms, definitions, symbols and abbreviated terms",
-              },
-            ],
+            val: ["./self::terms | .//terms"]
           },
       ].freeze
 
       def seqcheck(names, msg, accepted)
         n = names.shift
-        unless accepted.include? n
+        return [] if n.nil?
+        test = accepted.map { |a| n.at(a) }
+        if test.all? { |a| a.nil? }
           @log.add("Style", nil, msg)
-          names = []
         end
         names
       end
@@ -85,23 +75,21 @@ module Asciidoctor
       def sections_sequence_validate(root)
         return unless STANDARDTYPE.include?(
           root&.at("//bibdata/ext/doctype")&.text)
-        f = root.at("//sections").elements
-        names = f.map { |s| { tag: s.name, title: s&.at("./title")&.text } }
-        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) || return
-        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val]) || return
-        names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) || return
+        names = root.xpath("//sections/* | //bibliography/*")
+        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val])
+        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val])
+        names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val])
         n = names.shift
-        if !n.nil? && n[:tag] == "definitions"
+        if n&.at("./self::definitions")
           n = names.shift
         end
-        unless n
+        if n.nil? || n.name != "clause"
           @log.add("Style", nil, "Document must contain at least one clause")
           return
         end
         root.at("//references | //clause[descendant::references]"\
                 "[not(parent::clause)]") or
-        seqcheck([{tag: "clause"}],
-                 "Normative References are mandatory", [{tag: "references"}])
+        @log.add("Style", nil, "Normative References are mandatory")
       end
 
       def preface_sequence_validate(root)

data/lib/isodoc/ogc.rb

@@ -2,6 +2,8 @@ require "isodoc/ogc/metadata"
 require "isodoc/ogc/html_convert"
 require "isodoc/ogc/pdf_convert"
 require "isodoc/ogc/word_convert"
+require "isodoc/ogc/presentation_xml_convert"
+require "isodoc/ogc/xref"
 
 module IsoDoc
   module Ogc

data/lib/isodoc/ogc/base_convert.rb

@@ -1,5 +1,4 @@
 require "isodoc"
-require_relative "metadata"
 require_relative "reqt"
 require_relative "biblio"
 require_relative "sections"
@@ -8,10 +7,6 @@ require "fileutils"
 module IsoDoc
   module Ogc
     module BaseConvert
-      def fileloc(loc)
-        File.join(File.dirname(__FILE__), loc)
-      end
-
       def cleanup(docxml)
         requirement_table_cleanup(docxml)
         super
@@ -47,27 +42,6 @@ module IsoDoc
         docxml
       end
 
-      def load_yaml(lang, script)
-        y = if @i18nyaml then YAML.load_file(@i18nyaml)
-            else
-              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
-            end
-        super.merge(y)
-      end
-
-      def preface_names_numbered(clause)
-        return if clause.nil?
-        @prefacenum += 1
-        pref = RomanNumerals.to_roman(@prefacenum).downcase
-        @anchors[clause["id"]] =
-          { label: pref,
-            level: 1, xref: preface_clause_name(clause), type: "clause" }
-        clause.xpath(ns("./clause | ./terms | ./term | ./definitions | "\
-                        "./references")).each_with_index do |c, i|
-          section_names1(c, "#{pref}.#{i + 1}", 2)
-        end
-      end
-
       def example_parse(node, out)
         name = node.at(ns("./name"))
         example_name_parse(node, out, name) #if name
@@ -78,56 +52,14 @@ module IsoDoc
       end
 
       def example_name_parse(node, div, name)
-        lbl = anchor(node['id'], :label, false)
         div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
-          lbl.nil? or p << l10n("#{@example_lbl} #{lbl}")
-          name and !lbl.nil? and p << "&nbsp;&mdash; "
           name&.children&.each { |n| parse(n, p) }
         end
       end
 
-      def initial_anchor_names(d)
-        @prefacenum = 0
-        preface_names_numbered(d.at(ns("//preface/abstract")))
-        @prefacenum += 1 if d.at(ns("//keyword"))
-        preface_names_numbered(d.at(ns("//foreword")))
-        preface_names_numbered(d.at(ns("//introduction")))
-        @prefacenum += 1 if d.at(ns(SUBMITTINGORGS))
-        preface_names_numbered(d.at(ns("//submitters")))
-        d.xpath(ns("//preface/clause")).each do |c|
-          preface_names_numbered(c)
-        end
-        preface_names_numbered(d.at(ns("//acknowledgements")))
-        sequential_asset_names(d.xpath(ns(
-          "//preface/abstract | //foreword | //introduction | "\
-          "//submitters | //acknowledgements | //preface/clause")))
-        n = section_names(d.at(ns("//clause[title = 'Scope']")), 0, 1)
-        n = section_names(d.at(ns("//clause[title = 'Conformance']")), n, 1)
-        n = section_names(d.at(ns(
-          "//references[title = 'Normative References' or "\
-          "title = 'Normative references']")), n, 1)
-        n = section_names(
-          d.at(ns("//sections/terms | //sections/clause[descendant::terms]")),
-          n, 1)
-        n = section_names(d.at(ns("//sections/definitions")), n, 1)
-        middle_section_asset_names(d)
-        clause_names(d, n)
-        termnote_anchor_names(d)
-        termexample_anchor_names(d)
-      end
-
-      MIDDLE_CLAUSE =
-        "//clause[parent::sections][not(xmlns:title = 'Scope' or "\
-        "xmlns:title = 'Conformance')][not(descendant::terms)]".freeze
-
-      def middle_section_asset_names(d)
-        middle_sections = "//clause[title = 'Scope' or title = 'Conformance'] "\
-          "| //foreword | //introduction | //preface/abstract | "\
-          "//submitters | //acknowledgements | //preface/clause | "\
-          "//references[title = 'Normative References' or title = "\
-          "'Normative references'] | //sections/terms | "\
-          "//sections/definitions | //clause[parent::sections]"
-        sequential_asset_names(d.xpath(ns(middle_sections)))
+      def middle_clause
+        "//clause[parent::sections][not(@type = 'scope' or "\
+        "@type = 'conformance')][not(descendant::terms)]"
       end
 
       def middle(isoxml, out)

data/lib/isodoc/ogc/html/_coverpage.css

@@ -0,0 +1,195 @@
+.coverpage-maturity, .coverpage-stage {
+  font-family: {{headerfont}};
+  font-weight: 400;
+  font-size: 1.3em;
+  margin: 0 0 2em 0;
+  text-transform: uppercase; }
+
+.icon-svg {
+  width: 100%;
+  color: #5ecf86; }
+
+.wrapper-top {
+  background: #00335b;
+  background: linear-gradient(130deg, #00335b 45%, #f1f8ff 100%);
+  color: #ffffff;
+  padding: 5em 0;
+  width: 100%; }
+
+.wrapper-top-bottom {
+  width: 0;
+  height: 0;
+  border-top: 100px solid #00335b;
+  border-right: 100px solid transparent;
+  position: absolute; }
+
+.coverpage-metadata {
+  margin-top: 35px;
+  padding-top: 15px;
+  margin-right: 25px;
+  border-top: solid 1px white; }
+
+.coverpage-metadata,
+.coverpage-alt-formats {
+  font-size: 12px;
+  font-family: {{headerfont}};
+  margin-left: 1em;
+  text-align: left; }
+  .coverpage-metadata span,
+  .coverpage-alt-formats span {
+    display: block;
+    text-align: left; }
+    .coverpage-metadata span a,
+    .coverpage-alt-formats span a {
+      color: white; }
+      .coverpage-metadata span a:hover,
+      .coverpage-alt-formats span a:hover {
+        text-decoration: underline;
+        background: none;
+        box-shadow: none !important;
+        font-weight: 400; }
+  .coverpage-metadata .value,
+  .coverpage-alt-formats .value {
+    font-size: 15px;
+    margin-bottom: 15px; }
+  .coverpage-metadata .label,
+  .coverpage-alt-formats .label {
+    font-size: 12px;
+    padding: 0; }
+
+.coverpage-alt-formats span {
+  display: inline;
+  text-align: left; }
+  .coverpage-alt-formats span a {
+    padding-right: 5px; }
+
+.coverpage-title {
+  padding-bottom: 0.5em;
+  font-family: {{headerfont}};
+  font-weight: 100;
+  padding-left: 1em;
+  padding-right: 1em; }
+  .coverpage-title span {
+    font-family: {{headerfont}};
+    font-size: 1.8em;
+    line-height: 1; }
+
+.docstage-box table {
+  width: auto; }
+
+.docstage-box th {
+  background-color: #93c0d6; }
+
+.docstage-box td {
+  vertical-align: top;
+  background-color: #daeef3;
+  padding: 0.5em;
+  border: 0; }
+
+.docstage-box th:first-child {
+  border-radius: 1em 0 0 0; }
+
+.docstage-box th:last-child {
+  border-radius: 0 1em 0 0; }
+
+.docstage-box tr:first-child {
+  border-radius: 0 0 0 1em; }
+
+.docstage-box tr:last-child {
+  border-radius: 0 1em 0 0; }
+
+.docstage-box tr:last-child > td:first-child {
+  border-radius: 0 0 0 1em; }
+
+.docstage-box tr:last-child > td:last-child {
+  border-radius: 0 0 1em 0; }
+
+.WordSection11 {
+  padding: 0 2em 0 3em; }
+
+.info-section {
+  padding: 0 2em 0 5em; }
+
+.prefatory-section {
+  padding: 0 3em 0 6em; }
+
+.zzSTDTitle1, .MsoCommentText {
+  display: none; }
+
+.coverpage {
+  text-align: center;
+  padding-left: 1.5em; }
+
+.coverpage-logo span, .coverpage-tc-name span {
+  font-family: {{bodyfont}};
+  text-transform: none;
+  font-weight: 300;
+  margin-left: 1em; }
+
+.coverpage-tc-name {
+  font-size: 1.2em;
+  line-height: 1.2em;
+  margin: 0.25em 0; }
+
+.copyright {
+  padding: 1em;
+  font-size: 0.9em;
+  text-align: left; }
+
+/* Document Identity */
+.coverpage-doc-identity {
+  font-size: 2em;
+  line-height: 2em; }
+
+.coverpage-title .title-second {
+  display: none; }
+
+.coverpage-stage-block {
+  font-family: {{headerfont}};
+  font-weight: 600;
+  font-size: 1.25em;
+  margin: 2em 0em 2em 0em;
+  text-transform: uppercase; }
+
+.authors {
+  margin-top: 2em; }
+  .authors span {
+    display: block;
+    line-height: 2; }
+  .authors span.roletag {
+    display: inline-block;
+    font-size: 12px;
+    color: #00335b;
+    background-color: white;
+    padding: 2px 5px;
+    margin-left: 7px;
+    border-radius: 5px; }
+
+/* Draft Warning */
+.coverpage-warning {
+  border: #f36f36 solid 2px;
+  color: #f36f36 !important;
+  margin: 1em 2em;
+  color: #2e81c2;
+  padding: 2em 1em 1em 1em;
+  border-radius: 25px; }
+  .coverpage-warning h1 {
+    font-family: {{headerfont}};
+    font-weight: 300;
+    text-transform: uppercase;
+    font-size: 1.2em; }
+
+@media print {
+  .document-info, .copyright {
+    page-break-before: always; }
+  .coverpage {
+    height: 23cm; }
+  .info-section {
+    display: none; }
+  .wrapper-top {
+    top: 0;
+    padding-top: 4cm;
+    padding-bottom: 4cm; }
+  .wrapper-top-bottom {
+    margin-top: -5px;
+    display: none; } }