metanorma-standoc 1.10.7 → 1.10.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90fb9b89f2c7070b763519843f307f4d3ecebb8ee462d7017afb886a397de8a8
-  data.tar.gz: b6f2e8253577f05a76e833d3a1e5d9f64fd47a7de48d8ec6703056b04965096a
+  metadata.gz: 2cc836755aed6cfff989fdcbc9cf8123ccfda29418247d93fdd75ba71660cee7
+  data.tar.gz: d1c051429283a6e4153a6a3453b839786561c0975c2acda0586cb0ca787ae26a
 SHA512:
-  metadata.gz: 17eb330f74f079b78db600f8030c15e497b6e0b1251157b9499cf532974280e6d4bb61ebe7d4c52cc443ca4d407371b575f6425783aa384e4c977733de528c5e
-  data.tar.gz: f3063d8116e77c1e00cf6f9ba12668e5bfbb581d41e02e9d4c4fee2dc21884754f8102a718d7318d3b0619abaf1715528162e9aebcb97895a7ab85bbeb6fccd4
+  metadata.gz: 1e17a3351bf46679b587a82498d5f58d97e43743bd2e6906c929aa8dcbb8ca29fdd6e38acb82252375b40e5fff520f7d6a001b023c9c79681ad61fea949c0799
+  data.tar.gz: 01dd1e74b7990b44c526616611155067c0725b0b0bcaeebe9d728c341d26acdab64c2c5be7519b22b94fd641015aec504c333c3b3da8cf6067c19999c20ab0ff

data/README.adoc

@@ -10,26 +10,24 @@ Gem for serialising the https://github.com/metanorma/metanorma-model-standoc[Met
 
 == Functionality
 
-This gem processes Metanorma documents following a template for generating standards documents, according
-to a range of standards classes. This gem provides underlying generic functionality; behaviour specific
-to each standards class is refined in the gem specific to that standards class (e.g. https://github.com/metanorma/metanorma-iso).
-The following outputs are generated.
-
-* Metanorma XML representation of the document, intended as a document model for 
-Standards. The Metanorma XML representation is processed in turn, to generate one or more of 
-the following outputs as end deliverables, depending on each standards class gem:
-* Microsoft Word output (`.doc`)
-* HTML output (`.html`)
-* PDF (`.pdf`)
+This gem processes Metanorma AsciiDoc input into the Metanorma document model.
+This gem provides underlying generic functionality; behaviour specific
+to each standards class is refined in the gem specific to that standards class
+(e.g. https://github.com/metanorma/metanorma-iso[Metanorma ISO]).
+
+The following outputs are generated:
+
+* Metanorma semantic XML
+* Metanorma presentation XML
+
+These Metanorma XML representations are processed downstream by the `isodoc` gem
+to generate other end deliverables, depending on each standards class.
 
 The following input formats are supported:
 
-* http://asciidoctor.org/[Asciidoctor]
+* Metanorma AsciiDoc
 
-This README provides an overview of the functionality of the gem; see also
-https://github.com/metanorma/metanorma-iso/blob/master/docs/guidance.adoc[Guidance for authoring].
-https://github.com/metanorma/metanorma-iso/blob/master/docs/quickstart.adoc[Quickstart guide]
-gives a summary overview.
+See the https://www.metanorma.org[Metanorma website] for more information.
 
 NOTE: http://asciimath.org[AsciiMathML] is used for mathematical formatting.
 The gem uses the https://github.com/asciidoctor/asciimath[Ruby AsciiMath parser],
@@ -39,21 +37,19 @@ expressions.
 
 === Installation
 
-If you are using a Mac, the https://github.com/metanorma/metanorma-macos-setup
-repository has instructions on setting up your machine to run Metanorma
-scripts such as this one. You need only run the following in a Terminal console:
+See the https://www.metanorma.org[Metanorma website] for instructions.
+
+In the terminal:
 
 [source,console]
 ----
-$ bash <(curl -s https://raw.githubusercontent.com/metanorma/metanorma-macos-setup/master/metanorma-setup)
 $ gem install metanorma-standoc
 $ gem install metanorma-cli 
 ----
 
-The metanorma-cli gem is the command-line interface for the Metanorma tool suite
+`metanorma-cli` is the command-line interface for the Metanorma suite
 (incorporating the `metanorma` executable seen above).
 
 == Documentation
 
-See http://metanorma.com[]
-
+See the https://www.metanorma.org[Metanorma website] for details.

data/lib/asciidoctor/standoc/base.rb

@@ -46,6 +46,7 @@ module Asciidoctor
           bare: node.attr("bare"),
           sectionsplit: node.attr("sectionsplit"),
           baseassetpath: node.attr("base-asset-path"),
+          aligncrosselements: node.attr("align-cross-elements"),
         }
       end
 
@@ -81,6 +82,7 @@ module Asciidoctor
           suppressasciimathdup: node.attr("suppress-asciimath-dup"),
           bare: node.attr("bare"),
           baseassetpath: node.attr("base-asset-path"),
+          aligncrosselements: node.attr("align-cross-elements"),
         }
 
         if font_manifest_file = node.attr("mn2pdf-font-manifest-file")

data/lib/asciidoctor/standoc/basicdoc.rng

@@ -624,6 +624,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -634,6 +637,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -641,7 +647,12 @@
   <define name="tt">
     <element name="tt">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -822,7 +833,9 @@
       <attribute name="alt"/>
     </optional>
     <ref name="CitationType"/>
-    <text/>
+    <oneOrMore>
+      <ref name="PureTextElement"/>
+    </oneOrMore>
   </define>
   <define name="hyperlink">
     <element name="link">
@@ -835,7 +848,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="xref">
@@ -849,7 +864,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="fn">

data/lib/asciidoctor/standoc/blocks.rb

@@ -6,14 +6,17 @@ module Asciidoctor
   module Standoc
     module Blocks
       def id_attr(node = nil)
-        { id: Metanorma::Utils::anchor_or_uuid(node) }
+        { id: Metanorma::Utils::anchor_or_uuid(node),
+          tag: node&.attr("tag"),
+          "multilingual-rendering": node&.attr("multilingual-rendering") }
       end
 
       def id_unnum_attrs(node)
-        attr_code(id: Metanorma::Utils::anchor_or_uuid(node),
-                  unnumbered: node.option?("unnumbered") ? "true" : nil,
-                  number: node.attr("number"),
-                  subsequence: node.attr("subsequence"))
+        attr_code(id_attr(node).merge(
+                    unnumbered: node.option?("unnumbered") ? "true" : nil,
+                    number: node.attr("number"),
+                    subsequence: node.attr("subsequence"),
+                  ))
       end
 
       def formula_attrs(node)
@@ -43,10 +46,9 @@ module Asciidoctor
 
       def form(node)
         noko do |xml|
-          xml.form **attr_code(
-            id: Metanorma::Utils::anchor_or_uuid, class: node.attr("class"),
-            name: node.attr("name"), action: node.attr("action")
-          ) do |f|
+          xml.form **attr_code(id_attr(node)
+            .merge(class: node.attr("class"),
+                   name: node.attr("name"), action: node.attr("action"))) do |f|
             f << node.content
           end
         end
@@ -78,7 +80,7 @@ module Asciidoctor
 
       def term_example(node)
         noko do |xml|
-          xml.termexample **id_attr(node) do |ex|
+          xml.termexample **attr_code(id_attr(node)) do |ex|
             wrap_in_para(node, ex)
           end
         end.join("\n")
@@ -100,10 +102,11 @@ module Asciidoctor
       end
 
       def svgmap_attrs(node)
-        attr_code({ id: node.id,
-                    unnumbered: node.option?("unnumbered") ? "true" : nil,
-                    number: node.attr("number"),
-                    subsequence: node.attr("subsequence") }
+        attr_code(id_attr(node)
+          .merge(id: node.id,
+                 unnumbered: node.option?("unnumbered") ? "true" : nil,
+                 number: node.attr("number"),
+                 subsequence: node.attr("subsequence"))
         .merge(keep_attrs(node)))
       end
 
@@ -162,11 +165,10 @@ module Asciidoctor
       end
 
       def para_attrs(node)
-        attr_code(keep_attrs(node)
+        attr_code(id_attr(node).merge(keep_attrs(node)
           .merge(align: node.attr("align"),
                  variant_title: node.role == "variant-title" ? true : nil,
-                 type: node.attr("type"),
-                 id: Metanorma::Utils::anchor_or_uuid(node)))
+                 type: node.attr("type"))))
       end
 
       def paragraph(node)
@@ -180,9 +182,8 @@ module Asciidoctor
       end
 
       def quote_attrs(node)
-        attr_code(keep_attrs(node)
-          .merge(align: node.attr("align"),
-                 id: Metanorma::Utils::anchor_or_uuid(node)))
+        attr_code(id_attr(node).merge(keep_attrs(node))
+          .merge(align: node.attr("align")))
       end
 
       def quote_attribution(node, out)
@@ -206,12 +207,11 @@ module Asciidoctor
       end
 
       def listing_attrs(node)
-        attr_code(keep_attrs(node)
+        attr_code(id_attr(node).merge(keep_attrs(node)
                   .merge(lang: node.attr("language"),
-                         id: Metanorma::Utils::anchor_or_uuid(node),
                          unnumbered: node.option?("unnumbered") ? "true" : nil,
                          number: node.attr("number"),
-                         filename: node.attr("filename")))
+                         filename: node.attr("filename"))))
       end
 
       # NOTE: html escaping is performed by Nokogiri

data/lib/asciidoctor/standoc/blocks_notes.rb

@@ -2,24 +2,21 @@ module Asciidoctor
   module Standoc
     module Blocks
       def termnote_attrs(node)
-        attr_code(
-          id_attr(node).merge(
+        attr_code(id_attr(node).merge(keep_attrs(node)
+          .merge(
             unnumbered: node.attr("unnumbered"),
             number: node.attr("number"),
             subsequence: node.attr("subsequence"),
-            "keep-with-next": node.attr("keep-with-next"),
-            "keep-lines-together": node.attr("keep-with-next"),
-            "keep-separate": node.attr("keep-separate")
-          )
-        )
+            "keep-separate": node.attr("keep-separate"),
+          )))
       end
 
       def note_attrs(node)
         attr_code(
           termnote_attrs(node).merge(
             type: node.attr("type"),
-            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil
-          )
+            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil,
+          ),
         )
       end
 
@@ -27,8 +24,8 @@ module Asciidoctor
         todo_attrs(node).merge(
           attr_code(
             from: node.attr("from"),
-            to: node.attr("to") || node.attr("from")
-          )
+            to: node.attr("to") || node.attr("from"),
+          ),
         )
       end
 
@@ -45,11 +42,10 @@ module Asciidoctor
       def todo_attrs(node)
         date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
         date += "T00:00:00Z" unless /T/.match? date
-        attr_code(
-          id: ::Metanorma::Utils::anchor_or_uuid(node),
-          reviewer: node.attr("reviewer") || node.attr("source") || "(Unknown)",
-          date: date
-        )
+        attr_code(id_attr(node)
+          .merge(reviewer: node.attr("reviewer") || node.attr("source") ||
+                 "(Unknown)",
+                 date: date))
       end
 
       def todo(node)
@@ -81,12 +77,11 @@ module Asciidoctor
         a = node.attr("type") and ["danger", "safety precautions"].each do |t|
           name = t if a.casecmp(t).zero?
         end
-        attr_code(
-          keep_attrs(node).merge(
-            id: Metanorma::Utils::anchor_or_uuid(node), type: name,
-            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil
-          )
-        )
+        attr_code(keep_attrs(node).merge(id_attr(node)
+          .merge(
+            type: name,
+            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil,
+          )))
       end
 
       def admonition(node)

data/lib/asciidoctor/standoc/cleanup_image.rb

@@ -15,9 +15,8 @@ module Asciidoctor
       def svgmap_moveattrs(xmldoc)
         xmldoc.xpath("//svgmap").each do |s|
           f = s.at(".//figure") or next
-          if (t = s.at("./name")) && !f.at("./name")
+          (t = s.at("./name")) && !f.at("./name") and
             f.children.first.previous = t.remove
-          end
           if s["id"] && guid?(f["id"])
             f["id"] = s["id"]
             s.delete("id")
@@ -26,13 +25,13 @@ module Asciidoctor
         end
       end
 
-      def svgmap_moveattrs1(s, f)
+      def svgmap_moveattrs1(svgmap, figure)
         %w(unnumbered number subsequence keep-with-next
-           keep-lines-together).each do |a|
-          next if f[a] || !s[a]
+           keep-lines-together tag multilingual-rendering).each do |a|
+          next if figure[a] || !svgmap[a]
 
-          f[a] = s[a]
-          s.delete(a)
+          figure[a] = svgmap[a]
+          svgmap.delete(a)
         end
       end
 

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -1,4 +1,5 @@
 require "metanorma-utils"
+require "digest"
 
 module Asciidoctor
   module Standoc
@@ -112,6 +113,7 @@ module Asciidoctor
       def anchor_cleanup(elem)
         anchor_cleanup1(elem)
         xreftarget_cleanup(elem)
+        contenthash_id_cleanup(elem)
       end
 
       def anchor_cleanup1(elem)
@@ -137,6 +139,29 @@ module Asciidoctor
           end
         end
       end
+
+      def guid?(str)
+        /^_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+          .match?(str)
+      end
+
+      def contenthash_id_cleanup(doc)
+        ids = doc.xpath("//*[@id]").each_with_object({}) do |x, m|
+          next unless guid?(x["id"])
+
+          m[x["id"]] = contenthash(x)
+          x["id"] = m[x["id"]]
+        end
+        [%w(review from), %(review to), %(callout target), %(eref bibitemid),
+         %(citation bibitemid), %(xref target), %(xref to)].each do |a|
+          doc.xpath("//#{a[0]}").each { |x| ids[a[1]] and x[a[1]] = ids[a[1]] }
+        end
+      end
+
+      def contenthash(elem)
+        Digest::MD5.hexdigest("#{elem.path}////#{elem.text}")
+          .sub(/^(.{8})(.{4})(.{4})(.{4})(.{12})$/, "_\\1-\\2-\\3-\\4-\\5")
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -84,6 +84,11 @@ module Asciidoctor
         biblio_reorder(xmldoc)
         biblio_nested(xmldoc)
         biblio_renumber(xmldoc)
+        biblio_no_ext(xmldoc)
+      end
+
+      def biblio_no_ext(xmldoc)
+        xmldoc.xpath("//bibitem/ext").each(&:remove)
       end
 
       def biblio_nested(xmldoc)