metanorma-standoc 2.1.2 → 2.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56e2b9105572c28858ffc12d075b16615ec8195836ad4bf7d7d2122fbf81dc05
-  data.tar.gz: 2594f703aeba2f78a5bf3df715709f78b3b6da1a751cb52fedd3ebce299eaf2d
+  metadata.gz: 9487b5701cc86946c27e560e244cc4f84fceb61b0a93dd271068875654eb49a0
+  data.tar.gz: c647cf6fb530aba3bc96c9087e7a9d49408ce239a6c6aa3a4a46a0e8cf1a5763
 SHA512:
-  metadata.gz: eeef127fe3ea160b49aa62cbb1aa665fb4e0cdb6d1712f646667394a41633c89864a294900c444abc1fceb7fbe2649bdfb2f539d1ccc66d3df89cd247ea31655
-  data.tar.gz: 2d1ded28e889db67a42275a5890a8e942b2b966e342e7bb7bc2b21129875394dff03ce1c1cd634b409ce72a68de0e4fd4eff518731cb3b8809c70d5c0c5f0449
+  metadata.gz: c8356539be6d28f5dc6d4d148cfcabb8ed7dbc033392544d382d36e1e392e33da6b29a64b535f6c24cdab85a4d17d1dc5698367f0edff8f45eb02b1f8ed97330
+  data.tar.gz: 13c49550edea0d6169fef67357a5030e146cdf62fec3cb41900db7490d95c09f9dbb1c4f4b55bea4836651ba11fcaf0714b20f37fc3a96a48dd31596cf564549

data/lib/metanorma/standoc/biblio.rng

@@ -623,6 +623,97 @@
     <zeroOrMore>
       <ref name="bsource"/>
     </zeroOrMore>
+    <oneOrMore>
+      <ref name="docidentifier"/>
+    </oneOrMore>
+    <optional>
+      <ref name="docnumber"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="bdate"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="edition"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="version"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="biblionote"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="language"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="script"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bibabstract"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="status"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="copyright"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="docrelation"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="series"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="medium"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="bplace"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bprice"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="extent"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="bibliographic_size"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="accesslocation"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="license"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bclassification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bkeyword"/>
+    </zeroOrMore>
+    <optional>
+      <ref name="validity"/>
+    </optional>
+  </define>
+  <define name="ReducedBibliographicItem">
+    <optional>
+      <attribute name="type">
+        <ref name="BibItemType"/>
+      </attribute>
+    </optional>
+    <optional>
+      <ref name="fetched"/>
+    </optional>
+    <optional>
+      <ref name="formattedref"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="btitle"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="bsource"/>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="docidentifier"/>
     </zeroOrMore>
@@ -638,9 +729,9 @@
     <optional>
       <ref name="edition"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="version"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="biblionote"/>
     </zeroOrMore>
@@ -833,6 +924,12 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
       <text/>
     </element>
   </define>
@@ -1172,7 +1269,7 @@
         </element>
       </optional>
       <element name="bibitem">
-        <ref name="BibliographicItem"/>
+        <ref name="ReducedBibliographicItem"/>
       </element>
       <choice>
         <zeroOrMore>
@@ -1197,9 +1294,9 @@
       <optional>
         <ref name="revision-date"/>
       </optional>
-      <zeroOrMore>
+      <optional>
         <ref name="draft"/>
-      </zeroOrMore>
+      </optional>
     </element>
   </define>
   <define name="vedition">

data/lib/metanorma/standoc/blocks.rb

@@ -38,9 +38,7 @@ module Metanorma
         role == "form" and return form(node)
         role == "definition" and return termdefinition(node)
         result = []
-        node.blocks.each do |b|
-          result << send(b.context, b)
-        end
+        node.blocks.each { |b| result << send(b.context, b) }
         result
       end
 
@@ -82,7 +80,7 @@ module Metanorma
         noko do |xml|
           xml.termexample **attr_code(id_attr(node)
             .merge(
-              keepasterm: node.option?("termexample") ? "true" : nil,
+              keepasterm: node.option?("termexample") || nil,
             )) do |ex|
             wrap_in_para(node, ex)
           end
@@ -244,8 +242,7 @@ module Metanorma
         noko do |xml|
           xml.passthrough **attr_code(formats:
                                       node.attr("format") || "metanorma") do |p|
-            p << c.encode(c.decode(node.content),
-                          :basic, :hexadecimal)
+            p << c.encode(c.decode(node.content), :basic, :hexadecimal)
           end
         end
       end

data/lib/metanorma/standoc/blocks_notes.rb

@@ -94,7 +94,7 @@ module Metanorma
       end
 
       def admonition(node)
-        return termnote(node) if in_terms?
+        return termnote(node) if in_terms? && node.attr("name") == "note"
         return note(node) if node.attr("name") == "note"
         return todo(node) if node.attr("name") == "todo"
 

data/lib/metanorma/standoc/cleanup.rb

@@ -28,6 +28,8 @@ module Metanorma
         passthrough_cleanup(xmldoc)
         sections_cleanup(xmldoc)
         obligations_cleanup(xmldoc)
+        para_index_cleanup(xmldoc)
+        block_index_cleanup(xmldoc)
         table_cleanup(xmldoc)
         formula_cleanup(xmldoc)
         form_cleanup(xmldoc)
@@ -51,7 +53,7 @@ module Metanorma
         termdef_cleanup(xmldoc)
         RelatonIev::iev_cleanup(xmldoc, @bibdb)
         element_name_cleanup(xmldoc)
-        index_cleanup(xmldoc)
+        term_index_cleanup(xmldoc)
         bpart_cleanup(xmldoc)
         quotesource_cleanup(xmldoc)
         callout_cleanup(xmldoc)

data/lib/metanorma/standoc/cleanup_block.rb

@@ -66,7 +66,7 @@ module Metanorma
       def subfigure_cleanup(xmldoc)
         xmldoc.xpath("//example[figure]").each do |e|
           next unless e.elements.map(&:name).reject do |m|
-            %w(name figure).include? m
+            %w(name figure index).include? m
           end.empty?
 
           e.name = "figure"
@@ -178,6 +178,46 @@ module Metanorma
           end
         end
       end
+
+      def block_index_cleanup(xmldoc)
+        xmldoc.xpath("//quote | //td | //th | //formula | //li | //dt | "\
+                     "//dd | //example | //note | //figure | //sourcecode | "\
+                     "//admonition | //termnote | //termexample | //form  | "\
+                     "//requirement | //recommendation | //permission | "\
+                     "//imagemap | //svgmap").each do |b|
+          b.xpath("./p[indexterm]").each do |p|
+            indexterm_para?(p) or next
+            p.replace(p.children)
+          end
+        end
+      end
+
+      def indexterm_para?(para)
+        p = para.dup
+        p.xpath("./index").each(&:remove)
+        p.text.strip.empty?
+      end
+
+      def include_indexterm?(elem)
+        return false if elem.nil?
+
+        !%w(image literal sourcecode).include?(elem.name)
+      end
+
+      def para_index_cleanup(xmldoc)
+        xmldoc.xpath("//p[index]").select { |p| indexterm_para?(p) }
+          .each do |p|
+            para_index_cleanup1(p, p.previous_element, p.next_element)
+          end
+      end
+
+      def para_index_cleanup1(para, prev, foll)
+        if include_indexterm?(prev)
+          prev << para.remove.children
+        elsif include_indexterm?(foll) && !foll.children.empty?
+          foll.children.first.previous = para.remove.children
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_footnotes.rb

@@ -13,14 +13,16 @@ module Metanorma
         c.gsub(/ id="[^"]+"/, "")
       end
 
+      FIGURE_FN_XPATH =
+        "//figure/following-sibling::*[1][self::p and *[1][self::fn]]".freeze
+
       # include footnotes inside figure if they are the only content
       # of the paras following
       def figure_footnote_cleanup(xmldoc)
         nomatches = false
         until nomatches
-          q = "//figure/following-sibling::*[1][self::p and *[1][self::fn]]"
           nomatches = true
-          xmldoc.xpath(q).each do |s|
+          xmldoc.xpath(FIGURE_FN_XPATH).each do |s|
             next if s.children.map do |c|
                       c.text? && /[[:alpha:]]/.match(c.text)
                     end.any?
@@ -32,17 +34,17 @@ module Metanorma
         end
       end
 
-      def table_footnote_renumber1(fnote, i, seen)
+      def table_footnote_renumber1(fnote, idx, seen)
         content = footnote_content(fnote)
         if seen[content] then outnum = seen[content]
         else
-          i += 1
-          outnum = i
+          idx += 1
+          outnum = idx
           seen[content] = outnum
         end
         fnote["reference"] = (outnum - 1 + "a".ord).chr
         fnote["table"] = true
-        [i, seen]
+        [idx, seen]
       end
 
       def table_footnote_renumber(xmldoc)
@@ -55,18 +57,18 @@ module Metanorma
         end
       end
 
-      def other_footnote_renumber1(fn, i, seen)
-        unless fn["table"]
-          content = footnote_content(fn)
-          if seen[content] then outnum = seen[content]
-          else
-            i += 1
-            outnum = i
-            seen[content] = outnum
-          end
-          fn["reference"] = outnum.to_s
+      def other_footnote_renumber1(fnote, idx, seen)
+        return [idx, seen] if fnote["table"]
+
+        content = footnote_content(fnote)
+        if seen[content] then outnum = seen[content]
+        else
+          idx += 1
+          outnum = idx
+          seen[content] = outnum
         end
-        [i, seen]
+        fnote["reference"] = outnum.to_s
+        [idx, seen]
       end
 
       def other_footnote_renumber(xmldoc)

data/lib/metanorma/standoc/cleanup_ref.rb

@@ -80,6 +80,7 @@ module Metanorma
 
       def biblio_cleanup(xmldoc)
         biblio_reorder(xmldoc)
+        biblio_annex(xmldoc)
         biblio_nested(xmldoc)
         biblio_renumber(xmldoc)
         biblio_linkonly(xmldoc)
@@ -119,6 +120,16 @@ module Metanorma
         xmldoc.xpath("//bibitem/ext").each(&:remove)
       end
 
+      def biblio_annex(xmldoc)
+        xmldoc.xpath("//annex[references/references]").each do |t|
+          next unless t.xpath("./clause | ./references | ./terms").size == 1
+
+          r = t.at("./references")
+          r.xpath("./references").each { |b| b["normative"] = r["normative"] }
+          r.replace(r.elements)
+        end
+      end
+
       def biblio_nested(xmldoc)
         xmldoc.xpath("//references[references]").each do |t|
           t.name = "clause"
@@ -143,6 +154,11 @@ module Metanorma
       def reference_names(xmldoc)
         xmldoc.xpath("//bibitem[not(ancestor::bibitem)]").each do |ref|
           docid = ref.at("./docidentifier[@type = 'metanorma']") ||
+            ref.at("./docidentifier[@primary = 'true'][@language = '#{@lang}']") ||
+            ref.at("./docidentifier[@primary = 'true'][not(@language)]") ||
+            ref.at("./docidentifier[@primary = 'true']") ||
+            ref.at("./docidentifier[not(@type = 'DOI')][@language = '#{@lang}']") ||
+            ref.at("./docidentifier[not(@type = 'DOI')][not(@language)]") ||
             ref.at("./docidentifier[not(@type = 'DOI')]") or next
           reference = format_ref(docid.children.to_xml, docid["type"])
           @anchors[ref["id"]] = { xref: reference }

data/lib/metanorma/standoc/cleanup_section.rb

@@ -118,6 +118,12 @@ module Metanorma
         change_clauses(xml)
       end
 
+      def single_clause_annex(xml)
+        xml.xpath("//annex").each do |a|
+          single_clause_annex1(a)
+        end
+      end
+
       def obligations_cleanup(xml)
         obligations_cleanup_info(xml)
         obligations_cleanup_norm(xml)

data/lib/metanorma/standoc/cleanup_terms.rb

@@ -100,9 +100,13 @@ module Metanorma
         end
       end
 
+      def termlookup_cleanup(xmldoc)
+        Metanorma::Standoc::TermLookupCleanup.new(xmldoc, @log).call
+      end
+
       def termdef_cleanup(xmldoc)
         termdef_unnest_cleanup(xmldoc)
-        Metanorma::Standoc::TermLookupCleanup.new(xmldoc, @log).call
+        termlookup_cleanup(xmldoc)
         term_nonverbal_designations(xmldoc)
         term_dl_to_metadata(xmldoc)
         term_termsource_to_designation(xmldoc)
@@ -117,7 +121,7 @@ module Metanorma
         termdocsource_cleanup(xmldoc)
       end
 
-      def index_cleanup(xmldoc)
+      def term_index_cleanup(xmldoc)
         return unless @index_terms
 
         xmldoc.xpath("//preferred").each do |p|

data/lib/metanorma/standoc/cleanup_xref.rb

@@ -68,9 +68,10 @@ module Metanorma
       end
 
       def xref_to_eref(elem)
+        c = HTMLEntities.new
         elem["bibitemid"] = elem["target"]
         if ref = @anchors&.dig(elem["target"], :xref)
-          elem["citeas"] = HTMLEntities.new.encode(ref, :hexadecimal)
+          elem["citeas"] = c.decode(ref)
         else
           elem["citeas"] = ""
           xref_to_eref1(elem)

data/lib/metanorma/standoc/converter.rb

@@ -59,6 +59,8 @@ module Metanorma
         inline_macro Metanorma::Plugin::Lutaml::LutamlTableInlineMacro
         block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro
         block Metanorma::Standoc::ToDoAdmonitionBlock
+        block Metanorma::Standoc::EditorAdmonitionBlock
+        treeprocessor Metanorma::Standoc::EditorInlineAdmonitionBlock
         treeprocessor Metanorma::Standoc::ToDoInlineAdmonitionBlock
         block Metanorma::Standoc::PlantUMLBlockMacro
         block Metanorma::Plugin::Lutaml::LutamlDiagramBlock

data/lib/metanorma/standoc/isodoc.rng

@@ -69,6 +69,17 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="AdmonitionType">
+      <choice>
+        <value>warning</value>
+        <value>note</value>
+        <value>tip</value>
+        <value>important</value>
+        <value>caution</value>
+        <value>statement</value>
+        <value>editorial</value>
+      </choice>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -116,6 +127,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="suppress_identifier">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <ref name="BibliographicItem"/>
       </element>
     </define>
@@ -703,6 +719,9 @@
       <optional>
         <attribute name="tag"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="multilingual-rendering">
           <ref name="MultilingualRenderingType"/>
@@ -738,6 +757,9 @@
         <optional>
           <attribute name="tag"/>
         </optional>
+        <optional>
+          <attribute name="type"/>
+        </optional>
         <optional>
           <attribute name="multilingual-rendering">
             <ref name="MultilingualRenderingType"/>
@@ -2059,6 +2081,7 @@
       <value>compare</value>
       <value>contrast</value>
       <value>see</value>
+      <value>seealso</value>
     </choice>
   </define>
   <define name="deprecates">
@@ -2481,6 +2504,16 @@
           <text/>
         </element>
       </optional>
+      <optional>
+        <element name="amendment">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="corrigendum">
+          <text/>
+        </element>
+      </optional>
       <optional>
         <element name="language">
           <text/>

data/lib/metanorma/standoc/macros_note.rb

@@ -37,5 +37,31 @@ module Metanorma
         %{<footnoteblock>#{out}</footnoteblock>}
       end
     end
+
+    class EditorAdmonitionBlock < Asciidoctor::Extensions::BlockProcessor
+      use_dsl
+      named :EDITOR
+      on_contexts :example, :paragraph
+
+      def process(parent, reader, attrs)
+        attrs["name"] = "editorial"
+        attrs["caption"] = "EDITOR"
+        create_block(parent, :admonition, reader.lines, attrs,
+                     content_model: :compound)
+      end
+    end
+
+    class EditorInlineAdmonitionBlock < Asciidoctor::Extensions::Treeprocessor
+      def process(document)
+        (document.find_by context: :paragraph).each do |para|
+          next unless /^EDITOR: /.match? para.lines[0]
+
+          para.set_attr("name", "editorial")
+          para.set_attr("caption", "EDITOR")
+          para.lines[0].sub!(/^EDITOR: /, "")
+          para.context = :admonition
+        end
+      end
+    end
   end
 end

data/lib/metanorma/standoc/ref.rb

@@ -82,7 +82,8 @@ module Metanorma
       def isorefmatches3out(item, xml)
         if item[:doc] then use_retrieved_relaton(item, xml)
         else
-          isorefmatches3_1(xml, item[:ref][:match], item[:ref][:yr],
+          isorefmatches3_1(xml, item[:ref][:match],
+                           item[:ref][:yr],
                            item[:ref][:hasyr], item[:doc])
         end
       end
@@ -117,6 +118,7 @@ module Metanorma
 
       def refitem_render(xml, match, code)
         xml.bibitem **attr_code(id: match[:anchor],
+                                suppress_identifier: code[:dropid],
                                 hidden: code[:hidden]) do |t|
           t.formattedref **{ format: "application/x-isodoc+xml" } do |i|
             i << ref_normalise_no_format(match[:text])

data/lib/metanorma/standoc/ref_sect.rb

@@ -84,7 +84,8 @@ module Metanorma
         if ref[:code].nil? || ref[:no_year] || @bibdb.nil?
           res << [ref, idx, nil]
         else
-          @bibdb.fetch_async(ref[:code], ref[:year], ref) do |doc|
+          @bibdb.fetch_async(HTMLEntities.new.decode(ref[:code]),
+                             ref[:year], ref) do |doc|
             res << [ref, idx, doc]
           end
         end
@@ -119,7 +120,9 @@ module Metanorma
       def use_retrieved_relaton(item, xml)
         xml.parent.add_child(smart_render_xml(item[:doc], item[:ref][:code],
                                               item[:ref]))
-        use_my_anchor(xml, item[:ref][:match][:anchor], item.dig(:ref, :analyse_code, :hidden))
+        use_my_anchor(xml, item[:ref][:match][:anchor],
+                      hidden: item.dig(:ref, :analyse_code, :hidden),
+                      dropid: item.dig(:ref, :analyse_code, :dropid))
       end
 
       def init_bib_caches(node)

data/lib/metanorma/standoc/ref_utility.rb

@@ -31,9 +31,11 @@ module Metanorma
         end
       end
 
-      def use_my_anchor(ref, id, hidden)
+      def use_my_anchor(ref, id, opt)
         ref.parent.elements.last["id"] = id
-        hidden and ref.parent.elements.last["hidden"] = hidden
+        opt[:hidden] and ref.parent.elements.last["hidden"] = opt[:hidden]
+        opt[:dropid] and
+          ref.parent.elements.last["suppress_identifier"] = opt[:dropid]
         ref
       end
 
@@ -57,6 +59,7 @@ module Metanorma
 
       def mn_code(code)
         code.sub(/^\(/, "[").sub(/\).*$/, "]")
+          .sub(/^dropid\((.+)\)$/, "\\1")
           .sub(/^hidden\((.+)\)$/, "\\1")
           .sub(/^nofetch\((.+)\)$/, "\\1")
       end
@@ -73,6 +76,12 @@ module Metanorma
         ret.merge(id: m[:id], hidden: true)
       end
 
+      def analyse_ref_dropid(ret)
+        return ret unless m = /^dropid\((?<id>.+)\)$/.match(ret[:id])
+
+        ret.merge(id: m[:id], dropid: true)
+      end
+
       def analyse_ref_repo_path(ret)
         return ret unless m =
                             /^(?<type>repo|path):\((?<key>[^,]+),?(?<id>.*)\)$/
@@ -89,14 +98,16 @@ module Metanorma
       end
 
       # ref id = (usrlbl)code[:-]year
-      # code = nofetch(code) | hidden(code) | (repo|path):(key,code) |
+      # code = nofetch(code) | hidden(code) | dropid(code) | (repo|path):(key,code) |
       # \[? number \]? | ident
       def analyse_ref_code(code)
         ret = { id: code }
         return ret if code.blank?
 
-        analyse_ref_nofetch(
-          analyse_ref_hidden(analyse_ref_repo_path(analyse_ref_numeric(ret))),
+        analyse_ref_numeric(
+          analyse_ref_repo_path(
+            analyse_ref_dropid(analyse_ref_hidden(analyse_ref_nofetch(ret))),
+          ),
         )
       end
 
@@ -110,7 +121,10 @@ module Metanorma
       end
 
       def ref_attributes(match)
-        { id: match[:anchor], type: "standard" }
+        code = analyse_ref_code(match[:code])
+
+        { id: match[:anchor], type: "standard",
+          suppress_identifier: code[:dropid] || nil }
       end
 
       MALFORMED_REF = <<~REF.freeze

data/lib/metanorma/standoc/section.rb

@@ -38,6 +38,8 @@ module Metanorma
         when "symbols and abbreviated terms",
           "symbols", "abbreviated terms", "abbreviations"
           "symbols and abbreviated terms"
+        when "acknowledgements", "acknowledgments"
+          "acknowledgements"
         else
           ret
         end
@@ -152,7 +154,7 @@ module Metanorma
         attrs[:bibitem] = true if node.option? "bibitem"
         attrs[:level] = node.attr("level")
         set_obligation(attrs, node)
-        xml.send "clause", **attr_code(attrs) do |xml_section|
+        xml.send :clause, **attr_code(attrs) do |xml_section|
           xml_section.title { |n| n << node.title } unless node.title.nil?
           xml_section << node.content
         end