metanorma-itu 1.0.11 → 1.0.16

data/lib/asciidoctor/itu/cleanup.rb

@@ -3,9 +3,6 @@ module Asciidoctor
     class Converter < Standoc::Converter
       def sections_cleanup(x)
         super
-        x.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
-        end
         insert_missing_sections(x) unless @no_insert_missing_sections
       end
 
@@ -30,7 +27,7 @@ module Asciidoctor
           x.at("./*/preface | ./*/boilerplate | ./*/bibdata").next =
           "<sections><sentinel/></sections>"
         x.at("./*/sections/*") or x.at("./*/sections") << "<sentinel/>"
-        ins = x.at("//sections").children.first
+        ins = x.at("//sections").elements.first
         unless x.at("//sections/clause/title[text() = 'Scope']")
           ins.previous = "<clause><title>Scope</title><p>"\
             "#{@labels['clause_empty']}</p></clause>"
@@ -39,73 +36,81 @@ module Asciidoctor
       end
 
       def insert_norm_ref(x)
-        x.at("//bibliography") or x.at("./*/annex[last()] | ./*/sections").next =
+        x.at("//bibliography") or
+          x.at("./*/annex[last()] | ./*/sections").next =
           "<bibliography><sentinel/></bibliography>"
-        ins = x.at("//bibliography").children.first
-        unless x.at("//bibliography/references/title[text() = 'References']")
-          ins.previous = "<references><title>References</title><p>"\
-            "#{@labels['clause_empty']}</p></references>"
+        ins = x.at("//bibliography").elements.first
+        unless x.at("//bibliography/references[@normative = 'true']")
+          #ins.previous = "<references normative='true'><title>References</title><p>"\
+          #  "#{@labels['clause_empty']}</p></references>"
+          ins.previous = "<references normative='true'><title>References</title>"\
+            "</references>"
         end
         x&.at("//sentinel")&.remove
       end
 
       def insert_terms(x)
-        ins =  x.at("//sections/clause/title[text() = 'Scope']")
-        unless x.at("//sections/terms")
+        ins =  x.at("//sections/clause/title[text() = 'Scope']/..")
+        unless x.at("//sections//terms")
           ins.next = "<terms><title>Definitions</title><p>"\
             "#{@labels['clause_empty']}</p></terms>"
         end
       end
 
       def insert_symbols(x)
-        ins =  x.at("//terms")
+        ins =  x.at("//sections/terms") ||
+          x.at("//sections/clause[descendant::terms]")
         unless x.at("//sections//definitions")
-          ins.next = "<definitions><title>Definitions</title><p>"\
+          ins.next = "<definitions><title>Abbreviations and acronyms</title><p>"\
             "#{@labels['clause_empty']}</p></definitions>"
         end
       end
 
       def insert_conventions(x)
-        ins =  x.at("//sections//definitions")
+        ins =  x.at("//sections//definitions") ||
+          x.at("//sections/clause[descendant::definitions]")
         unless x.at("//sections/clause/title[text() = 'Conventions']")
-          ins.next = "<clause><title>Conventions</title><p>"\
-            "#{@labels['clause_empty']}</p></clause>"
-        end
-      end
+          ins.next = "<clause id='_#{UUIDTools::UUID.random_create}'>"\
+          "<title>Conventions</title><p>"\
+          "#{@labels['clause_empty']}</p></clause>"
+          end
+          end
 
-      def cleanup(xmldoc)
-        symbols_cleanup(xmldoc)
-        super
-      end
+          def cleanup(xmldoc)
+          symbols_cleanup(xmldoc)
+          super
+          obligations_cleanup(xmldoc)
+          xmldoc
+          end
 
-      def smartquotes_cleanup(xmldoc)
-        return super if @smartquotes
-        xmldoc.traverse do |n|
+          def smartquotes_cleanup(xmldoc)
+          return super if @smartquotes
+          xmldoc.traverse do |n|
           next unless n.text?
           n.replace(HTMLEntities.new.encode(
             n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'").
             gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic))
-        end
-        xmldoc
-      end
+          end
+          xmldoc
+          end
 
-      def termdef_cleanup(xmldoc)
-        xmldoc.xpath("//term/preferred").each do |p|
+          def termdef_cleanup(xmldoc)
+          xmldoc.xpath("//term/preferred").each do |p|
           if ["terms defined elsewhere",
-              "terms defined in this recommendation"].include? p.text.downcase
-            p.name = "title"
-            p.parent.name = "terms"
+          "terms defined in this recommendation"].include? p.text.downcase
+          p.name = "title"
+          p.parent.name = "terms"
+          end
+          end
+          super
           end
-        end
-        super
-      end
 
-      def termdef_boilerplate_cleanup(xmldoc)
-      end
+          def termdef_boilerplate_cleanup(xmldoc)
+          end
 
-      def symbols_cleanup(xmldoc)
-        sym = xmldoc.at("//definitions/title")
-        sym and sym&.next_element&.name == "dl" and
+          def symbols_cleanup(xmldoc)
+          sym = xmldoc.at("//definitions/title")
+          sym and sym&.next_element&.name == "dl" and
           sym.next = "<p>#{@symbols_boilerplate}</p>"
       end
 
@@ -113,48 +118,55 @@ module Asciidoctor
 
       def pub_class(bib)
         return 1 if bib.at("#{PUBLISHER}[abbreviation = 'ITU']")
-        return 1 if bib.at("#{PUBLISHER}[name = 'International "\
-                           "Telecommunication Union']")
-        return 2 if bib.at("#{PUBLISHER}[abbreviation = 'ISO']")
-        return 2 if bib.at("#{PUBLISHER}[name = 'International Organization "\
-                           "for Standardization']")
-        return 3 if bib.at("#{PUBLISHER}[abbreviation = 'IEC']")
-        return 3 if bib.at("#{PUBLISHER}[name = 'International "\
-                           "Electrotechnical Commission']")
-        return 4 if bib.at("./docidentifier[@type][not(@type = 'DOI' or "\
-                           "@type = 'metanorma' or @type = 'ISSN' or @type = "\
-                           "'ISBN')]")
-        5
-      end
+          return 1 if bib.at("#{PUBLISHER}[name = 'International "\
+                             "Telecommunication Union']")
+          return 2 if bib.at("#{PUBLISHER}[abbreviation = 'ISO']")
+          return 2 if bib.at("#{PUBLISHER}[name = 'International Organization "\
+                             "for Standardization']")
+          return 3 if bib.at("#{PUBLISHER}[abbreviation = 'IEC']")
+          return 3 if bib.at("#{PUBLISHER}[name = 'International "\
+                             "Electrotechnical Commission']")
+          return 4 if bib.at("./docidentifier[@type][not(@type = 'DOI' or "\
+                             "@type = 'metanorma' or @type = 'ISSN' or @type = "\
+                             "'ISBN')]")
+          5
+        end
 
-      def sort_biblio(bib)
-        bib.sort do |a, b|
-          sort_biblio_key(a) <=> sort_biblio_key(b)
+        def sort_biblio(bib)
+          bib.sort do |a, b|
+            sort_biblio_key(a) <=> sort_biblio_key(b)
+          end
         end
-      end
 
-      # sort by: doc class (ITU, ISO, IEC, other standard (not DOI &c), other
-      # then standard class (docid class other than DOI &c)
-      # then alphanumeric doc id (not DOI &c)
-      # then title
-      def sort_biblio_key(bib)
-        pubclass = pub_class(bib)
-        num = bib&.at("./docnumber")&.text
-        id = bib&.at("./docidentifier[not(@type = 'DOI' or @type = "\
-                     "'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
-        metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
-        abbrid = metaid unless /^\[\d+\]$/.match(metaid)
-        type = id['type'] if id
-        title = bib&.at("./title[@type = 'main']")&.text ||
-          bib&.at("./title")&.text || bib&.at("./formattedref")&.text
-        "#{pubclass} :: #{type} :: #{id&.text || metaid} :: #{title}"
-      end
+        # sort by: doc class (ITU, ISO, IEC, other standard (not DOI &c), other
+        # then standard class (docid class other than DOI &c)
+        # then alphanumeric doc id (not DOI &c)
+        # then title
+        def sort_biblio_key(bib)
+          pubclass = pub_class(bib)
+          num = bib&.at("./docnumber")&.text
+          id = bib&.at("./docidentifier[not(@type = 'DOI' or @type = "\
+                       "'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
+          metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
+          abbrid = metaid unless /^\[\d+\]$/.match(metaid)
+          type = id['type'] if id
+          title = bib&.at("./title[@type = 'main']")&.text ||
+            bib&.at("./title")&.text || bib&.at("./formattedref")&.text
+          "#{pubclass} :: #{type} :: #{id&.text || metaid} :: #{title}"
+        end
+
+        def biblio_reorder(xmldoc)
+          xmldoc.xpath("//references").each do |r|
+            biblio_reorder1(r)
+          end
+        end
 
-      def biblio_reorder(xmldoc)
-        xmldoc.xpath("//references").each do |r|
-          biblio_reorder1(r)
+        def normref_cleanup(xmldoc)
+          super
+          r = xmldoc.at(NORM_REF) || return
+          title = r.at("./title") and
+            title.content = "References"
         end
       end
     end
   end
-end

data/lib/asciidoctor/itu/converter.rb

@@ -65,7 +65,7 @@ module Asciidoctor
           word_converter(node).convert filename unless node.attr("nodoc")
           pdf_converter(node).convert filename unless node.attr("nodoc")
         end
-        @log.write(@filename + ".err") unless @novalid
+        @log.write(@localdir + @filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
         ret
       end
@@ -90,15 +90,6 @@ module Asciidoctor
         end
       end
 
-      def norm_ref_parse(attrs, xml, node)
-        @norm_ref = true
-        xml.references **attr_code(attrs) do |xml_section|
-          xml_section.title { |t| t << "References" }
-          xml_section << node.content
-        end
-        @norm_ref = false
-      end
-
       def term_def_title(toplevel, node)
         return node.title unless toplevel
         "Definitions"
@@ -131,8 +122,6 @@ module Asciidoctor
           div.next = "<p>#{@term_def_boilerplate}</p>"
       end
 
-      NORM_REF = "//bibliography/references[title = 'References']".freeze
-
       def load_yaml(lang, script)
         y = if @i18nyaml then YAML.load_file(@i18nyaml)
             elsif lang == "en"
@@ -148,6 +137,13 @@ module Asciidoctor
         super
       end
 
+       def metadata_keywords(node, xml)
+        return unless node.attr("keywords")
+        node.attr("keywords").split(/,[ ]*/).sort.each_with_index do |kw, i|
+          xml.keyword (i == 0 ? kw.capitalize : kw)
+        end
+      end
+
       def html_extract_attributes(node)
         super.merge(hierarchical_assets: node.attr("hierarchical-object-numbering"))
       end

data/lib/asciidoctor/itu/front.rb

@@ -4,36 +4,63 @@ require "fileutils"
 
 module Asciidoctor
   module ITU
-
-    # A {Converter} implementation that generates RSD output, and a document
-    # schema encapsulation of the document for validation
-    #
     class Converter < Standoc::Converter
       def metadata_status(node, xml)
         xml.status do |s|
           s.stage (node.attributes.has_key?("draft") ? "draft" :
-                   (node.attr("status") || node.attr("docstage") || "published" ))
+                   (node.attr("status") || node.attr("docstage") ||
+                    "published" ))
         end
       end
 
       def title_english(node, xml)
-        ["en"].each do |lang|
-          at = { language: lang, format: "text/plain", type: "main" }
-          a = node.attr("title") || node.attr("title-en") || node.title
-          xml.title Asciidoctor::Standoc::Utils::asciidoc_sub(a), **attr_code(at)
-          if a = node.attr("annextitle") || node.attr("annextitle-en")
-            at[:type] = "annex"
-            xml.title Asciidoctor::Standoc::Utils::asciidoc_sub(a), **attr_code(at)
+        at = { language: "en", format: "text/plain", type: "main" }
+        a = node.attr("title") || node.attr("title-en")
+        xml.title **attr_code(at) do |t|
+          t << (Asciidoctor::Standoc::Utils::asciidoc_sub(a) || node.title)
+        end
+        if a = node.attr("annextitle") || node.attr("annextitle-en")
+          at[:type] = "annex"
+          xml.title **attr_code(at) do |t|
+            t << Asciidoctor::Standoc::Utils::asciidoc_sub(a)
           end
         end
       end
 
       def title_otherlangs(node, xml)
         node.attributes.each do |k, v|
-          next unless /^(annex)?title-(?<titlelang>.+)$/ =~ k
-          next if titlelang == "en"
-          xml.title v, { language: titlelang, format: "text/plain",
-                         type: /^annex/.match(k) ? "annex" : "main" }
+          next unless /^(annex)?title-(?<lang>.+)$/ =~ k
+          next if lang == "en"
+          type = /^annex/.match(k) ? "annex" : "main"
+          xml.title **attr_code(language: lang, format: "text/plain",
+                                type: type) do |t|
+            t << v
+          end
+        end
+      end
+
+      def title(node, xml)
+        super
+        subtitle_english(node, xml)
+        subtitle_otherlangs(node, xml)
+      end
+
+      def subtitle_english(node, xml)
+        at = { language: "en", format: "text/plain", type: "subtitle" }
+        a = node.attr("subtitle") || node.attr("subtitle-en")
+        xml.title **attr_code(at) do |t|
+          t << Asciidoctor::Standoc::Utils::asciidoc_sub(a)
+        end
+      end
+
+      def subtitle_otherlangs(node, xml)
+        node.attributes.each do |k, v|
+          next unless /^subtitle-(?<lang>.+)$/ =~ k
+          next if lang == "en"
+          xml.title **attr_code(language: lang, format: "text/plain",
+                                type: "subtitle") do |t|
+            t << v
+          end
         end
       end
 
@@ -89,11 +116,13 @@ module Asciidoctor
 
       def metadata_committee2(node, g, suffix, prefix)
         g.name node.attr("#{prefix}group#{suffix}")
-        g.acronym node.attr("#{prefix}groupacronym#{suffix}") if node.attr("#{prefix}groupacronym#{suffix}")
+        node.attr("#{prefix}groupacronym#{suffix}") and
+          g.acronym node.attr("#{prefix}groupacronym#{suffix}")
         if node.attr("#{prefix}groupyearstart#{suffix}")
           g.period do |p|
             p.start node.attr("#{prefix}groupyearstart#{suffix}")
-            p.end node.attr("#{prefix}groupyearend#{suffix}") if node.attr("#{prefix}groupacronym#{suffix}")
+            node.attr("#{prefix}groupacronym#{suffix}") and
+              p.end node.attr("#{prefix}groupyearend#{suffix}")
           end
         end
       end

data/lib/asciidoctor/itu/isodoc.rng

@@ -101,9 +101,7 @@
         <ref name="structuredidentifier"/>
       </zeroOrMore>
     </define>
-    <define name="TitleType">
-      <text/>
-    </define>
+    <!-- TitleType = text -->
     <define name="sections">
       <element name="sections">
         <oneOrMore>
@@ -131,6 +129,9 @@
             </choice>
           </attribute>
         </optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
         <optional>
           <ref name="section-title"/>
         </optional>
@@ -307,6 +308,21 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="TextElement" combine="choice">
+    <ref name="concept"/>
+  </define>
+  <define name="concept">
+    <element name="concept">
+      <optional>
+        <attribute name="term"/>
+      </optional>
+      <choice>
+        <ref name="eref"/>
+        <ref name="xref"/>
+        <ref name="termref"/>
+      </choice>
+    </element>
+  </define>
   <define name="BasicBlock" combine="choice">
     <choice>
       <ref name="requirement"/>
@@ -913,7 +929,10 @@
   </define>
   <define name="origin">
     <element name="origin">
-      <ref name="erefType"/>
+      <choice>
+        <ref name="erefType"/>
+        <ref name="termref"/>
+      </choice>
     </element>
   </define>
   <define name="modification">
@@ -921,6 +940,15 @@
       <ref name="paragraph"/>
     </element>
   </define>
+  <define name="termref">
+    <element name="termref">
+      <attribute name="base"/>
+      <attribute name="target"/>
+      <optional>
+        <text/>
+      </optional>
+    </element>
+  </define>
   <define name="structuredidentifier">
     <element name="structuredidentifier">
       <optional>

data/lib/asciidoctor/itu/validate.rb

@@ -45,7 +45,7 @@ module Asciidoctor
       def extract_text(node)
         return "" if node.nil?
         node1 = Nokogiri::XML.fragment(node.to_s)
-        node1.xpath("//link | //locality").each(&:remove)
+        node1.xpath("//link | //locality | //localityStack").each(&:remove)
         ret = ""
         node1.traverse { |x| ret += x.text if x.text? }
         ret