metanorma-standoc 1.8.6 → 1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d29f898d11836b1b9ae020605081f35a144ed06406a24776b93841d05cafac62
-  data.tar.gz: 5f47fb98bf9189ab80a18fe9f32150e0cf840f6860ec2317147122583748f162
+  metadata.gz: b3b789e06df237e881bdd055cfe9b90e191d781e71e82dd6a80c098f23b08934
+  data.tar.gz: 27f1499d7f7adccf29c2b9c9ac731e6ff1988a008530a4aa13e63adb4fbef490
 SHA512:
-  metadata.gz: 92cf686a035d48f5b0507d0fffa91b2b207f741cc14a939b498330065e204b6a194bab1b7796115ff790ae0f29e046d7bf429da1dd51b554b5251febd9b350eb
-  data.tar.gz: 91a13d5900acf6099186c51e294dd6f441bd298fdafa958bc53d8a0ef95dbfad4427cfad1464cffb1ced2ae840158cb9364c00249a25595b4cfea9a65d4f2136
+  metadata.gz: c72e91aac553b2e9d3151a59fde54b02ae5cb6340aeb0781dd4326d5a6bce3166e20fd2ece37d909c3e8b7f72d6d26892bd279d4256b190cf28dbe41e1bdbf3e
+  data.tar.gz: 8314c96a3af15b47d56c42cd040e369455616b40dafb37a3d2ee32d0ba46976293eee36f3b9ab99d3b2d94002df3f3bf0a319e98f262e0d5eb3049fb90c30d4f

data/.gitignore

@@ -10,3 +10,5 @@ spec/examples/rice.html
 spec/examples/rice.xml
 spec/examples/rice_files/
 Gemfile.lock
+
+.rubocop-https--*

data/.rubocop.yml

@@ -1,10 +1,12 @@
 # This project follows the Ribose OSS style guide.
 # https://github.com/riboseinc/oss-guides
 # All project-specific additions and overrides should be specified in this file.
-
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+
 AllCops:
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
   TargetRubyVersion: 2.4
-Rails:
-  Enabled: true

data/lib/asciidoctor/standoc/base.rb

@@ -8,6 +8,7 @@ require "isodoc"
 require "relaton"
 require "fileutils"
 require "metanorma-utils"
+require "isodoc/xslfo_convert"
 
 module Asciidoctor
   module Standoc
@@ -43,6 +44,7 @@ module Asciidoctor
           i18nyaml: node.attr("i18nyaml"),
           scope: node.attr("scope"),
           htmlstylesheet: node.attr("htmlstylesheet"),
+          htmlstylesheet_override: node.attr("htmlstylesheet-override"),
           htmlcoverpage: node.attr("htmlcoverpage"),
           htmlintropage: node.attr("htmlintropage"),
           scripts: node.attr("scripts"),
@@ -51,6 +53,7 @@ module Asciidoctor
           htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
           doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
+          sectionsplit: node.attr("sectionsplit"),
         }
       end
 
@@ -59,7 +62,7 @@ module Asciidoctor
       end
 
       def doc_extract_attributes(node)
-        {
+        attrs = {
           script: node.attr("script"),
           bodyfont: node.attr("body-font"),
           headerfont: node.attr("header-font"),
@@ -67,6 +70,7 @@ module Asciidoctor
           i18nyaml: node.attr("i18nyaml"),
           scope: node.attr("scope"),
           wordstylesheet: node.attr("wordstylesheet"),
+          wordstylesheet_override: node.attr("wordstylesheet-override"),
           standardstylesheet: node.attr("standardstylesheet"),
           header: node.attr("header"),
           wordcoverpage: node.attr("wordcoverpage"),
@@ -77,6 +81,14 @@ module Asciidoctor
           doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
         }
+
+        if font_manifest_file = node.attr("mn2pdf-font-manifest-file")
+          attrs[IsoDoc::XslfoPdfConvert::MN2PDF_OPTIONS] = {
+            IsoDoc::XslfoPdfConvert::MN2PDF_FONT_MANIFEST => font_manifest_file,
+          }
+        end
+
+        attrs
       end
 
       def doc_converter(node)
@@ -96,10 +108,15 @@ module Asciidoctor
         @draft = node.attributes.has_key?("draft")
         @novalid = node.attr("novalid")
         @smartquotes = node.attr("smartquotes") != "false"
-        @keepasciimath = node.attr("mn-keep-asciimath") && node.attr("mn-keep-asciimath") != "false"
+        @keepasciimath = node.attr("mn-keep-asciimath") &&
+          node.attr("mn-keep-asciimath") != "false"
         @fontheader = default_fonts(node)
         @files_to_delete = []
-        @filename = node.attr("docfile") ?  File.basename(node.attr("docfile")).gsub(/\.adoc$/, "") : ""
+        if node.attr("docfile")
+          @filename = File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
+        else
+          @filename = ""
+        end
         @localdir = Metanorma::Utils::localdir(node)
         @output_dir = outputdir node
         @no_isobib_cache = node.attr("no-isobib-cache")
@@ -131,10 +148,12 @@ module Asciidoctor
       end
 
       def outputs(node, ret)
-        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node).convert(@filename + ".xml")
-        html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
+        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
+        presentation_xml_converter(node).convert("#{@filename}.xml")
+        html_converter(node).convert("#{@filename}.presentation.xml",
+                                     nil, false, "#{@filename}.html")
+        doc_converter(node).convert("#{@filename}.presentation.xml",
+                                    nil, false, "#{@filename}.doc")
       end
 
       def document(node)
@@ -151,12 +170,21 @@ module Asciidoctor
       end
 
       def clean_exit
-        @log.write(@output_dir + @filename + ".err") unless @novalid
+        @log.write("#{@output_dir}#{@filename}.err") unless @novalid
+
         @files_to_delete.each { |f| FileUtils.rm f }
       end
 
+      def clean_abort(msg, file = nil)
+        file and
+          File.open("#{@filename}.xml.abort", "w:UTF-8") { |f| f.write(file) }
+        clean_exit
+        abort(msg)
+      end
+
       def makexml1(node)
-        result = ["<?xml version='1.0' encoding='UTF-8'?>", "<#{xml_root_tag} type='semantic' version='#{version}'>"]
+        result = ["<?xml version='1.0' encoding='UTF-8'?>",
+                  "<#{xml_root_tag} type='semantic' version='#{version}'>"]
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
         result << "</#{xml_root_tag}>"
@@ -191,36 +219,13 @@ module Asciidoctor
         end
       end
 
-      def default_script(lang)
-        case lang
-        when "ar", "fa"
-          "Arab"
-        when "ur"
-          "Aran"
-        when "ru", "bg"
-          "Cyrl"
-        when "hi"
-          "Deva"
-        when "el"
-          "Grek"
-        when "zh"
-          "Hans"
-        when "ko"
-          "Kore"
-        when "he"
-          "Hebr"
-        when "ja"
-          "Jpan"
-        else
-          "Latn"
-        end
-      end
-
       private
 
       def outputdir(node)
-        if node.attr("output_dir").nil_or_empty? then Metanorma::Utils::localdir(node)
-        else File.join(node.attr("output_dir"), "")
+        if node.attr("output_dir").nil_or_empty?
+          Metanorma::Utils::localdir(node)
+        else
+          File.join(node.attr("output_dir"), "")
         end
       end
     end

data/lib/asciidoctor/standoc/biblio.rng

@@ -124,7 +124,7 @@
           <value>application/tei+xml</value>
           <value>text/x-asciidoc</value>
           <value>text/markdown</value>
-          <value>application/x-isodoc+xml</value>
+          <value>application/x-metanorma+xml</value>
           <text/>
         </choice>
       </attribute>
@@ -452,6 +452,7 @@
       <attribute name="type">
         <choice>
           <value>isni</value>
+          <value>orcid</value>
           <value>uri</value>
         </choice>
       </attribute>
@@ -461,10 +462,7 @@
   <define name="org-identifier">
     <element name="identifier">
       <attribute name="type">
-        <choice>
-          <value>orcid</value>
-          <value>uri</value>
-        </choice>
+        <data type="string" datatypeLibrary=""/>
       </attribute>
       <text/>
     </element>
@@ -1106,7 +1104,7 @@
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>
-      <value>cited</value>
+      <value>cites</value>
       <value>isCitedIn</value>
     </choice>
   </define>

data/lib/asciidoctor/standoc/blocks.rb

@@ -30,6 +30,7 @@ module Asciidoctor
       def open(node)
         role = node.role || node.attr("style")
         reqt_subpart(role) and return requirement_subpart(node)
+        role == "form" and return form(node)
         result = []
         node.blocks.each do |b|
           result << send(b.context, b)
@@ -37,6 +38,17 @@ module Asciidoctor
         result
       end
 
+      def form(node)
+        noko do |xml|
+          xml.form **attr_code(
+            id: Metanorma::Utils::anchor_or_uuid,
+            name: node.attr("name"), action: node.attr("action")
+          ) do |f|
+            f << node.content
+          end
+        end
+      end
+
       def literal_attrs(node)
         attr_code(id_attr(node).merge(keep_attrs(node)))
       end
@@ -45,8 +57,9 @@ module Asciidoctor
         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"))
+            f.pre node.lines.join("\n"),
+              **attr_code(id: Metanorma::Utils::anchor_or_uuid,
+                          alt: node.attr("alt"))
           end
         end
       end
@@ -70,19 +83,32 @@ module Asciidoctor
 
       def example(node)
         return term_example(node) if in_terms?
+
         role = node.role || node.attr("style")
         %w(recommendation requirement permission).include?(role) and
           return requirement(node, role)
         return pseudocode_example(node) if role == "pseudocode"
         return svgmap_example(node) if role == "svgmap"
+        return form(node) if role == "form"
+
         example_proper(node)
       end
 
+      def svgmap_attrs(node)
+        attr_code( { id: node.id,
+                     unnumbered: node.option?("unnumbered") ? "true" : nil,
+                     number: node.attr("number"),
+                     subsequence: node.attr("subsequence") }.
+        merge(keep_attrs(node)))
+      end
+
       def svgmap_example(node)
         noko do |xml|
-          xml.svgmap **attr_code(example_attrs(node).merge(src: node.attr("src"), alt: node.attr("alt"))) do |ex|
-            ex << node.content
-          end
+          xml.svgmap **attr_code(svgmap_attrs(node).merge(
+            src: node.attr("src"), alt: node.attr("alt"))) do |ex|
+              figure_title(node, ex)
+              ex << node.content
+            end
         end.join("\n")
       end
 
@@ -129,12 +155,14 @@ module Asciidoctor
       end
 
       def para_attrs(node)
-        attr_code(keep_attrs(node).merge(align: node.attr("align"), 
-                                         id: Metanorma::Utils::anchor_or_uuid(node)))
+        attr_code(keep_attrs(node)
+          .merge(align: node.attr("align"), 
+        id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def paragraph(node)
         return termsource(node) if node.role == "source"
+
         noko do |xml|
           xml.p **para_attrs(node) do |xml_t|
             xml_t << node.content
@@ -143,8 +171,9 @@ 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(keep_attrs(node)
+          .merge(align: node.attr("align"), 
+        id: Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def quote_attribution(node, out)
@@ -168,11 +197,12 @@ module Asciidoctor
       end
 
       def listing_attrs(node)
-        attr_code(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")))
+        attr_code(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")))
       end
 
       # NOTE: html escaping is performed by Nokogiri

data/lib/asciidoctor/standoc/blocks_notes.rb

@@ -2,30 +2,41 @@ module Asciidoctor
   module Standoc
     module Blocks
       def termnote_attrs(node)
-        attr_code(id_attr(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")))
+        attr_code(
+          id_attr(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")
+          )
+        )
       end
 
       def note_attrs(node)
-        attr_code(termnote_attrs(node).merge(
-          type: node.attr("type"),
-          beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
+        attr_code(
+          termnote_attrs(node).merge(
+            type: node.attr("type"),
+            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil
+          )
+        )
       end
 
       def sidebar_attrs(node)
-        todo_attrs(node).merge(attr_code(
-          from: node.attr("from"), to: node.attr("to") || node.attr("from") ))
+        todo_attrs(node).merge(
+          attr_code(
+            from: node.attr("from"),
+            to: node.attr("to") || node.attr("from")
+          )
+        )
       end
 
       def sidebar(node)
         return unless draft?
+
         noko do |xml|
-          xml.review **(sidebar_attrs(node)) do |r|
+          xml.review **sidebar_attrs(node) do |r|
             wrap_in_para(node, r)
           end
         end
@@ -33,33 +44,34 @@ module Asciidoctor
 
       def todo_attrs(node)
         date = node.attr("date") || Date.today.iso8601.gsub(/\+.*$/, "")
-        date += "T00:00:00Z" unless /T/.match date
+        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 )
+          date: date
+        )
       end
 
       def todo(node)
         noko do |xml|
-          xml.review **(todo_attrs(node)) do |r|
+          xml.review **todo_attrs(node) do |r|
             wrap_in_para(node, r)
           end
         end
       end
 
-      def termnote(n)
+      def termnote(node)
         noko do |xml|
-          xml.termnote **termnote_attrs(n) do |ex|
-            wrap_in_para(n, ex)
+          xml.termnote **termnote_attrs(node) do |ex|
+            wrap_in_para(node, ex)
           end
         end.join("\n")
       end
 
-      def note(n)
+      def note(node)
         noko do |xml|
-          xml.note **note_attrs(n) do |c|
-            wrap_in_para(n, c)
+          xml.note **note_attrs(node) do |c|
+            wrap_in_para(node, c)
           end
         end.join("\n")
       end
@@ -69,14 +81,19 @@ 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: Metanorma::Utils::anchor_or_uuid(node), type: name,
+            beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil
+          )
+        )
       end
 
       def admonition(node)
         return termnote(node) if in_terms?
         return note(node) if node.attr("name") == "note"
         return todo(node) if node.attr("name") == "todo"
+
         noko do |xml|
           xml.admonition **admonition_attrs(node) do |a|
             node.title.nil? or a.name { |name| name << node.title }