metanorma-standoc 1.6.1 → 1.7.0

data/lib/asciidoctor/standoc/lists.rb

@@ -55,7 +55,7 @@ module Asciidoctor
 
       def ol_attrs(node)
         attr_code(keep_attrs(node).merge(id: Utils::anchor_or_uuid(node),
-                  type: olist_style(node.style)))
+                                         type: olist_style(node.style)))
       end
 
       def olist(node)
@@ -87,7 +87,9 @@ module Asciidoctor
       end
 
       def dl_attrs(node)
-        attr_code(id_attr(node).merge(keep_attrs(node)))
+        attr_code(keep_attrs(node).
+                  merge(id: Utils::anchor_or_uuid(node),
+                        key: node.option?("key") ? "true" : nil))
       end
 
       def dlist(node)

data/lib/asciidoctor/standoc/macros.rb

@@ -3,87 +3,57 @@ require "fileutils"
 require "uuidtools"
 require "yaml"
 require_relative "./macros_plantuml.rb"
+require_relative "./macros_terms.rb"
 require_relative "./datamodel/attributes_table_preprocessor.rb"
 require_relative "./datamodel/diagram_preprocessor.rb"
 require "metanorma-plugin-datastruct"
+require "metanorma-plugin-lutaml"
 
 module Asciidoctor
   module Standoc
-    class AltTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+    class InheritInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
-      named :alt
+      named :inherit
       parse_content_as :text
       using_format :short
 
       def process(parent, _target, attrs)
         out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<admitted>#{out}</admitted>}
+        %{<inherit>#{out}</inherit>}
       end
     end
 
-    class DeprecatedTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+    class IndexXrefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
-      named :deprecated
-      parse_content_as :text
-      using_format :short
+      named :index
 
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<deprecates>#{out}</deprecates>}
+      def preprocess_attrs(attrs)
+        return unless attrs.size > 1 && attrs.size < 5
+        ret = { primary: attrs[1], target: attrs[attrs.size] }
+        ret[:secondary] = attrs[2] if attrs.size > 2
+        ret[:tertiary] = attrs[3] if attrs.size > 3
+        ret
       end
-    end
-
-    class DomainTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :domain
-      parse_content_as :text
-      using_format :short
 
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<domain>#{out}</domain>}
+      def process(_parent, target, attr)
+        args = preprocess_attrs(attr) or return
+        ret = "<index-xref also='#{target == 'also'}'><primary>#{args[:primary]}</primary>"
+        ret += "<secondary>#{args[:secondary]}</secondary>" if args[:secondary]
+        ret += "<tertiary>#{args[:tertiary]}</tertiary>" if args[:tertiary]
+        ret + "<target>#{args[:target]}</target></index-xref>"
       end
     end
 
-    class InheritInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+    class IndexRangeInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
-      named :inherit
+      named "index-range".to_sym
       parse_content_as :text
-      using_format :short
-
-      def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<inherit>#{out}</inherit>}
-      end
-    end
-
-    class ConceptInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
-      use_dsl
-      named :concept
-      name_positional_attributes "id", "word", "term"
-      # match %r{concept:(?<target>[^\[]*)\[(?<content>|.*?[^\\])\]$}
-      match /\{\{(?<content>|.*?[^\\])\}\}/
-      using_format :short
-
-      # deal with locality attrs and their disruption of positional attrs
-      def preprocess_attrs(attrs)
-        attrs.delete("term") if attrs["term"] && !attrs["word"]
-        attrs.delete(3) if attrs[3] == attrs["term"]
-        a = attrs.keys.reject { |k| k.is_a?(String) || [1, 2].include?(k) }
-        attrs["word"] ||= attrs[a[0]] if !a.empty?
-        attrs["term"] ||= attrs[a[1]] if a.length > 1
-        attrs
-      end
 
-      def process(parent, _target, attr)
-        attr = preprocess_attrs(attr)
-        localities = attr.keys.reject { |k| %w(id word term).include? k }.
-          reject { |k| k.is_a? Numeric }.
-          map { |k| "#{k}=#{attr[k]}" }.join(",")
-        text = [localities, attr["word"]].reject{ |k| k.nil? || k.empty? }.
-          join(",")
-        out = Asciidoctor::Inline.new(parent, :quoted, text).convert
-        %{<concept key="#{attr['id']}" term="#{attr['term']}">#{out}</concept>}
+      def process(parent, target, attr)
+        text = attr["text"]
+        text = "((#{text}))" unless /^\(\(.+\)\)$/.match(text)
+        out = parent.sub_macros(text)
+        out.sub(/<index>/, "<index to='#{target}'>")
       end
     end
 
@@ -134,7 +104,7 @@ module Asciidoctor
         if (attributes.size == 1) && attributes.key?("text")
           rt = attributes["text"]
         elsif (attributes.size == 2) && attributes.key?(1) &&
-            attributes.key?("rpbegin")
+          attributes.key?("rpbegin")
           # for example, html5ruby:楽聖少女[がくせいしょうじょ]
           rt = attributes[1] || ""
         else
@@ -157,7 +127,7 @@ module Asciidoctor
         attrs["name"] = "todo"
         attrs["caption"] = "TODO"
         create_block parent, :admonition, reader.lines, attrs,
-                     content_model: :compound
+          content_model: :compound
       end
     end
 
@@ -170,7 +140,7 @@ module Asciidoctor
           para.set_attr("caption", "TODO")
           para.lines[0].sub!(/^TODO: /, "")
           todo = Block.new parent, :admonition, attributes: para.attributes,
-                                                source: para.lines, content_model: :compound
+            source: para.lines, content_model: :compound
           parent.blocks[parent.blocks.index(para)] = todo
         end
       end
@@ -186,5 +156,31 @@ module Asciidoctor
         %{<autonumber type=#{target}>#{out}</autonumber>}
       end
     end
+
+    class VariantInlineMacro < Extensions::InlineMacroProcessor
+      use_dsl
+      named :lang
+      parse_content_as :text
+
+      def process(parent, target, attrs)
+        /^(?<lang>[^-]*)(-(?<script>.*))?$/ =~ target
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        script ?
+          %{<variant lang=#{lang} script=#{script}>#{out}</variant>} :
+          %{<variant lang=#{lang}>#{out}</variant>}
+      end
+    end
+
+    class FootnoteBlockInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :footnoteblock
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<footnoteblock>#{out}</footnoteblock>}
+      end
+    end
   end
 end

data/lib/asciidoctor/standoc/macros_terms.rb

@@ -0,0 +1,82 @@
+module Asciidoctor
+  module Standoc
+    class AltTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :alt
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<admitted>#{out}</admitted>}
+      end
+    end
+
+    class DeprecatedTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :deprecated
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<deprecates>#{out}</deprecates>}
+      end
+    end
+
+    class DomainTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :domain
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<domain>#{out}</domain>}
+      end
+    end
+
+     # Macro to transform `term[X,Y]` into em, termxref xml
+    class TermRefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :term
+      name_positional_attributes 'name', 'termxref'
+      using_format :short
+
+      def process(_parent, _target, attrs)
+        termref = attrs['termxref'] || attrs['name']
+        "<em>#{attrs['name']}</em> (<termxref>#{termref}</termxref>)"
+      end
+    end
+
+    class ConceptInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :concept
+      name_positional_attributes "id", "word", "term"
+      # match %r{concept:(?<target>[^\[]*)\[(?<content>|.*?[^\\])\]$}
+      match /\{\{(?<content>|.*?[^\\])\}\}/
+      using_format :short
+
+      # deal with locality attrs and their disruption of positional attrs
+      def preprocess_attrs(attrs)
+        attrs.delete("term") if attrs["term"] && !attrs["word"]
+        attrs.delete(3) if attrs[3] == attrs["term"]
+        a = attrs.keys.reject { |k| k.is_a?(String) || [1, 2].include?(k) }
+        attrs["word"] ||= attrs[a[0]] if !a.empty?
+        attrs["term"] ||= attrs[a[1]] if a.length > 1
+        attrs
+      end
+
+      def process(parent, _target, attr)
+        attr = preprocess_attrs(attr)
+        localities = attr.keys.reject { |k| %w(id word term).include? k }.
+          reject { |k| k.is_a? Numeric }.
+          map { |k| "#{k}=#{attr[k]}" }.join(",")
+        text = [localities, attr["word"]].reject{ |k| k.nil? || k.empty? }.
+          join(",")
+        out = Asciidoctor::Inline.new(parent, :quoted, text).convert
+        %{<concept key="#{attr['id']}" term="#{attr['term']}">#{out}</concept>}
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/ref.rb

@@ -1,6 +1,6 @@
 module Asciidoctor
   module Standoc
-    module Lists
+    module Refs
       def iso_publisher(t, code)
         code.sub(/ .*$/, "").split(/\//).each do |abbrev|
           t.contributor do |c|
@@ -56,7 +56,9 @@ module Asciidoctor
       end
 
       def norm_year(yr)
-        /^\&\#821[12];$/.match(yr) ? "--" : yr
+        /^\&\#821[12];$/.match(yr) and return "--" 
+        /^\d\d\d\d-\d\d\d\d$/.match(yr) and return yr
+        yr&.sub(/(?<=[0-9])-.*$/, "")
       end
 
       def isorefrender1(t, m, yr, allp = "")
@@ -68,8 +70,7 @@ module Asciidoctor
 
       def isorefmatches(xml, m)
         yr = norm_year(m[:year])
-        ref = fetch_ref xml, m[:code], yr, title: m[:text], usrlbl: m[:usrlbl],
-          lang: (@lang || :all)
+        ref = fetch_ref xml, m[:code], yr, title: m[:text], usrlbl: m[:usrlbl], lang: (@lang || :all)
         return use_my_anchor(ref, m[:anchor]) if ref
         xml.bibitem **attr_code(ref_attributes(m)) do |t|
           isorefrender1(t, m, yr)
@@ -94,7 +95,7 @@ module Asciidoctor
             d.on "--"
           end
           iso_publisher(t, m[:code])
-          m[:fn].nil? or t.note(**plaintxt.merge(type: "ISO DATE")) do |p|
+          m[:fn].nil? or t.note(**plaintxt.merge(type: "Unpublished-Status")) do |p|
             p << "#{m[:fn]}"
           end
         end
@@ -103,8 +104,7 @@ module Asciidoctor
       def conditional_date(t, m, noyr)
         m.names.include?("year") and !m[:year].nil? and
           t.date(**{ type: "published" }) do |d|
-          noyr and d.on "--" or
-            set_date_range(d, norm_year(m[:year]))
+          noyr and d.on "--" or set_date_range(d, norm_year(m[:year]))
         end
       end
 
@@ -112,8 +112,7 @@ module Asciidoctor
         yr = norm_year(m[:year])
         hasyr = !yr.nil? && yr != "--"
         ref = fetch_ref xml, m[:code], hasyr ? yr : nil, all_parts: true, 
-          no_year: yr == "--", text: m[:text], usrlbl: m[:usrlbl],
-          lang: (@lang || :all)
+          no_year: yr == "--", text: m[:text], usrlbl: m[:usrlbl], lang: (@lang || :all)
         return use_my_anchor(ref, m[:anchor]) if ref
         isorefmatches3_1(xml, m, yr, hasyr, ref)
       end
@@ -124,7 +123,7 @@ module Asciidoctor
           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]}" }
+            t.note(**plaintxt.merge(type: "Unpublished-Status")) { |p| p << "#{m[:fn]}" }
           t.extent **{ type: 'part' } do |e|
             e.referenceFrom "all"
           end
@@ -138,8 +137,7 @@ module Asciidoctor
         end
         docid(t, m[:usrlbl]) if m[:usrlbl]
         docid(t, /^\d+$/.match(code[:id]) ? "[#{code[:id]}]" : code[:id])
-        code[:type] == "repo" and
-          t.docidentifier code[:key], **{ type: "repository" }
+        code[:type] == "repo" and t.docidentifier code[:key], **{ type: "repository" }
       end
 
       def refitem_render(xml, m, code)
@@ -153,9 +151,8 @@ module Asciidoctor
       end
 
       MALFORMED_REF = "no anchor on reference, markup may be malformed: see "\
-        "https://www.metanorma.com/author/topics/document-format/"\
-        "bibliography/ , https://www.metanorma.com/author/iso/topics/markup/"\
-        "#bibliographies".freeze
+        "https://www.metanorma.com/author/topics/document-format/bibliography/ , "\
+        "https://www.metanorma.com/author/iso/topics/markup/#bibliographies".freeze
 
       def analyse_ref_nofetch(ret)
         return ret unless m = /^nofetch\((?<id>.+)\)$/.match(ret[:id])
@@ -163,9 +160,9 @@ module Asciidoctor
       end
 
       def analyse_ref_repo_path(ret)
-        return ret unless m =
-          /^(?<type>repo|path):\((?<key>[^,]+),(?<id>.+)\)$/.match(ret[:id])
-        ret.merge(id: m[:id], type: m[:type], key: m[:key], nofetch: true)
+        return ret unless m = /^(?<type>repo|path):\((?<key>[^,]+),?(?<id>.*)\)$/.match(ret[:id])
+        id = m[:id].empty? ? m[:key].sub(%r{^[^/]+/}, "") : m[:id]
+        ret.merge(id: id, type: m[:type], key: m[:key], nofetch: true)
       end
 
       def analyse_ref_numeric(ret)
@@ -191,8 +188,7 @@ module Asciidoctor
       def refitem1(xml, item, m)
         code = analyse_ref_code(m[:code])
         unless code[:id] && code[:numeric] || code[:nofetch]
-          ref = fetch_ref xml, code[:id],
-            m.names.include?("year") ? m[:year] : nil, title: m[:text],
+          ref = fetch_ref xml, code[:id], m.names.include?("year") ? m[:year] : nil, title: m[:text],
             usrlbl: m[:usrlbl], lang: (@lang || :all)
           return use_my_anchor(ref, m[:anchor]) if ref
         end
@@ -209,8 +205,7 @@ module Asciidoctor
 
       ISO_REF = %r{^<ref\sid="(?<anchor>[^"]+)">
       \[(?<usrlbl>\([^)]+\))?(?<code>(ISO|IEC)[^0-9]*\s[0-9-]+|IEV)
-      (:(?<year>[0-9][0-9-]+))?\]</ref>,?\s*
-        (?<text>.*)$}xm
+      (:(?<year>[0-9][0-9-]+))?\]</ref>,?\s*(?<text>.*)$}xm
 
         ISO_REF_NO_YEAR = %r{^<ref\sid="(?<anchor>[^"]+)">
       \[(?<usrlbl>\([^)]+\))?(?<code>(ISO|IEC)[^0-9]*\s[0-9-]+):
@@ -225,7 +220,7 @@ module Asciidoctor
 
           NON_ISO_REF = %r{^<ref\sid="(?<anchor>[^"]+)">
         \[(?<usrlbl>\([^)]+\))?(?<code>[^\]]+?)
-        ([:-](?<year>(19|20)[0-9][0-9]))?\]</ref>,?\s*(?<text>.*)$}xm
+        ([:-](?<year>(19|20)[0-9][0-9][0-9-]*))?\]</ref>,?\s*(?<text>.*)$}xm
 
         def reference1_matches(item)
           matched = ISO_REF.match item
@@ -236,8 +231,7 @@ module Asciidoctor
 
         def reference1(node, item, xml)
           matched, matched2, matched3 = reference1_matches(item)
-          if matched3.nil? && matched2.nil? && matched.nil?
-            refitem(xml, item, node)
+          if matched3.nil? && matched2.nil? && matched.nil? then refitem(xml, item, node)
           elsif !matched.nil? then isorefmatches(xml, matched)
           elsif !matched2.nil? then isorefmatches2(xml, matched2)
           elsif !matched3.nil? then isorefmatches3(xml, matched3)

data/lib/asciidoctor/standoc/ref_sect.rb

@@ -21,8 +21,8 @@ module Asciidoctor
           @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
         @biblio = true
         xml.references **attr_code(attrs.merge(normative: false)) do |xml_section|
-          title = node.level == 1 ? "Bibliography" : node.title
-          xml_section.title { |t| t << title }
+          #title = node.level == 1 ? "Bibliography" : node.title
+          xml_section.title { |t| t << node.title }
           xml_section << node.content
         end
         @biblio = false
@@ -44,7 +44,8 @@ module Asciidoctor
           @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
         @norm_ref = true
         xml.references **attr_code(attrs.merge(normative: true)) do |xml_section|
-          xml_section.title { |t| t << "Normative References" }
+          #xml_section.title { |t| t << "Normative References" }
+          xml_section.title { |t| t << node.title }
           xml_section << node.content
         end
         @norm_ref = false

data/lib/asciidoctor/standoc/section.rb

@@ -14,8 +14,7 @@ module Asciidoctor
       end
 
       def sectiontype1(node)
-        node&.attr("heading")&.downcase ||
-          node.title.gsub(/<[^>]+>/, "").downcase
+        node&.attr("heading")&.downcase || node.title.gsub(/<[^>]+>/, "").downcase
       end
 
       def sectiontype(node, level = true)
@@ -47,15 +46,12 @@ module Asciidoctor
 
       def section_attributes(node)
         ret = { id: Utils::anchor_or_uuid(node),
-          language: node.attributes["language"],
-          script: node.attributes["script"],
-          annex: (
-            ((node.attr("style") == "appendix" || node.role == "appendix") && 
-             node.level == 1) ? true : nil
-          ),
-          preface: (
-            (node.role == "preface" || node.attr("style") == "preface") ?
-            true : nil) }
+                language: node.attributes["language"],
+                script: node.attributes["script"],
+                annex: ( ((node.attr("style") == "appendix" || node.role == "appendix") && 
+                          node.level == 1) ? true : nil),
+                         preface: (
+                           (node.role == "preface" || node.attr("style") == "preface") ?  true : nil) }
         return ret unless node.attributes["change"]
         ret.merge(change: node.attributes["change"],
                   path: node.attributes["path"],
@@ -105,9 +101,9 @@ module Asciidoctor
 
       def set_obligation(attrs, node)
         attrs[:obligation] = node.attributes.has_key?("obligation") ?
-                               node.attr("obligation") :
-                             node.parent.attributes.has_key?("obligation") ?
-                               node.parent.attr("obligation") : "normative"
+          node.attr("obligation") :
+          node.parent.attributes.has_key?("obligation") ?
+          node.parent.attr("obligation") : "normative"
       end
 
       def preamble(node)
@@ -187,18 +183,23 @@ module Asciidoctor
         @term_def = defs
       end
 
+      def terms_boilerplate_parse(attrs, xml, node)
+        defs = @term_def
+        @term_def = false
+        clause_parse(attrs.merge(type: "boilerplate"), xml, node)
+        @term_def = defs
+      end
+
       # subclause contains subclauses
       def term_def_subclause_parse(attrs, xml, node)
-        node.role == "nonterm"  and
-          return nonterm_term_def_subclause_parse(attrs, xml, node)
+        node.role == "nonterm"  and return nonterm_term_def_subclause_parse(attrs, xml, node)
+        node.role == "boilerplate"  and return terms_boilerplate_parse(attrs, xml, node)
         st = sectiontype(node, false)
         return symbols_parse(attrs, xml, node) if @definitions
         sub = node.find_by(context: :section) { |s| s.level == node.level + 1 }
         sub.empty? || (return term_def_parse(attrs, xml, node, false))
-        st == "symbols and abbreviated terms" and
-          (return symbols_parse(attrs, xml, node))
-        st == "terms and definitions" and
-          return clause_parse(attrs, xml, node)
+        st == "symbols and abbreviated terms" and (return symbols_parse(attrs, xml, node))
+        st == "terms and definitions" and return clause_parse(attrs, xml, node)
         term_def_subclause_parse1(attrs, xml, node)
       end