metanorma-standoc 1.6.1 → 1.7.0

data/lib/asciidoctor/standoc/cleanup_footnotes.rb

@@ -82,7 +82,21 @@ module Asciidoctor
         end
       end
 
+      def footnote_block_cleanup(xmldoc)
+        xmldoc.xpath("//footnoteblock").each do |f|
+          f.name = 'fn'
+          if id = xmldoc.at("//*[@id = '#{f.text}']")
+            f.children = id.remove.children
+          else
+            @log.add("Crossreferences", f,
+                     "Could not resolve footnoteblock:[#{f.text}]")
+            f.children = "[ERROR]"
+          end
+        end
+      end
+
       def footnote_cleanup(xmldoc)
+        footnote_block_cleanup(xmldoc)
         title_footnote_move(xmldoc)
         table_footnote_renumber(xmldoc)
         other_footnote_renumber(xmldoc)

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -49,8 +49,12 @@ module Asciidoctor
       end
 
       def extract_localities(x)
-        text = x&.children&.first&.remove&.text
-        extract_localities1(x, text)
+        f = x&.children&.first or return
+        f.text? or return
+        head = f.remove.text
+        tail = x&.children&.remove
+        extract_localities1(x, head)
+        tail and x << tail
       end
 
       def extract_localities1(x, text)
@@ -121,7 +125,7 @@ module Asciidoctor
       def concept_termbase_cleanup(x)
         text = x&.children&.first&.remove&.text
         termbase, key = x["key"].split(/:/, 2)
-        x.add_child(%(<termref base="#{termbase}" target="#{key}">) + 
+        x.add_child(%(<termref base="#{termbase}" target="#{key}">) +
                     "#{text}</termref>")
       end
 
@@ -151,6 +155,8 @@ module Asciidoctor
         ret
       end
 
+      module_function :to_ncname
+
       def to_xreftarget(s)
         return to_ncname(s) unless /^[^#]+#.+$/.match(s)
           /^(?<pref>[^#]+)#(?<suff>.+)$/ =~ s

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -16,8 +16,7 @@ module Asciidoctor
         insert = refs&.at("./bibitem")&.previous_element
         refs.xpath("./bibitem").each { |b| b.remove }
         bib.reverse.each do |b|
-          insert and insert.next = b.to_xml or
-            refs.children.first.add_previous_sibling b.to_xml
+          insert and insert.next = b.to_xml or refs.children.first.add_previous_sibling b.to_xml
         end
         extract_notes_from_biblio(refs)
         refs.xpath("./references").each { |r| biblio_reorder1(r) }
@@ -49,12 +48,14 @@ module Asciidoctor
       # consecutively, but that standards codes are preserved as is:
       # only numeric references are renumbered
       def biblio_renumber(xmldoc)
-        r = xmldoc.at("//references | //clause[.//references] | "\
-                      "//annex[.//references]") or return
-        r.xpath(".//bibitem[not(ancestor::bibitem)]").each_with_index do |b, i|
-          next unless docid = b.at("./docidentifier[@type = 'metanorma']")
-          next unless  /^\[\d+\]$/.match(docid.text)
-          docid.children = "[#{i + 1}]"
+        i = 0
+        xmldoc.xpath("//bibliography//references | //clause//references | //annex//references").each do |r|
+          r.xpath("./bibitem").each do |b|
+            i += 1
+            next unless docid = b.at("./docidentifier[@type = 'metanorma']")
+            next unless  /^\[\d+\]$/.match(docid.text)
+            docid.children = "[#{i}]"
+          end
         end
       end
 
@@ -123,8 +124,7 @@ module Asciidoctor
         xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
           bib = dl_bib_extract(c) or next
           validate_ref_dl(bib, c)
-          bibitemxml = RelatonBib::BibliographicItem.new(
-            RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next
+          bibitemxml = RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next
           bibitem = Nokogiri::XML(bibitemxml)
           bibitem.root["id"] = c["id"] if c["id"] && !/^_/.match(c["id"])
           c.replace(bibitem.root)
@@ -135,14 +135,11 @@ module Asciidoctor
         id = bib["id"]
         id ||= c["id"] unless /^_/.match(c["id"]) # do not accept implicit id
         unless id
-          @log.add("Anchors", c, "The following reference is missing "\
-                   "an anchor:\n" + c.to_xml)
+          @log.add("Anchors", c, "The following reference is missing an anchor:\n" + c.to_xml)
           return
         end
-        bib["title"] or @log.add("Bibliography", c, "Reference #{id} "\
-                                 "is missing a title")
-        bib["docid"] or @log.add("Bibliography", c, "Reference #{id} "\
-                                 "is missing a document identifier (docid)")
+        bib["title"] or @log.add("Bibliography", c, "Reference #{id} is missing a title")
+        bib["docid"] or @log.add("Bibliography", c, "Reference #{id} is missing a document identifier (docid)")
       end
 
       def extract_from_p(tag, bib, key)
@@ -173,8 +170,7 @@ module Asciidoctor
         return nil if dtd.children.empty?
         dtd.at("./dl") and return dl_bib_extract(dtd)
         elems = dtd.remove.elements
-        return p_unwrap(dtd) unless elems.size == 1 &&
-          %w(ol ul).include?(elems[0].name)
+        return p_unwrap(dtd) unless elems.size == 1 && %w(ol ul).include?(elems[0].name)
         ret = []
         elems[0].xpath("./li").each do |li|
           ret << p_unwrap(li)
@@ -192,8 +188,7 @@ module Asciidoctor
         bib = {}
         key = ""
         dl.xpath("./dt | ./dd").each do |dtd|
-          dtd.name == "dt" and key = dtd.text.sub(/:+$/, "") or
-            add_to_hash(bib, key, dd_bib_extract(dtd))
+          dtd.name == "dt" and key = dtd.text.sub(/:+$/, "") or add_to_hash(bib, key, dd_bib_extract(dtd))
         end
         c.xpath("./clause").each do |c1|
           key = c1&.at("./title")&.text&.downcase&.strip
@@ -221,8 +216,7 @@ module Asciidoctor
         File.file?(file) or return nil
         xml = Nokogiri::XML(File.read(file, encoding: "utf-8"))
         ret = xml.at("//*[local-name() = 'bibdata']") or return nil
-        ret = Nokogiri::XML(ret.to_xml.sub(
-          %r{(<bibdata[^>]*?) xmlns=("[^"]+"|'[^']+')}, "\\1")).root
+        ret = Nokogiri::XML(ret.to_xml.sub(%r{(<bibdata[^>]*?) xmlns=("[^"]+"|'[^']+')}, "\\1")).root
         ret.name = "bibitem"
         ins = ret.at("./*[local-name() = 'docidentifier']") or return nil
         ins.previous = %{<uri type="citation">#{uri}</uri>}
@@ -232,8 +226,7 @@ module Asciidoctor
 
       # if citation uri points to local file, get bibitem from it
       def fetch_local_bibitem(xmldoc)
-        xmldoc.xpath("//bibitem[formattedref]"\
-                     "[uri[@type = 'citation']]").each do |b|
+        xmldoc.xpath("//bibitem[formattedref][uri[@type = 'citation']]").each do |b|
           uri = b&.at("./uri[@type = 'citation']")&.text
           bibitem = read_local_bibitem(uri) or next
           bibitem["id"] = b["id"]

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -1,3 +1,5 @@
+require_relative "term_lookup_cleanup"
+
 module Asciidoctor
   module Standoc
     module Cleanup
@@ -45,10 +47,6 @@ module Asciidoctor
         end
       end
 
-      def termdef_boilerplate_cleanup(xmldoc)
-        xmldoc.xpath("//terms/p | //terms/ul").each(&:remove)
-      end
-
       def termdef_subclause_cleanup(xmldoc)
         xmldoc.xpath("//terms[terms]").each { |t| t.name = "clause" }
       end
@@ -81,11 +79,12 @@ module Asciidoctor
           x.name = "note"
         end
         xmldoc.xpath("//termexample[not(ancestor::term)]").each do |x|
-          x.name = "note"
+          x.name = "example"
         end
       end
 
       def termdef_cleanup(xmldoc)
+        Asciidoctor::Standoc::TermLookupCleanup.new(xmldoc, @log).call
         termdef_from_termbase(xmldoc)
         termdef_unnest_cleanup(xmldoc)
         termdef_stem_cleanup(xmldoc)
@@ -93,7 +92,6 @@ module Asciidoctor
         termdefinition_cleanup(xmldoc)
         termdomain1_cleanup(xmldoc)
         termnote_example_cleanup(xmldoc)
-        termdef_boilerplate_cleanup(xmldoc)
         termdef_subclause_cleanup(xmldoc)
         term_children_cleanup(xmldoc) 
         termdocsource_cleanup(xmldoc)

data/lib/asciidoctor/standoc/converter.rb

@@ -1,4 +1,7 @@
 require "asciidoctor"
+require "fontist"
+require "fontist/manifest/install"
+require "metanorma/util"
 require "metanorma/standoc/version"
 require "asciidoctor/standoc/base"
 require "asciidoctor/standoc/front"
@@ -25,6 +28,8 @@ module Asciidoctor
         preprocessor Asciidoctor::Standoc::Datamodel::DiagramPreprocessor
         preprocessor Metanorma::Plugin::Datastruct::Json2TextPreprocessor
         preprocessor Metanorma::Plugin::Datastruct::Yaml2TextPreprocessor
+        preprocessor Metanorma::Plugin::Lutaml::LutamlPreprocessor
+        preprocessor Metanorma::Plugin::Lutaml::LutamlUmlAttributesTablePreprocessor
         inline_macro Asciidoctor::Standoc::AltTermInlineMacro
         inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
         inline_macro Asciidoctor::Standoc::DomainTermInlineMacro
@@ -32,9 +37,15 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::HTML5RubyMacro
         inline_macro Asciidoctor::Standoc::ConceptInlineMacro
         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
+        block Metanorma::Plugin::Lutaml::LutamlDiagramBlock
         block Asciidoctor::Standoc::PseudocodeBlockMacro
       end
 
@@ -44,6 +55,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
@@ -61,6 +73,8 @@ module Asciidoctor
         basebackend "html"
         outfilesuffix ".xml"
         @libdir = File.dirname(self.class::_file || __FILE__)
+
+        install_fonts(opts)
       end
 
       class << self
@@ -73,7 +87,63 @@ module Asciidoctor
 
       # path to isodoc assets in child gems
       def html_doc_path(file)
-        File.join(@libdir, File.join("../../isodoc/html", file))
+        File.join(@libdir, "../../isodoc/html", file)
+      end
+
+      def flavor_name
+        self.class.name.split("::")&.[](-2).downcase.to_sym
+      end
+
+      def fonts_manifest
+        flavor = flavor_name
+        registry = Metanorma::Registry.instance
+        processor = registry.find_processor(flavor)
+
+        if processor.nil?
+          Metanorma::Util.log("[fontist] #{flavor} processor not found. " \
+            "Please go to github.com/metanorma/metanorma/issues to report " \
+            "this issue.", :warn)
+          return nil
+        elsif !defined? processor.fonts_manifest
+          Metanorma::Util.log("[fontist] #{flavor} processor don't require " \
+            "specific fonts", :debug)
+          return nil
+        end
+
+        processor.fonts_manifest
+      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
+
+        manifest = fonts_manifest
+        return if manifest.nil?
+
+        begin
+          Fontist::Manifest::Install.from_hash(
+            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
+          Metanorma::Util.log("[fontist] '#{font}' font is not supported. " \
+            "Please go to github.com/metanorma/metanorma-#{flavor_name}/issues" \
+            " to report this issue.", :info)
+        end
       end
 
       alias_method :embedded, :content

data/lib/asciidoctor/standoc/front.rb

@@ -17,6 +17,11 @@ module Asciidoctor
         xml.docnumber node.attr("docnumber")
       end
 
+      def metadata_other_id(node, xml)
+        a = node.attr("isbn") and xml.docidentifier a, type: "ISBN"
+        a = node.attr("isbn10") and xml.docidentifier a, type: "ISBN10"
+      end
+
       def metadata_version(node, xml)
         xml.edition node.attr("edition") if node.attr("edition")
         xml.version do |v|
@@ -138,6 +143,7 @@ module Asciidoctor
         title node, xml
         metadata_source(node, xml)
         metadata_id(node, xml)
+        metadata_other_id(node, xml)
         metadata_date(node, xml)
         metadata_author(node, xml)
         metadata_publisher(node, xml)

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

@@ -211,11 +211,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

@@ -24,6 +24,14 @@
     <start>
       <ref name="standard-document"/>
     </start>
+    <define name="doctype">
+      <element name="doctype">
+        <optional>
+          <attribute name="abbreviation"/>
+        </optional>
+        <ref name="DocumentType"/>
+      </element>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -47,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"/>
@@ -141,6 +156,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -233,6 +253,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -751,6 +774,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>
@@ -1164,49 +1199,7 @@
   </define>
   <define name="annex">
     <element name="annex">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
-      <optional>
-        <attribute name="inline-header">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="obligation">
-        <choice>
-          <value>normative</value>
-          <value>informative</value>
-        </choice>
-      </attribute>
-      <optional>
-        <ref name="section-title"/>
-      </optional>
-      <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
-        <zeroOrMore>
-          <choice>
-            <ref name="annex-subsection"/>
-            <ref name="terms"/>
-            <ref name="definitions"/>
-            <ref name="references"/>
-          </choice>
-        </zeroOrMore>
-      </group>
+      <ref name="Annex-Section"/>
     </element>
   </define>
   <define name="terms">