metanorma-standoc 3.0.7 → 3.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab57258611b63bcabb64f17d1fe44bf74d8169ffd707ce96db6fa4f074a0f007
-  data.tar.gz: 3c39749483d8687dbcaea874d3d1e37a90b61e54d45fba10346025eef2378a7a
+  metadata.gz: 4234211796c2c39d12d6bf987d799c6cc5c65745105540ca7e2078794ed38511
+  data.tar.gz: 3785018f24e1689ff70f7ad53dd4a82ec86e845815f939edecf08562aa57d7c4
 SHA512:
-  metadata.gz: c0cff4afac83b0a64838f23be4895f3dc6b5f02d986fd6d08706cb2dd8fc03ef2f5a446bb06e81c3a5a3d30a1a086a3e703af6d074f8dc14f0a93d524407334a
-  data.tar.gz: 37ebfa958164eca83ddd835efbb50da1d36b7fcba0dc0c350abbf0da3833a132bfc9680c036367ff288c9163230e5c0a7852cded007c9ac50d73fe2117b3bade
+  metadata.gz: 7655c4607ed54692a82c533a29345f9f89f5ba6b506b3137d225e27ae47717d303abd17ddae1488b627b4b5a998e486f5b11db9c64fee6871f5f5aee2139feea
+  data.tar.gz: 5730669dbca0c7bf59204fb88464e382b67c0c2e4a7a6cbce6acb8b5e84c84d83112beebc7f8f2e2df6824ca41d9dda042fb621345d2b86cbc909d89d8601fcf

data/lib/isodoc/html/htmlstyle.css

@@ -320,8 +320,6 @@ h6:hover > a.anchor,
 
 svg {
   width: 100%;
-  padding-bottom: 92%;
-  height: 1px;
   overflow: visible;
 }
 

data/lib/metanorma/standoc/anchor.rb

@@ -14,7 +14,7 @@ module Metanorma
 
       def inline_anchor_ref(node)
         noko do |xml|
-          xml.bookmark nil, **attr_code(id: node.id)
+          xml.bookmark nil, **attr_code(id_attr(node))
         end
       end
 

data/lib/metanorma/standoc/base.rb

@@ -59,7 +59,7 @@ module Metanorma
             thead|tbody|tfoot|th|td|form|requirement|recommendation|permission|
             imagemap|svgmap|preferred|admitted|related|domain|deprecates|
             letter-symbol|graphical-symbol|expression|subject|abbreviation-type|
-            pronunciation|grammar|term|terms|termnote|termexample|termsource|
+            pronunciation|grammar|term|terms|termnote|termexample|source|
             origin|termref|modification)>)}x, "\\1\n")
           .gsub(%r{(<(title|name))}, "\n\\1")
           .gsub(%r{(<sourcecode[^<>]*>)\s+(<name[^<>]*>[^<]+</name>)\s+},

data/lib/metanorma/standoc/basicdoc.rng

@@ -267,6 +267,10 @@ in a document (e.g. sourcecode annotations)</a:documentation>
       <value>justified</value>
     </choice>
   </define>
+  <define name="IdRefType">
+    <a:documentation>Type of cross-references to elements. In BasicDoc, these always point to id { xsd:ID } </a:documentation>
+    <data type="IDREF"/>
+  </define>
   <define name="RequiredId">
     <a:documentation>Mandatory anchor of element, to be used for cross-references within the document</a:documentation>
     <attribute name="id">
@@ -409,13 +413,13 @@ in a document (e.g. sourcecode annotations)</a:documentation>
       <attribute name="from">
         <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
 If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
     </optional>
     <optional>
       <attribute name="to">
         <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
     </optional>
   </define>
@@ -1504,7 +1508,7 @@ Restricted recursively to contain only other such inline elements with no identi
         <attribute name="to">
           <a:documentation>A reference to an anchor element (typically a bookmark), 
 to indicate that the index range covers a range of locations between the current index element and the `to` anchor</a:documentation>
-          <data type="IDREF"/>
+          <ref name="IdRefType"/>
         </attribute>
       </optional>
       <ref name="index-primary">
@@ -1662,7 +1666,7 @@ which can be bookmarks as well as block or section references</a:documentation>
   <define name="XrefAttributes">
     <attribute name="target">
       <a:documentation>The identifier of a section, block or inlined element being referenced</a:documentation>
-      <data type="IDREF"/>
+      <ref name="IdRefType"/>
     </attribute>
     <optional>
       <attribute name="type">
@@ -1723,7 +1727,7 @@ The target of a footnote is the location it is embedded in within the text</a:do
       <attribute name="target">
         <a:documentation>The target of the callout is understood to be the location of the callout within the source code; 
 the extent of the target is not expressed overtly</a:documentation>
-        <data type="IDREF"/>
+        <ref name="IdRefType"/>
       </attribute>
       <text>
         <a:documentation>The label of the callout, used to identify its target within the source code</a:documentation>

data/lib/metanorma/standoc/blocks.rb

@@ -6,10 +6,13 @@ module Metanorma
   module Standoc
     module Blocks
       def id_attr(node = nil)
-        { id: Metanorma::Utils::anchor_or_uuid(node),
+        anchor = node&.id
+        { id: "_#{UUIDTools::UUID.random_create}",
+          anchor: anchor && !anchor.empty? ? anchor : nil,
           tag: node&.attr("tag"),
           columns: node&.attr("columns"),
           "multilingual-rendering": node&.attr("multilingual-rendering") }
+          .compact
       end
 
       def id_unnum_attrs(node)
@@ -66,9 +69,9 @@ module Metanorma
         noko do |xml|
           xml.figure **literal_attrs(node) do |f|
             figure_title(node, f)
-            f.pre node.lines.join("\n"),
-                  **attr_code(id: Metanorma::Utils::anchor_or_uuid,
-                              alt: node.attr("alt"))
+            pre_attrs = id_attr(node).tap { |h| h.delete(:anchor) }
+              .merge(alt: node.attr("alt"))
+            f.pre node.lines.join("\n"), **attr_code(pre_attrs)
           end
         end
       end
@@ -229,7 +232,7 @@ module Metanorma
 
       # need to validate Metanorma XML before it passes to textcleanup,
       # where passthrough wrapper and escaped tags are removed:
-      # <passthrough format="metanorma>&lt;tag&gt</passthrough> => <tag>
+      # <passthrough formats="metanorma>&lt;tag&gt</passthrough> => <tag>
       # Do not treat not well-formed XML as invalid,
       # as it may be fragment, e.g. unterminated start of element markup
       def passthrough_validate(node, content, encoded_content)

data/lib/metanorma/standoc/blocks_image.rb

@@ -2,11 +2,7 @@ module Metanorma
   module Standoc
     module Blocks
       def svgmap_attrs(node)
-        attr_code(id_attr(node)
-          .merge(id: node.id, number: node.attr("number"),
-                 unnumbered: node.option?("unnumbered") ? "true" : nil,
-                 subsequence: node.attr("subsequence"))
-        .merge(keep_attrs(node)))
+        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
       end
 
       def svgmap_example(node)
@@ -44,7 +40,7 @@ module Metanorma
         noko do |xml|
           xml.figure **figure_attrs(node) do |f|
             figure_title(node, f)
-            f.image **image_attributes(node)
+            f.image **(image_attributes(node).tap { |h| h.delete(:anchor) })
           end
         end
       end

data/lib/metanorma/standoc/blocks_notes.rb

@@ -2,11 +2,8 @@ module Metanorma
   module Standoc
     module Blocks
       def termnote_attrs(node)
-        attr_code(id_attr(node).merge(keep_attrs(node)
+        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)
           .merge(
-            unnumbered: node.attr("unnumbered"),
-            number: node.attr("number"),
-            subsequence: node.attr("subsequence"),
             "keep-separate": node.attr("keep-separate"),
             keepasterm: node.option?("termnote") ? "true" : nil,
           )))
@@ -61,8 +58,7 @@ module Metanorma
       end
 
       def note(node)
-        return termnote(node) if node.option?("termnote")
-
+        node.option?("termnote") and return termnote(node)
         noko do |xml|
           xml.note **note_attrs(node) do |c|
             wrap_in_para(node, c)

data/lib/metanorma/standoc/cleanup.rb

@@ -29,10 +29,12 @@ module Metanorma
       def cleanup(xmldoc)
         @doctype = xmldoc.at("//bibdata/ext/doctype")&.text
         element_name_cleanup(xmldoc)
-        passthrough_cleanup(xmldoc)
+        source_include_cleanup(xmldoc) # feeds: misccontainer_cleanup
+        passthrough_cleanup(xmldoc) # feeds: smartquotes_cleanup
         unnumbered_blocks_cleanup(xmldoc)
         termdocsource_cleanup(xmldoc) # feeds: metadata_cleanup
         metadata_cleanup(xmldoc) # feeds: boilerplate_cleanup
+        misccontainer_cleanup(xmldoc)
         sections_cleanup(xmldoc) # feeds: obligations_cleanup, toc_cleanup,
         # floatingtitle_cleanup
         obligations_cleanup(xmldoc)
@@ -89,10 +91,12 @@ module Metanorma
         linebreak_cleanup(xmldoc)
         variant_cleanup(xmldoc)
         para_cleanup(xmldoc)
+        source_id_cleanup(xmldoc)
         empty_element_cleanup(xmldoc)
         img_cleanup(xmldoc)
         anchor_cleanup(xmldoc)
         link_cleanup(xmldoc)
+        passthrough_metanorma_cleanup(xmldoc)
         xmldoc
       end
 

data/lib/metanorma/standoc/cleanup_amend.rb

@@ -8,8 +8,8 @@ module Metanorma
       end
 
       def create_amend(clause)
-        a = clause.add_child("<amend id='_#{UUIDTools::UUID.random_create}'/>")
-          .first
+        a = clause.add_child("<amend/>").first
+        add_id(a)
         clause.elements.each do |e|
           e.parent = a unless %w(amend title).include? e.name
         end
@@ -32,8 +32,8 @@ module Metanorma
           amend.children = "<description>#{amend.children.to_xml}</description>"
           return
         end
-        pre = q.xpath("./preceding-sibling::*")&.remove
-        post = q.xpath("./following-sibling::*")&.remove
+        pre = q.xpath("./preceding-sibling::*").each(&:remove)
+        post = q.xpath("./following-sibling::*").each(&:remove)
         pre.empty? or amend << "<description>#{pre.to_xml}</description>"
         amend << q.remove
         post.empty? or amend << "<description>#{post.to_xml}</description>"
@@ -41,13 +41,11 @@ module Metanorma
 
       def move_attrs_to_amend(clause, amend)
         %w(change path path_end title).each do |e|
-          next unless clause[e]
-
+          clause[e] or next
           amend[e] = clause[e]
           clause.delete(e)
         end
-        return unless amend["locality"]
-
+        amend["locality"] or return
         loc = amend.children.add_previous_sibling("<location/>")
         extract_localities1(loc, amend["locality"])
         loc1 = loc.at("./localityStack") and loc.replace(loc1.elements)

data/lib/metanorma/standoc/cleanup_asciibib.rb

@@ -1,4 +1,3 @@
-require "set"
 require "relaton_bib"
 
 module Metanorma
@@ -8,17 +7,24 @@ module Metanorma
         xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
           bib = dl_bib_extract(c) or next
           validate_ref_dl(bib, c)
-          bibitemxml = RelatonBib::BibliographicItem.from_hash(bib).to_xml or next
-          bibitem = Nokogiri::XML(bibitemxml)
-          bibitem.root["id"] = c["id"] if c["id"] && !/^_/.match(c["id"])
+          xml = RelatonBib::BibliographicItem.from_hash(bib).to_xml or next
+          bibitem = Nokogiri::XML(xml)
+          ref_dl_cleanup_id(bibitem.root, c)
           c.replace(bibitem.root)
         end
       end
 
+      def ref_dl_cleanup_id(bibitem, clause)
+        bibitem["anchor"] = bibitem["id"]
+        clause["anchor"] && !/^_/.match(clause["anchor"]) and
+          bibitem["anchor"] = clause["anchor"]
+        add_id(bibitem)
+      end
+
       # do not accept implicit id
       def validate_ref_dl(bib, clause)
         id = bib["id"]
-        id ||= clause["id"] unless /^_/.match?(clause["id"])
+        id ||= clause["anchor"] unless /^_/.match?(clause["anchor"])
         unless id
           @log.add("Anchors", clause,
                    "The following reference is missing an anchor:\n" \
@@ -57,8 +63,7 @@ module Metanorma
       end
 
       def dd_bib_extract(dtd)
-        return nil if dtd.children.empty?
-
+        dtd.children.empty? and return nil
         dtd.at("./dl") and return dl_bib_extract(dtd)
         elems = dtd.remove.elements
         return p_unwrap(dtd) unless elems.size == 1 &&
@@ -74,7 +79,7 @@ module Metanorma
       end
 
       # definition list, with at most one level of unordered lists
-      def dl_bib_extract(clause, nested = false)
+      def dl_bib_extract(clause, nested: false)
         dl = clause.at("./dl") or return
         key = ""
         bib = dl.xpath("./dt | ./dd").each_with_object({}) do |dtd, m|
@@ -82,10 +87,9 @@ module Metanorma
           add_to_hash(m, key, dd_bib_extract(dtd))
         end
         clause.xpath("./clause").each do |c1|
-          key = c1&.at("./title")&.text&.downcase&.strip
-          next unless %w(contributor relation series).include? key
-
-          add_to_hash(bib, key, dl_bib_extract(c1, true))
+          key = c1.at("./title")&.text&.downcase&.strip
+          %w(contributor relation series).include?(key) or next
+          add_to_hash(bib, key, dl_bib_extract(c1, nested: true))
         end
         dl_bib_extract_title(bib, clause, nested)
       end
@@ -96,7 +100,7 @@ module Metanorma
         bib["title"] = [bib["title"]] if bib["title"].is_a?(Hash) ||
           bib["title"].is_a?(String)
         bib["title"] ||= []
-        bib["title"] << title if !title.empty?
+        title.empty? or bib["title"] << title
         bib
       end
     end

data/lib/metanorma/standoc/cleanup_bibdata.rb

@@ -25,6 +25,7 @@ module Metanorma
       def bibdata_anchor_cleanup(xmldoc)
         xmldoc.xpath("//bibdata//bibitem | //bibdata//note").each do |b|
           b.delete("id")
+          b.delete("anchor")
         end
       end
 
@@ -51,7 +52,7 @@ module Metanorma
         i = i.add_child("<references hidden='true' normative='false'/>").first
         refs.each do |x|
           i << <<~BIB
-            <bibitem id="#{x}" type="internal">
+            <bibitem anchor="#{x}" id="_#{UUIDTools::UUID.random_create}" type="internal">
             <docidentifier type="repository">#{x.sub(/^#{prefix}_/, "#{prefix}/")}</docidentifier>
             </bibitem>
           BIB
@@ -67,27 +68,19 @@ module Metanorma
         eref.delete("citeas")
         eref["target"] = loc
         if id_map
-          return if id_map.has_key?(loc)
+          id_map.has_key?(loc) and return
         else
-          eref.document.at("//*[@id = '#{loc}']") and return
+          eref.document.at("//*[@anchor = '#{loc}']") and return
         end
         eref.children = %(** Missing target #{loc})
         eref["target"] = ident
       end
 
       def resolve_local_indirect_erefs(xmldoc, refs, prefix)
-        # Pre-index elements by ID
-        id_map = xmldoc.xpath("//*[@id]").each_with_object({}) do |node, map|
-          map[node["id"]] = node
-        end
-
-        # Pre-index all <eref> elements by bibitemid
-        eref_map = xmldoc.xpath("//eref[@bibitemid]").group_by { |e| e["bibitemid"] }
-
+        id_map, eref_map = resolve_local_indirect_erefs_prep(xmldoc)
         refs.each_with_object([]) do |r, m|
           id = r.sub(/^#{prefix}_/, "")
-          n = id_map[id]
-          if n&.at("./ancestor-or-self::*[@type = '#{prefix}']")
+          if id_map[id]&.at("./ancestor-or-self::*[@type = '#{prefix}']")
             eref_map[r]&.each do |e|
               indirect_eref_to_xref(e, id, id_map)
             end
@@ -96,6 +89,19 @@ module Metanorma
         end
       end
 
+      def resolve_local_indirect_erefs_prep(xmldoc)
+        # Pre-index elements by anchor
+        # (which is what bibitemid currently points to)
+        id_map = xmldoc.xpath("//*[@anchor]")
+          .each_with_object({}) do |node, map|
+          map[node["anchor"]] = node
+        end
+        # Pre-index all <eref> elements by bibitemid
+        eref_map = xmldoc.xpath("//eref[@bibitemid]")
+          .group_by { |e| e["bibitemid"] }
+        [id_map, eref_map]
+      end
+
       def biblio_indirect_erefs(xmldoc, prefixes)
         prefixes&.each do |prefix|
           refs = gather_indirect_erefs(xmldoc, prefix)

data/lib/metanorma/standoc/cleanup_bibitem.rb

@@ -64,11 +64,11 @@ module Metanorma
 
       def reference_names(xmldoc)
         xmldoc.xpath("//bibitem[not(ancestor::bibitem)]").each do |ref|
-          @anchors[ref["id"]] =
+          @anchors[ref["anchor"]] =
             if docid = select_docid(ref)
               reference = format_ref(docid.children.to_xml, docid["type"])
               { xref: reference, id: idtype2cit(ref) }
-            else { xref: ref["id"], id: { "" => ref["id"] } }
+            else { xref: ref["anchor"], id: { "" => ref["anchor"] } }
             end
         end
       end
@@ -123,6 +123,7 @@ module Metanorma
           uri = b&.at("./uri[@type = 'citation']")&.text
           bibitem = read_local_bibitem(uri) or next
           bibitem["id"] = b["id"]
+          bibitem["anchor"] = b["anchor"]
           b.replace(bibitem)
         end
       end
@@ -130,9 +131,11 @@ module Metanorma
       def bibitem_nested_id(xmldoc)
         xmldoc.xpath("//bibitem//bibitem").each do |b|
           b.delete("id")
+          b.delete("anchor")
         end
         xmldoc.xpath("//bibdata//bibitem").each do |b|
           b.delete("id")
+          b.delete("anchor")
         end
       end
 
@@ -211,11 +214,11 @@ module Metanorma
       end
 
       def bibitem_id_docid_hash(xmldoc)
-        xmldoc.xpath("//bibitem[@id]").each_with_object({}) do |b, m|
-          m[b["id"]] ||= {}
+        xmldoc.xpath("//bibitem[@anchor]").each_with_object({}) do |b, m|
+          m[b["anchor"]] ||= {}
           docid = b.at("./docidentifier")&.text || "NO ID"
-          m[b["id"]][docid] ||= []
-          m[b["id"]][docid] << b
+          m[b["anchor"]][docid] ||= []
+          m[b["anchor"]][docid] << b
         end
       end
 

data/lib/metanorma/standoc/cleanup_block.rb

@@ -17,7 +17,7 @@ module Metanorma
 
       def inject_id(xmldoc, path)
         xmldoc.xpath(path).each do |x|
-          x["id"] ||= Metanorma::Utils::anchor_or_uuid
+          x["id"] or add_id(x)
         end
       end
 
@@ -112,8 +112,9 @@ module Metanorma
 
       def link_callouts_to_annotations(callouts, annotations)
         callouts.each_with_index do |c, i|
-          c["target"] = "_#{UUIDTools::UUID.random_create}"
-          annotations[i]["id"] = c["target"]
+          add_id(annotations[i])
+          annotations[i]["anchor"] = annotations[i]["id"]
+          c["target"] = annotations[i]["id"]
         end
       end
 
@@ -224,8 +225,7 @@ module Metanorma
       end
 
       def blocksource_cleanup(xmldoc)
-        xmldoc.xpath("//figure//termsource | //table//termsource").each do |s|
-          s.name = "source"
+        xmldoc.xpath("//figure//source | //table//source").each do |s|
           s.delete("type")
         end
       end
@@ -233,7 +233,7 @@ module Metanorma
       def unnumbered_blocks_cleanup(xmldoc)
         @blockunnumbered&.each do |b|
           xmldoc.xpath("//#{b}").each do |e|
-            /^[^_]/.match?(e["id"]) and e["unnumbered"] = "false"
+            /^[^_]/.match?(e["anchor"]) and e["unnumbered"] = "false"
             e["unnumbered"] ||= "true"
           end
         end

data/lib/metanorma/standoc/cleanup_boilerplate.rb

@@ -151,8 +151,10 @@ module Metanorma
         if user_add.at("./clause") then built_in << user_add.children
         else
           user_add.name = "clause"
-          user_add["id"].nil? || uuid?(user_add["id"]) and
-            user_add["id"] = "_boilerplate-#{statement}-statement-append"
+          if user_add["id"].nil? || uuid?(user_add["id"])
+            user_add["anchor"] = "_boilerplate-#{statement}-statement-append"
+            add_id(user_add)
+          end
           built_in << user_add
         end
       end
@@ -187,8 +189,7 @@ module Metanorma
         xml.traverse do |n|
           n.element? or next
           n.namespace.href == ns and n.namespace = nil
-          /^_\d+$/.match?(n["id"]) and
-            n["id"] = "_#{UUIDTools::UUID.random_create}"
+          /^_\d+$/.match?(n["id"]) and add_id(n)
         end
         xml
       end

data/lib/metanorma/standoc/cleanup_footnotes.rb

@@ -1,5 +1,3 @@
-require "date"
-require "htmlentities"
 require "json"
 
 module Metanorma
@@ -97,7 +95,7 @@ module Metanorma
         ids = xmldoc.xpath("//footnoteblock").each_with_object([]) do |f, m|
           f.name = "fn"
           m << f.text
-          if id = xmldoc.at("//*[@id = '#{f.text}']")
+          if id = xmldoc.at("//*[@anchor = '#{f.text}']")
             f.children = id.dup.children
           else footnote_block_error(f)
           end
@@ -107,7 +105,7 @@ module Metanorma
 
       def footnote_block_remove(xmldoc, ids)
         ids.each do |id|
-          n = xmldoc.at("//*[@id = '#{id}']") and
+          n = xmldoc.at("//*[@anchor = '#{id}']") and
             n.remove
         end
       end

data/lib/metanorma/standoc/cleanup_image.rb

@@ -15,9 +15,9 @@ module Metanorma
           f = s.at(".//figure") or next
           (t = s.at("./name")) && !f.at("./name") and
             f.children.first.previous = t.remove
-          if s["id"] && Metanorma::Utils::guid_anchor?(f["id"])
-            f["id"] = s["id"]
-            s.delete("id")
+          if s["anchor"] # && Metanorma::Utils::guid_anchor?(f["id"])
+            f["anchor"] = s["anchor"]
+            s.delete("anchor")
           end
           svgmap_moveattrs1(s, f)
         end