metanorma-standoc 1.10.5 → 1.11.0

data/lib/asciidoctor/standoc/lists.rb

@@ -4,10 +4,10 @@ module Asciidoctor
       def li(xml_ul, item)
         xml_ul.li do |xml_li|
           if item.blocks?
-            xml_li.p(**id_attr(item)) { |t| t << item.text }
+            xml_li.p(**attr_code(id_attr(item))) { |t| t << item.text }
             xml_li << item.content
           else
-            xml_li.p(**id_attr(item)) { |p| p << item.text }
+            xml_li.p(**attr_code(id_attr(item))) { |p| p << item.text }
           end
         end
       end
@@ -15,10 +15,10 @@ module Asciidoctor
       def ul_li(xml_ul, item)
         xml_ul.li **ul_li_attrs(item) do |xml_li|
           if item.blocks?
-            xml_li.p(**id_attr(item)) { |t| t << item.text }
+            xml_li.p(**attr_code(id_attr(item))) { |t| t << item.text }
             xml_li << item.content
           else
-            xml_li.p(**id_attr(item)) { |p| p << item.text }
+            xml_li.p(**attr_code(id_attr(item))) { |p| p << item.text }
           end
         end
       end
@@ -57,9 +57,8 @@ module Asciidoctor
       end
 
       def ol_attrs(node)
-        attr_code(keep_attrs(node)
-          .merge(id: Metanorma::Utils::anchor_or_uuid(node),
-                 type: olist_style(node.style)))
+        attr_code(id_attr(node).merge(keep_attrs(node)
+          .merge(type: olist_style(node.style))))
       end
 
       def olist(node)
@@ -79,22 +78,23 @@ module Asciidoctor
         end
       end
 
-      def dd(dd, xml_dl)
-        if dd.nil?
+      def dd(ddefn, xml_dl)
+        if ddefn.nil?
           xml_dl.dd
           return
         end
         xml_dl.dd do |xml_dd|
-          xml_dd.p { |t| t << dd.text } if dd.text?
-          xml_dd << dd.content if dd.blocks?
+          xml_dd.p { |t| t << ddefn.text } if ddefn.text?
+          xml_dd << ddefn.content if ddefn.blocks?
         end
       end
 
       def dl_attrs(node)
-        attr_code(keep_attrs(node)
-                  .merge(id: Metanorma::Utils::anchor_or_uuid(node),
-                         metadata: node.option?("metadata") ? "true" : nil,
-                         key: node.option?("key") ? "true" : nil))
+        attr_code(id_attr(node).merge(keep_attrs(node)
+          .merge(
+            metadata: node.option?("metadata") ? "true" : nil,
+            key: node.option?("key") ? "true" : nil,
+          )))
       end
 
       def dlist(node)

data/lib/asciidoctor/standoc/macros.rb

@@ -6,6 +6,7 @@ require "csv"
 require_relative "./macros_plantuml"
 require_relative "./macros_terms"
 require_relative "./macros_form"
+require_relative "./macros_note"
 require_relative "./datamodel/attributes_table_preprocessor"
 require_relative "./datamodel/diagram_preprocessor"
 require "metanorma-plugin-datastruct"
@@ -41,7 +42,7 @@ module Asciidoctor
       def process(_parent, target, attr)
         args = preprocess_attrs(attr) or return
         ret = "<index-xref also='#{target == 'also'}'>"\
-          "<primary>#{args[:primary]}</primary>"
+              "<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>"
@@ -50,7 +51,7 @@ module Asciidoctor
 
     class IndexRangeInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
-      named "index-range".to_sym
+      named :"index-range"
       parse_content_as :text
 
       def process(parent, target, attr)
@@ -121,35 +122,6 @@ module Asciidoctor
       end
     end
 
-    class ToDoAdmonitionBlock < Extensions::BlockProcessor
-      use_dsl
-      named :TODO
-      on_contexts :example, :paragraph
-
-      def process(parent, reader, attrs)
-        attrs["name"] = "todo"
-        attrs["caption"] = "TODO"
-        create_block(parent, :admonition, reader.lines, attrs,
-                     content_model: :compound)
-      end
-    end
-
-    class ToDoInlineAdmonitionBlock < Extensions::Treeprocessor
-      def process(document)
-        (document.find_by context: :paragraph).each do |para|
-          next unless /^TODO: /.match? para.lines[0]
-
-          parent = para.parent
-          para.set_attr("name", "todo")
-          para.set_attr("caption", "TODO")
-          para.lines[0].sub!(/^TODO: /, "")
-          todo = Block.new(parent, :admonition, attributes: para.attributes,
-                                                source: para.lines, content_model: :compound)
-          parent.blocks[parent.blocks.index(para)] = todo
-        end
-      end
-    end
-
     class AutonumberInlineMacro < Extensions::InlineMacroProcessor
       use_dsl
       named :autonumber
@@ -177,18 +149,6 @@ module Asciidoctor
       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
-
     class AddMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :add
@@ -229,5 +189,16 @@ module Asciidoctor
         "<toc>#{content}</toc>"
       end
     end
+
+    class PassInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :"pass-format"
+
+      def process(parent, target, attrs)
+        format = target || "metanorma"
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs[1]).convert
+        %{<passthrough formats="#{format}">#{out}</passthrough>}
+      end
+    end
   end
 end

data/lib/asciidoctor/standoc/macros_note.rb

@@ -0,0 +1,45 @@
+module Asciidoctor
+  module Standoc
+    class ToDoAdmonitionBlock < Extensions::BlockProcessor
+      use_dsl
+      named :TODO
+      on_contexts :example, :paragraph
+
+      def process(parent, reader, attrs)
+        attrs["name"] = "todo"
+        attrs["caption"] = "TODO"
+        create_block(parent, :admonition, reader.lines, attrs,
+                     content_model: :compound)
+      end
+    end
+
+    class ToDoInlineAdmonitionBlock < Extensions::Treeprocessor
+      def process(document)
+        (document.find_by context: :paragraph).each do |para|
+          next unless /^TODO: /.match? para.lines[0]
+
+          parent = para.parent
+          para.set_attr("name", "todo")
+          para.set_attr("caption", "TODO")
+          para.lines[0].sub!(/^TODO: /, "")
+          todo = Block.new(parent, :admonition, attributes: para.attributes,
+                                                source: para.lines,
+                                                content_model: :compound)
+          parent.blocks[parent.blocks.index(para)] = todo
+        end
+      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_plantuml.rb

@@ -28,32 +28,38 @@ module Asciidoctor
       # sleep need for windows because dot works in separate process and
       # plantuml process may finish earlier then dot, as result png file
       # maybe not created yet after plantuml finish
+      #
+      # # Warning: metanorma/metanorma-standoc#187
+      # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
+      # This is why we need to copy and then unlink.
       def self.generate_file(parent, reader)
         localdir = Metanorma::Utils::localdir(parent.document)
         imagesdir = parent.document.attr("imagesdir")
         umlfile, outfile = save_plantuml parent, reader, localdir
-        run(umlfile, outfile) or raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
+        run(umlfile, outfile) or
+          raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
         umlfile.unlink
 
-        path = Pathname.new(localdir) + (imagesdir || "plantuml")
-        File.writable?(localdir) or raise "Destination path #{path} not writable for PlantUML!"
-        path.mkpath
-        File.writable?(path) or raise "Destination path #{path} not writable for PlantUML!"
-        # File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"
-
-        # Warning: metanorma/metanorma-standoc#187
-        # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
-        # This is why we need to copy and then unlink.
+        path = path_prep(localdir, imagesdir)
         filename = File.basename(outfile.to_s)
-        FileUtils.cp(outfile, path) && outfile.unlink
+        FileUtils.cp(outfile, path) and outfile.unlink
 
         imagesdir ? filename : File.join(path, filename)
       end
 
+      def self.path_prep(localdir, imagesdir)
+        path = Pathname.new(localdir) + (imagesdir || "plantuml")
+        File.writable?(localdir) or
+          raise "Destination path #{path} not writable for PlantUML!"
+        path.mkpath
+        File.writable?(path) or
+          raise "Destination path #{path} not writable for PlantUML!"
+        # File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"
+        path
+      end
+
       def self.save_plantuml(_parent, reader, _localdir)
-        src = reader.source
-        reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
-          src = "@startuml\n#{src}\n@enduml\n"
+        src = prep_source(reader)
         /^@startuml (?<fn>[^\n]+)\n/ =~ src
         Tempfile.open(["plantuml", ".pml"], encoding: "utf-8") do |f|
           f.write(src)
@@ -62,6 +68,15 @@ module Asciidoctor
         end
       end
 
+      def self.prep_source(reader)
+        src = reader.source
+        reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
+          src = "@startuml\n#{src}\n@enduml\n"
+        %r{@enduml\s*$}m.match?(src) or
+          raise "@startuml without matching @enduml in PlantUML!"
+        src
+      end
+
       def self.generate_attrs(attrs)
         %w(id align float title role width height alt)
           .inject({}) do |memo, key|

data/lib/asciidoctor/standoc/macros_terms.rb

@@ -2,6 +2,18 @@ require "csv"
 
 module Asciidoctor
   module Standoc
+    class PreferredTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :preferred
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<preferred><expression><name>#{out}</name></expression></preferred>}
+      end
+    end
+
     class AltTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :alt
@@ -9,8 +21,9 @@ module Asciidoctor
       using_format :short
 
       def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<admitted>#{out}</admitted>}
+        out = Asciidoctor::Inline.new(parent, :quoted,
+                                      attrs["text"]).convert
+        %{<admitted><expression><name>#{out}</name></expression></admitted>}
       end
     end
 
@@ -21,8 +34,9 @@ module Asciidoctor
       using_format :short
 
       def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<deprecates>#{out}</deprecates>}
+        out = Asciidoctor::Inline.new(parent, :quoted,
+                                      attrs["text"]).convert
+        %{<deprecates><expression><name>#{out}</name></expression></deprecates>}
       end
     end
 
@@ -33,7 +47,8 @@ module Asciidoctor
       using_format :short
 
       def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        out = Asciidoctor::Inline.new(parent, :quoted,
+                                      attrs["text"]).convert
         %{<domain>#{out}</domain>}
       end
     end
@@ -81,15 +96,24 @@ module Asciidoctor
       def preprocess_attrs(target)
         m = /^(?<id>&lt;&lt;.+?&gt;&gt;)?(?<rest>.*)$/.match(target)
         ret = { id: m[:id]&.sub(/^&lt;&lt;/, "")&.sub(/&gt;&gt;$/, "") }
-        if m2 = /^(?<rest>.*?)(?<opt>,option=.+)$/.match(m[:rest].sub(/^,/, ""))
-          ret[:opt] = CSV.parse_line(m2[:opt].sub(/^,option=/, "")
+        if m2 = /^(?<rest>.*?)(?<opt>,opt(ion)?s=.+)$/
+            .match(m[:rest].sub(/^,/, ""))
+          ret[:opt] = CSV.parse_line(m2[:opt].sub(/^,opt(ion)?s=/, "")
             .sub(/^"(.+)"$/, "\\1").sub(/^'(.+)'$/, "\\1"))
-          attrs = CSV.parse_line(m2[:rest]) || []
+          begin
+            attrs = CSV.parse_line(m2[:rest]) || []
+          rescue StandardError
+            raise "error processing #{m2[:rest]} as CSV"
+          end
         else
-          attrs = CSV.parse_line(m[:rest].sub(/^,/, "")) || []
+          begin
+            attrs = CSV.parse_line(m[:rest].sub(/^,/, "")) || []
+          rescue StandardError
+            raise "error processing #{m[:rest]} as CSV"
+          end
         end
         ret.merge(term: attrs[0], word: attrs[1] || attrs[0],
-                  xrefrender: attrs[2])
+                  render: attrs[2])
       end
 
       def generate_attrs(opts)
@@ -98,21 +122,59 @@ module Asciidoctor
         opts.include?("noref") and ret += " ref='false'"
         opts.include?("ital") and ret += " ital='true'"
         opts.include?("ref") and ret += " ref='true'"
+        opts.include?("nolinkmention") and ret += " linkmention='false'"
+        opts.include?("linkmention") and ret += " linkmention='true'"
+        opts.include?("nolinkref") and ret += " linkref='false'"
+        opts.include?("linkref") and ret += " linkref='true'"
         ret
       end
 
       def process(parent, target, _attrs)
         attrs = preprocess_attrs(target)
-        termout = Asciidoctor::Inline.new(parent, :quoted, attrs[:term]).convert
-        wordout = Asciidoctor::Inline.new(parent, :quoted, attrs[:word]).convert
-        xrefout = Asciidoctor::Inline.new(parent, :quoted,
-                                          attrs[:xrefrender]).convert
-        optout = generate_attrs(attrs[:opt] || [])
-        attrs[:id] and return "<concept#{optout} key='#{attrs[:id]}'><refterm>"\
-          "#{termout}</refterm><renderterm>#{wordout}</renderterm>"\
-          "<xrefrender>#{xrefout}</xrefrender></concept>"
-        "<concept#{optout}><termxref>#{termout}</termxref><renderterm>"\
-          "#{wordout}</renderterm><xrefrender>#{xrefout}</xrefrender></concept>"
+        term = Asciidoctor::Inline.new(parent, :quoted,
+                                       attrs[:term]).convert
+        word = Asciidoctor::Inline.new(parent, :quoted,
+                                       attrs[:word]).convert
+        xref = Asciidoctor::Inline.new(parent, :quoted,
+                                       attrs[:render]).convert
+        opt = generate_attrs(attrs[:opt] || [])
+        if attrs[:id] then "<concept#{opt} key='#{attrs[:id]}'><refterm>"\
+          "#{term}</refterm><renderterm>#{word}</renderterm>"\
+          "<xrefrender>#{xref}</xrefrender></concept>"
+        else "<concept#{opt}><termxref>#{term}</termxref><renderterm>"\
+          "#{word}</renderterm><xrefrender>#{xref}</xrefrender></concept>"
+        end
+      rescue StandardError => e
+        raise("processing {{#{target}}}: #{e.message}")
+      end
+    end
+
+    # Possibilities:
+    # related:relation[<<id>>, term]
+    # related:relation[<<termbase:id>>, term]
+    # related:relation[term] equivalent to a crossreference to term:[term]
+    class RelatedTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :related
+      parse_content_as :text
+
+      def preprocess_attrs(target)
+        m = /^(?<id>&lt;&lt;.+?&gt;&gt;, ?)?(?<rest>.*)$/.match(target)
+        { id: m[:id]&.sub(/^&lt;&lt;/, "")&.sub(/&gt;&gt;, ?$/, ""),
+          term: m[:rest] }
+      end
+
+      def process(parent, target, attrs)
+        out = preprocess_attrs(attrs["text"])
+        term = Asciidoctor::Inline.new(parent, :quoted,
+                                       out[:term]).convert
+        if out[:id] then "<related type='#{target}' key='#{out[:id]}'>"\
+          "<refterm>#{term}</refterm></related>"
+        else "<related type='#{target}'><termxref>#{term}</termxref>"\
+          "<xrefrender>#{term}</xrefrender></related>"
+        end
+      rescue StandardError => e
+        raise("processing related:#{target}[#{attrs['text']}]: #{e.message}")
       end
     end
   end

data/lib/asciidoctor/standoc/ref_sect.rb

@@ -16,16 +16,14 @@ module Asciidoctor
       end
 
       def bibliography_parse(attrs, xml, node)
-        node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
-        node.attr("style") == "bibliography" or
-          @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
+        x = biblio_prep(attrs, xml, node) and return x
         @biblio = true
-        xml.references **attr_code(attrs.merge(
-          normative: node.attr("normative") || false)) do |xml_section|
-            xml_section.title { |t| t << node.title }
-            xml_section << node.content
-          end
-          @biblio = false
+        attrs = attrs.merge(normative: node.attr("normative") || false)
+        xml.references **attr_code(attrs) do |xml_section|
+          xml_section.title { |t| t << node.title }
+          xml_section << node.content
+        end
+        @biblio = false
       end
 
       def bibitem_parse(attrs, xml, node)
@@ -39,9 +37,7 @@ module Asciidoctor
       end
 
       def norm_ref_parse(attrs, xml, node)
-        node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
-        node.attr("style") == "bibliography" or
-          @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
+        x = biblio_prep(attrs, xml, node) and return x
         @norm_ref = true
         attrs = attrs.merge(normative: node.attr("normative") || true)
         xml.references **attr_code(attrs) do |xml_section|
@@ -51,6 +47,17 @@ module Asciidoctor
         @norm_ref = false
       end
 
+      def biblio_prep(attrs, xml, node)
+        if node.option? "bibitem"
+          bibitem_parse(attrs, xml, node)
+        else
+          node.attr("style") == "bibliography" or
+            @log.add("AsciiDoc Input", node,
+                     "Section not marked up as [bibliography]!")
+          nil
+        end
+      end
+
       def global_ievcache_name
         "#{Dir.home}/.iev/cache"
       end
@@ -74,7 +81,7 @@ module Asciidoctor
         xml
       rescue RelatonBib::RequestError
         @log.add("Bibliography", nil, "Could not retrieve #{code}: "\
-                 "no access to online site")
+                                      "no access to online site")
         nil
       end
 
@@ -87,10 +94,10 @@ module Asciidoctor
         unless xml.at("/bibitem/title[text()]")
           @log.add("Bibliography", nil,
                    "ERROR: No title retrieved for #{code}")
-          xml.root << "<title>#{title || "(MISSING TITLE)"}</title>"
+          xml.root << "<title>#{title || '(MISSING TITLE)'}</title>"
         end
         usrlbl and xml.at("/bibitem/docidentifier").next =
-          "<docidentifier type='metanorma'>#{mn_code(usrlbl)}</docidentifier>"
+                     "<docidentifier type='metanorma'>#{mn_code(usrlbl)}</docidentifier>"
       end
 
       def smart_render_xml(xml, code, opts)
@@ -113,7 +120,7 @@ module Asciidoctor
         @bibdb = Relaton::DbCache.init_bib_caches(
           local_cache: local,
           flush_caches: node.attr("flush-caches"),
-          global_cache: global
+          global_cache: global,
         )
       end
 
@@ -128,7 +135,7 @@ module Asciidoctor
             FileUtils.rm_f @iev_localname unless @iev_localname.nil?
           end
         end
-        #@iev = Iev::Db.new(globalname, localname) unless @no_isobib
+        # @iev = Iev::Db.new(globalname, localname) unless @no_isobib
       end
     end
   end

data/lib/asciidoctor/standoc/reqt.rb

@@ -7,8 +7,8 @@ module Asciidoctor
   module Standoc
     module Blocks
       def reqt_subpart(name)
-        %w(specification measurement-target verification import label
-           component subject inherit classification title).include? name
+        %w(specification measurement-target verification import label title
+           description component subject inherit classification).include? name
       end
 
       def reqt_subpart_attrs(node, name)

data/lib/asciidoctor/standoc/reqt.rng

@@ -58,6 +58,14 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <optional>
       <ref name="reqtitle"/>
     </optional>
@@ -101,7 +109,9 @@
   </define>
   <define name="label">
     <element name="label">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="subject">
@@ -175,8 +185,19 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <oneOrMore>
-      <ref name="BasicBlock"/>
+      <choice>
+        <ref name="BasicBlock"/>
+        <ref name="component"/>
+      </choice>
     </oneOrMore>
   </define>
   <define name="ObligationType">