metanorma-standoc 1.6.4 → 1.7.3

data/lib/asciidoctor/standoc/converter.rb

@@ -1,6 +1,4 @@
 require "asciidoctor"
-require "fontist"
-require "fontist/manifest/install"
 require "metanorma/util"
 require "metanorma/standoc/version"
 require "asciidoctor/standoc/base"
@@ -39,6 +37,9 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::AutonumberInlineMacro
         inline_macro Asciidoctor::Standoc::VariantInlineMacro
         inline_macro Asciidoctor::Standoc::FootnoteBlockInlineMacro
+        inline_macro Asciidoctor::Standoc::TermRefInlineMacro
+        inline_macro Asciidoctor::Standoc::IndexXrefInlineMacro
+        inline_macro Asciidoctor::Standoc::IndexRangeInlineMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro
@@ -52,6 +53,7 @@ module Asciidoctor
       include ::Asciidoctor::Standoc::Base
       include ::Asciidoctor::Standoc::Front
       include ::Asciidoctor::Standoc::Lists
+      include ::Asciidoctor::Standoc::Refs
       include ::Asciidoctor::Standoc::Inline
       include ::Asciidoctor::Standoc::Blocks
       include ::Asciidoctor::Standoc::Section
@@ -69,8 +71,6 @@ module Asciidoctor
         basebackend "html"
         outfilesuffix ".xml"
         @libdir = File.dirname(self.class::_file || __FILE__)
-
-        install_fonts(opts)
       end
 
       class << self
@@ -86,51 +86,6 @@ module Asciidoctor
         File.join(@libdir, "../../isodoc/html", file)
       end
 
-      def flavor_name
-        self.class.name.split("::")&.[](-2).downcase
-      end
-
-      def fonts_manifest
-        File.expand_path(File.join(@libdir, "../../metanorma/", flavor_name, "fonts_manifest.yaml"))
-      end
-
-      def install_fonts(options={})
-        if options[:no_install_fonts]
-          Metanorma::Util.log("[fontist] Skip font installation because" \
-            " --no-install-fonts argument passed", :debug)
-          return
-        end
-
-        if fonts_manifest.nil? || !File.exist?(fonts_manifest)
-          Metanorma::Util.log("[fontist] Skip font installation because" \
-            " font manifest file doesn't exists/defined", :debug)
-          return
-        end
-
-        begin
-          Fontist::Manifest::Install.call(
-            fonts_manifest,
-            confirmation: options[:agree_to_terms] ? "yes" : "no"
-          )
-        rescue Fontist::Errors::LicensingError
-          if !options[:agree_to_terms]
-            Metanorma::Util.log("[fontist] --agree-to-terms option missing." \
-              " You must accept font licenses to install fonts.", :debug)
-          elsif options[:continue_without_fonts]
-            Metanorma::Util.log("[fontist] Processing will continue without" \
-              " fonts installed", :debug)
-          else
-            Metanorma::Util.log("[fontist] Aborting without proper fonts" \
-              " installed", :fatal)
-          end
-        rescue Fontist::Errors::NonSupportedFontError
-          flavor = flavor_name || "cli"
-          Metanorma::Util.log("[fontist] '#{font}' font is not supported. " \
-            "Please go to github.com/metanorma/metanorma-#{flavor}/issues" \
-            " to report this issue.", :info)
-        end
-      end
-
       alias_method :embedded, :content
       alias_method :verse, :quote
       alias_method :audio, :skip

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -46,8 +46,9 @@ module Asciidoctor
 
       # , " => ," : CSV definition does not deal with space followed by quote
       # at start of field
-      def csv_split(s, delim = ",")
-        CSV.parse_line(s&.gsub(/, "(?!")/, ',"'),
+      def csv_split(s, delim = ";")
+        return if s.nil?
+        CSV.parse_line(s&.gsub(/#{delim} "(?!")/, "#{delim}\""),
                        liberal_parsing: true,
                        col_sep: delim)&.compact&.map { |x| x.strip }
       end
@@ -115,8 +116,11 @@ module Asciidoctor
         node.attr("affiliation#{suffix}") and p.affiliation do |a|
           a.organization do |o|
             o.name node.attr("affiliation#{suffix}")
-            abbr = node.attr("affiliation_abbrev#{suffix}") and
-              o.abbreviation abbr
+            a = node.attr("affiliation_subdiv#{suffix}")
+            abbr = node.attr("affiliation_abbrev#{suffix}") and o.abbreviation abbr
+            csv_split(node.attr("affiliation_subdiv#{suffix}"))&.each do |s|
+              o.subdivision s
+            end
             node.attr("address#{suffix}") and o.address do |ad|
               ad.formattedAddress do |f|
                 f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")

data/lib/asciidoctor/standoc/inline.rb

@@ -165,6 +165,7 @@ module Asciidoctor
             when "domain" then xml.domain { |a| a << node.text }
 
             when "strike" then xml.strike { |s| s << node.text }
+            when "underline" then xml.underline { |s| s << node.text }
             when "smallcap" then xml.smallcap { |s| s << node.text }
             when "keyword" then xml.keyword { |s| s << node.text }
             else
@@ -211,11 +212,12 @@ module Asciidoctor
       def inline_indexterm(node)
         noko do |xml|
           node.type == :visible and xml << node.text
-          terms = node.attr("terms") ||
-            [Nokogiri::XML("<a>#{node.text}</a>").xpath("//text()").text]
-          xml.index nil, **attr_code(primary: terms[0],
-                                     secondary: terms.dig(1),
-                                     tertiary: terms.dig(2))
+            terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
+          xml.index do |i|
+            i.primary { |x| x << terms[0] }
+            a = terms.dig(1) and i.secondary { |x| x << a }
+            a = terms.dig(2) and i.tertiary { |x| x << a }
+          end
         end.join
       end
     end

data/lib/asciidoctor/standoc/isodoc.rng

@@ -55,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>
@@ -246,6 +253,12 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -764,6 +777,18 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="colgroup">
+    <element name="colgroup">
+      <oneOrMore>
+        <ref name="col"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="col">
+    <element name="col">
+      <attribute name="width"/>
+    </element>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -814,6 +839,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -869,9 +897,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -1041,6 +1071,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1094,6 +1127,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1196,6 +1232,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1524,6 +1563,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1554,6 +1594,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>

data/lib/asciidoctor/standoc/macros.rb

@@ -3,6 +3,7 @@ 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"
@@ -10,81 +11,49 @@ 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
 
@@ -135,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
@@ -158,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
 
@@ -171,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
@@ -197,8 +166,8 @@ module Asciidoctor
         /^(?<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>}
+          %{<variant lang=#{lang} script=#{script}>#{out}</variant>} :
+          %{<variant lang=#{lang}>#{out}</variant>}
       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