metanorma-standoc 1.4.2 → 1.5.2

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -76,6 +76,15 @@ module Asciidoctor
         end
       end
 
+      def termnote_example_cleanup(xmldoc)
+        xmldoc.xpath("//termnote[not(ancestor::term)]").each do |x|
+          x.name = "note"
+        end
+        xmldoc.xpath("//termexample[not(ancestor::term)]").each do |x|
+          x.name = "note"
+        end
+      end
+
       def termdef_cleanup(xmldoc)
         termdef_from_termbase(xmldoc)
         termdef_unnest_cleanup(xmldoc)
@@ -83,6 +92,7 @@ module Asciidoctor
         termdomain_cleanup(xmldoc)
         termdefinition_cleanup(xmldoc)
         termdomain1_cleanup(xmldoc)
+        termnote_example_cleanup(xmldoc)
         termdef_boilerplate_cleanup(xmldoc)
         termdef_subclause_cleanup(xmldoc)
         term_children_cleanup(xmldoc) 
@@ -100,8 +110,8 @@ module Asciidoctor
         end
         ret = Nokogiri::XML(key.to_xml)
         HTMLEntities.new.decode(ret.text).
-          gsub(/[\[\]\{\}<>\(\)]/, "").strip.
-          gsub(/[[:punct]]|[_^]/, ":\\0").gsub(/`/, "").
+          gsub(/[\[\]\{\}<>\(\)]/, "").gsub(/\s/m, "").
+          gsub(/[[:punct:]]|[_^]/, ":\\0").gsub(/`/, "").
           gsub(/[0-9]+/, "þ\\0")
       end
         

data/lib/asciidoctor/standoc/converter.rb

@@ -11,7 +11,6 @@ require "asciidoctor/standoc/table"
 require "asciidoctor/standoc/validate"
 require "asciidoctor/standoc/utils"
 require "asciidoctor/standoc/cleanup"
-require "asciidoctor/standoc/i18n"
 require "asciidoctor/standoc/reqt"
 require_relative "./macros.rb"
 require_relative "./log.rb"
@@ -21,6 +20,22 @@ module Asciidoctor
     # A {Converter} implementation that generates Standoc output, and a document
     # schema encapsulation of the document for validation
     class Converter
+      Asciidoctor::Extensions.register do
+        preprocessor Asciidoctor::Standoc::Datamodel::AttributesTablePreprocessor
+        preprocessor Asciidoctor::Standoc::Datamodel::DiagramPreprocessor
+        preprocessor Asciidoctor::Standoc::Yaml2TextPreprocessor
+        inline_macro Asciidoctor::Standoc::AltTermInlineMacro
+        inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
+        inline_macro Asciidoctor::Standoc::DomainTermInlineMacro
+        inline_macro Asciidoctor::Standoc::InheritInlineMacro
+        inline_macro Asciidoctor::Standoc::HTML5RubyMacro
+        inline_macro Asciidoctor::Standoc::ConceptInlineMacro
+        block Asciidoctor::Standoc::ToDoAdmonitionBlock
+        treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
+        block Asciidoctor::Standoc::PlantUMLBlockMacro
+        block Asciidoctor::Standoc::PseudocodeBlockMacro
+      end
+
       include ::Asciidoctor::Converter
       include ::Asciidoctor::Writer
 
@@ -32,7 +47,6 @@ module Asciidoctor
       include ::Asciidoctor::Standoc::Section
       include ::Asciidoctor::Standoc::Table
       include ::Asciidoctor::Standoc::Utils
-      include ::Asciidoctor::Standoc::I18n
       include ::Asciidoctor::Standoc::Cleanup
       include ::Asciidoctor::Standoc::Validate
 

data/lib/asciidoctor/standoc/front.rb

@@ -25,18 +25,6 @@ module Asciidoctor
         end
       end
 
-      def metadata_copyright(node, xml)
-        publishers = node.attr("publisher") || " "
-        publishers.split(/,[ ]?/).each do |p|
-          xml.copyright do |c|
-            c.from (node.attr("copyright-year") || Date.today.year)
-            p.match(/[A-Za-z]/).nil? or c.owner do |owner|
-              owner.organization { |o| organization(o, p) }
-            end
-          end
-        end
-      end
-
       def metadata_status(node, xml)
         xml.status do |s|
           s.stage ( node.attr("status") || node.attr("docstage") || "published" )

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -3,6 +3,7 @@ require "nokogiri"
 require "htmlentities"
 require "pathname"
 require "open-uri"
+require "csv"
 
 module Asciidoctor
   module Standoc
@@ -24,8 +25,15 @@ module Asciidoctor
         org.name orgname
       end
 
+      # , " => ," : CSV definition does not deal with space followed by quote
+      # at start of field
+      def csv_split(s, delim = ",")
+        CSV.parse_line(s&.gsub(/, "(?!")/, ',"'), liberal_parsing: true,
+                       col_sep: delim)&.map { |x| x.strip }
+      end
+
       def metadata_author(node, xml)
-        (node.attr("publisher") || "").split(/,[ ]?/).each do |p|
+        csv_split(node.attr("publisher") || default_publisher || "")&.each do |p|
           xml.contributor do |c|
             c.role **{ type: "author" }
             c.organization { |a| organization(a, p) }
@@ -85,15 +93,32 @@ module Asciidoctor
         end
       end
 
+      def default_publisher
+        nil
+      end
+
       def metadata_publisher(node, xml)
-        publishers = node.attr("publisher") || return
-        publishers.split(/,[ ]?/).each do |p|
+        publishers = node.attr("publisher") || default_publisher || return
+        csv_split(publishers)&.each do |p|
           xml.contributor do |c|
             c.role **{ type: "publisher" }
             c.organization { |a| organization(a, p) }
           end
         end
       end
+
+      def metadata_copyright(node, xml)
+        publishers = node.attr("copyright-holder") || node.attr("publisher") || 
+          default_publisher || "-"
+        csv_split(publishers)&.each do |p|
+          xml.copyright do |c|
+            c.from (node.attr("copyright-year") || Date.today.year)
+            p.match(/[A-Za-z]/).nil? or c.owner do |owner|
+              owner.organization { |o| organization(o, p) }
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/inline.rb

@@ -135,7 +135,7 @@ module Asciidoctor
         results.nil? and
           @log.add('Math', nil,
                    "latexmlmath failed to process equation:\n#{lxm_input}")
-        results
+        results&.sub(%r{<math ([^>]+ )?display="block"}, "<math \\1")
       end
 
       def stem_parse(text, xml, style)

data/lib/asciidoctor/standoc/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -922,6 +925,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +967,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +995,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1017,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1045,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1186,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>

data/lib/asciidoctor/standoc/log.rb

@@ -8,7 +8,8 @@ module Asciidoctor
       def add(category, loc, msg)
         return if @novalid
         @log[category] = [] unless @log[category]
-        @log[category] << { location: current_location(loc), message: msg }
+        @log[category] << { location: current_location(loc), message: msg,
+                            context: context(loc) }
         loc = loc.nil? ? "" : "(#{current_location(loc)}): "
         warn "#{category}: #{loc}#{msg}" 
       end
@@ -31,6 +32,13 @@ module Asciidoctor
         "??"
       end
 
+      def context(n)
+        return nil if n.is_a? String
+        n.respond_to?(:to_xml) and return n.to_xml
+        n.respond_to?(:to_s) and return n.to_s
+        nil
+      end
+
       def write(file)
         File.open(file, "w:UTF-8") do |f|
           f.puts "#{file} errors"
@@ -41,6 +49,7 @@ module Asciidoctor
             end.each do |n|
               loc = n[:location] ? "(#{n[:location]}): " : ""
               f.puts "#{loc}#{n[:message]}" 
+              n[:context]&.split(/\n/)&.first(5)&.each { |l| f.puts "\t#{l}" }
             end
           end
         end

data/lib/asciidoctor/standoc/ref.rb

@@ -61,10 +61,10 @@ module Asciidoctor
       end
 
       def isorefrender1(t, m, yr, allp = "")
-          t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
-          docid(t, m[:usrlbl]) if m[:usrlbl]
-          docid(t, id_and_year(m[:code], yr) + allp)
-          docnumber(t, m[:code])
+        t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
+        docid(t, m[:usrlbl]) if m[:usrlbl]
+        docid(t, id_and_year(m[:code], yr) + allp)
+        docnumber(t, m[:code])
       end
 
       def isorefmatches(xml, m)
@@ -106,15 +106,16 @@ module Asciidoctor
 
       def isorefmatches3(xml, m)
         yr = norm_year(m[:year])
-        hasyr =  m.names.include?("year") && yr != "--"
-        noyr =  m.names.include?("year") && yr == "--"
-        ref = fetch_ref xml, m[:code], hasyr ? yr : nil,
-          all_parts: true, no_year: noyr, text: m[:text], usrlbl: m[:usrlbl]
+        #hasyr =  m.names.include?("year") && yr != "--"
+        hasyr = !yr.nil? && yr != "--"
+        #noyr =  m.names.include?("year") && yr == "--"
+        ref = fetch_ref xml, m[:code], hasyr ? yr : nil, all_parts: true, 
+          no_year: yr == "--", text: m[:text], usrlbl: m[:usrlbl]
         return use_my_anchor(ref, m[:anchor]) if ref
 
         xml.bibitem(**attr_code(ref_attributes(m))) do |t|
           isorefrender1(t, m, yr, " (all parts)")
-          conditional_date(t, m, noyr)
+          conditional_date(t, m, yr == "--")
           iso_publisher(t, m[:code])
           m.names.include?("fn") && m[:fn] and
             t.note(**plaintxt.merge(type: "ISO DATE")) { |p| p << "#{m[:fn]}" }
@@ -150,32 +151,30 @@ module Asciidoctor
         "https://www.metanorma.com/author/iso/topics/markup/#bibliographies".freeze
 
       def analyse_ref_nofetch(ret)
-        if m = /^nofetch\((?<id>.+)\)$/.match(ret[:id])
-          ret[:id] = m[:id]
-          ret[:nofetch] = true
-        end
+        return ret unless m = /^nofetch\((?<id>.+)\)$/.match(ret[:id])
+        ret[:id] = m[:id]
+        ret[:nofetch] = true
         ret
       end
-     
+
       def analyse_ref_repo_path(ret)
-         if m = /^(?<type>repo|path):\((?<key>[^,]+),(?<id>.+)\)$/.match(ret[:id])
-          ret[:id] = m[:id]
-          ret[:type] = m[:type]
-          ret[:key] = m[:key]
-          ret[:nofetch] = true
-        end
-         ret
+        return ret unless m =
+          /^(?<type>repo|path):\((?<key>[^,]+),(?<id>.+)\)$/.match(ret[:id])
+        ret[:id] = m[:id]
+        ret[:type] = m[:type]
+        ret[:key] = m[:key]
+        ret[:nofetch] = true
+        ret
       end
 
       def analyse_ref_numeric(ret)
-        if /^\d+$/.match(ret[:id])
-          ret[:numeric] = true
-        end
+        return ret unless /^\d+$/.match(ret[:id])
+        ret[:numeric] = true
         ret
       end
 
       # ref id = (usrlbl)code[:-]year
-      # code = nofetch(code) | (repo|path):(key,code) | \[? number \]? | identifier
+      # code = nofetch(code) | (repo|path):(key,code) | \[? number \]? | ident
       def analyse_ref_code(code)
         ret = {id: code}
         return ret if code.nil? || code.empty?

data/lib/asciidoctor/standoc/section.rb

@@ -13,9 +13,13 @@ module Asciidoctor
         @term_def
       end
 
-      def sectiontype(node, level = true)
-        ret = node&.attr("heading")&.downcase ||
+      def sectiontype1(node)
+        node&.attr("heading")&.downcase ||
           node.title.gsub(/<[^>]+>/, "").downcase
+      end
+
+      def sectiontype(node, level = true)
+        ret = sectiontype1(node)
         ret1 = sectiontype_streamline(ret)
         return ret1 if "symbols and abbreviated terms" == ret1
         return nil unless !level || node.level == 1
@@ -61,16 +65,18 @@ module Asciidoctor
           case sectiontype(node)
           when "introduction" then introduction_parse(a, xml, node)
           when "foreword" then foreword_parse(a, xml, node)
+          when "scope" then scope_parse(a, xml, node)
           when "normative references" then norm_ref_parse(a, xml, node)
           when "terms and definitions"
             @term_def = true
             term_def_parse(a, xml, node, true)
             @term_def = false
           when "symbols and abbreviated terms"
-            symbols_parse(a, xml, node)
+            symbols_parse(symbols_attrs(node, a), xml, node)
           when "acknowledgements"
             acknowledgements_parse(a, xml, node)
-          when "bibliography" then bibliography_parse(a, xml, node)
+          when "bibliography" 
+            bibliography_parse(a, xml, node)
           else
             if @term_def then term_def_subclause_parse(a, xml, node)
             elsif @definitions then symbols_parse(a, xml, node)
@@ -106,7 +112,7 @@ module Asciidoctor
       def preamble(node)
         noko do |xml|
           xml.foreword **attr_code(section_attributes(node)) do |xml_abstract|
-            xml_abstract.title { |t| t << (node.blocks[0].title || "Foreword") }
+            xml_abstract.title { |t| t << (node.blocks[0].title || @i18n.foreword) }
             content = node.content
             xml_abstract << content
           end
@@ -119,6 +125,10 @@ module Asciidoctor
         end
       end
 
+      def scope_parse(attrs, xml, node)
+        clause_parse(attrs.merge(type: "scope"), xml, node)
+      end
+
       def clause_parse(attrs, xml, node)
         attrs["inline-header".to_sym] = node.option? "inline-header"
         attrs[:bibitem] = true if node.option? "bibitem"
@@ -140,9 +150,19 @@ module Asciidoctor
       end
 
       def nonterm_symbols_parse(attrs, xml, node)
+        defs = @definitions
         @definitions = false
         clause_parse(attrs, xml, node)
-        @definitions = true
+        @definitions = defs
+      end
+
+      def symbols_attrs(node, a)
+        case sectiontype1(node)
+        when "symbols" then a.merge(type: "symbols")
+        when "abbreviated terms", "abbreviations" then a.merge(type: "abbreviated_terms")
+        else
+          a
+        end
       end
 
       def symbols_parse(attr, xml, node)
@@ -159,13 +179,11 @@ module Asciidoctor
         end
       end
 
-      SYMBOLS_TITLES = ["symbols and abbreviated terms", "symbols",
-                        "abbreviated terms"].freeze
-
       def nonterm_term_def_subclause_parse(attrs, xml, node)
+        defs = @term_def
         @term_def = false
         clause_parse(attrs, xml, node)
-        @term_def = true
+        @term_def = defs
       end
 
       # subclause contains subclauses
@@ -190,23 +208,9 @@ module Asciidoctor
         end
       end
 
-      def term_def_title(toplevel, node)
-        return node.title unless toplevel
-        sub = node.find_by(context: :section) do |s|
-          SYMBOLS_TITLES.include? s.title.downcase
-        end
-        return "Terms and definitions" if sub.empty?
-        sym = /symbol/i.match(node.title)
-        abbrev = /abbreviat/i.match(node.title)
-        sym && abbrev and return "Terms, definitions, symbols and abbreviated terms"
-        sym and return "Terms, definitions and symbols"
-        abbrev and return "Terms, definitions and abbreviated terms"
-        "Terms, definitions, symbols and abbreviated terms"
-      end
-
       def term_def_parse(attrs, xml, node, toplevel)
         xml.terms **attr_code(attrs) do |section|
-          section.title { |t| t << term_def_title(toplevel, node) }
+          section.title { |t| t << node.title }
           (s = node.attr("source")) && s.split(/,/).each do |s1|
             section.termdocsource(nil, **attr_code(bibitemid: s1))
           end
@@ -216,7 +220,7 @@ module Asciidoctor
 
       def introduction_parse(attrs, xml, node)
         xml.introduction **attr_code(attrs) do |xml_section|
-          xml_section.title { |t| t << "Introduction" }
+          xml_section.title { |t| t << @i18n.introduction }
           content = node.content
           xml_section << content
         end
@@ -232,7 +236,7 @@ module Asciidoctor
 
       def acknowledgements_parse(attrs, xml, node)
         xml.acknowledgements **attr_code(attrs) do |xml_section|
-          xml_section.title { |t| t << node.title || "Acknowledgements" }
+          xml_section.title { |t| t << node.title || @i18n.acknowledgements }
           content = node.content
           xml_section << content
         end