metanorma-standoc 1.8.8 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c6a59c6f6a5cfd1b0f6515cf768e060cf846f239b2336a6db7bfb8fef1b75ec
-  data.tar.gz: f88ef657e463750bdad1f01389f8fc9f30fb881ec4f517010a58ca8676c74e04
+  metadata.gz: 5cd6e66873fc1d0b703e0fee76f1ed3a56de06684135f142e3be3865bb7c21fa
+  data.tar.gz: ec666e930ce8ad73f39563050aaf052ddc0ed31a1778dec88cd1bf7308ddef12
 SHA512:
-  metadata.gz: 21a8546de21b8a31a98dc6b2a48a7afed919e847c4e25d54094b60e9ac5fe6489a42b7b0a99b42577f505232b5d2cbd8099c27a3a811db092cb305dfeeb396fe
-  data.tar.gz: 7bbe4985fcf8e3ffe2190552d16d3ece90cd462c4f5ab841241821ea527a00242cd1b17622f07cd6e9900b4875cbefbf0e84d21f7aae0a39ad7be571392ab007
+  metadata.gz: 65062d39f1c2bd1c33ceaf3bc0d55f5be7c34728c4b9027c7b7192c5ddf8a4b3cc3e37705070b471aac7c20117946a6dae150a5e31613d36afff59bb3ab5aa39
+  data.tar.gz: e1ca0ba1c31ad442c6359d30ca338fecb840dd86839d01cf697e314b365f72da424a6f93eecb1906eafdc34e2f489f2afd9f264ce1762cd1bc2e7524711ac653

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
@@ -52,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
 
@@ -60,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"),
@@ -79,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)

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -3,21 +3,26 @@ module Asciidoctor
     module Cleanup
       def external_terms_boilerplate(sources)
         @i18n.l10n(
-          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"), @lang, @script)
+          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"),
+          @lang, @script
+        )
       end
 
       def internal_external_terms_boilerplate(sources)
         @i18n.l10n(
-          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"), @lang, @script)
+          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
+          @lang, @script
+        )
       end
 
       def term_defs_boilerplate(div, source, term, preface, isodoc)
         a = @i18n.term_def_boilerplate and div.next = a
         source.each do |s|
           @anchors[s["bibitemid"]] or
-            @log.add("Crossreferences", nil, "term source #{s['bibitemid']} not referenced")
+            @log.add("Crossreferences", nil,
+                     "term source #{s['bibitemid']} not referenced")
         end
-        a = (source.empty? && term.nil?) ?  @i18n.no_terms_boilerplate :
+        a = source.empty? && term.nil? ?  @i18n.no_terms_boilerplate :
           term_defs_boilerplate_cont(source, term, isodoc)
         a and div.next = a
       end
@@ -55,7 +60,7 @@ module Asciidoctor
       end
 
       def termdef_boilerplate_cleanup(xmldoc)
-        #termdef_remove_initial_paras(xmldoc)
+        # termdef_remove_initial_paras(xmldoc)
       end
 
       def termdef_remove_initial_paras(xmldoc)
@@ -76,6 +81,7 @@ module Asciidoctor
         termdef_boilerplate_cleanup(xmldoc)
         xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
           next if f.at("./clause[@type = 'boilerplate']")
+
           term_defs_boilerplate(f.at("./title"), xmldoc.xpath(".//termdocsource"),
                                 f.at(".//term"), f.at(".//p"), isodoc)
         end
@@ -84,15 +90,16 @@ module Asciidoctor
         initial_boilerplate(xmldoc, isodoc)
       end
 
-      def initial_boilerplate(x, isodoc)
-        return if x.at("//boilerplate")
-        preface = x.at("//preface") || x.at("//sections") || x.at("//annex") ||
-          x.at("//references") || return
-        b = boilerplate(x, isodoc) or return
+      def initial_boilerplate(xml, isodoc)
+        return if xml.at("//boilerplate")
+
+        preface = xml.at("//preface") || xml.at("//sections") ||
+          xml.at("//annex") || xml.at("//references") || return
+        b = boilerplate(xml, isodoc) or return
         preface.previous = b
       end
 
-      def boilerplate_file(xmldoc)
+      def boilerplate_file(_xmldoc)
         File.join(@libdir, "boilerplate.xml")
       end
 
@@ -100,7 +107,7 @@ module Asciidoctor
         file = boilerplate_file(xml)
         file = File.join(@localdir, @boilerplateauthority) if @boilerplateauthority
         !file.nil? and File.exists?(file) or return
-        conv.populate_template((File.read(file, encoding: "UTF-8")), nil)
+        conv.populate_template(File.read(file, encoding: "UTF-8"), nil)
       end
 
       def bibdata_cleanup(xmldoc)
@@ -118,14 +125,16 @@ module Asciidoctor
       def bibdata_docidentifier_cleanup(xmldoc)
         ins = xmldoc.at("//bibdata/docidentifier")
         xmldoc.xpath("//bibdata/docidentifier").each_with_index do |b, i|
-          next if i == 0
+          next if i.zero?
+
           ins.next = b.remove
           ins = ins.next
         end
       end
 
       def gather_indirect_erefs(xmldoc, prefix)
-        xmldoc.xpath("//eref[@type = '#{prefix}']").each_with_object({}) do |e, m|
+        xmldoc.xpath("//eref[@type = '#{prefix}']")
+          .each_with_object({}) do |e, m|
           e.delete("type")
           m[e["bibitemid"]] = true
         end.keys

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -43,7 +43,7 @@ module Asciidoctor
       end
 
       def bibabstract_location(x)
-        bibabstract = x.at("//bibdata/script") || x.at("//bibdata/language") ||
+        x.at("//bibdata/script") || x.at("//bibdata/language") ||
           x.at("//bibdata/contributor[not(following-sibling::contributor)]") ||
           x.at("//bibdata/date[not(following-sibling::date)]") ||
           x.at("//docnumber") ||
@@ -74,7 +74,6 @@ module Asciidoctor
         make_bibliography(x, s)
         x.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
       end
-      
       def make_annexes(x)
         x.xpath("//*[@annex]").each do |y|
           y.delete("annex")
@@ -186,6 +185,7 @@ module Asciidoctor
 
       def replace_title(doc, xpath, text, first = false)
         return unless text
+
         doc.xpath(xpath).each_with_index do |node, i|
           next if first && !i.zero?
           title = get_or_make_title(node)
@@ -196,24 +196,24 @@ module Asciidoctor
         end
       end
 
-      def sections_names_cleanup(x)
-        replace_title(x, "//clause[@type = 'scope']", @i18n&.scope)
-        replace_title(x, "//preface//abstract", @i18n&.abstract)
-        replace_title(x, "//foreword", @i18n&.foreword)
-        replace_title(x, "//introduction", @i18n&.introduction)
-        replace_title(x, "//acknowledgements", @i18n&.acknowledgements)
-        section_names_refs_cleanup(x)
-        section_names_terms_cleanup(x)
+      def sections_names_cleanup(xml)
+        replace_title(xml, "//clause[@type = 'scope']", @i18n&.scope)
+        replace_title(xml, "//preface//abstract", @i18n&.abstract)
+        replace_title(xml, "//foreword", @i18n&.foreword)
+        replace_title(xml, "//introduction", @i18n&.introduction)
+        replace_title(xml, "//acknowledgements", @i18n&.acknowledgements)
+        section_names_refs_cleanup(xml)
+        section_names_terms_cleanup(xml)
       end
 
-      def section_names_refs_cleanup(x)
-        replace_title(x, "//references[@normative = 'true']",
+      def section_names_refs_cleanup(xml)
+        replace_title(xml, "//references[@normative = 'true']",
                       @i18n&.normref, true)
-        replace_title(x, "//references[@normative = 'false']",
+        replace_title(xml, "//references[@normative = 'false']",
                       @i18n&.bibliography, true)
       end
 
-      NO_SYMABBR = "[.//definitions[not(@type)]]"
+      NO_SYMABBR = "[.//definitions[not(@type)]]".freeze
       SYMABBR = "[.//definitions[@type = 'symbols']"\
         "[@type = 'abbreviated_terms']]".freeze
       SYMnoABBR = "[.//definitions[@type = 'symbols']"\
@@ -223,7 +223,8 @@ module Asciidoctor
 
       def section_names_terms_cleanup(x)
         replace_title(x, "//definitions[@type = 'symbols']", @i18n&.symbols)
-        replace_title(x, "//definitions[@type = 'abbreviated_terms']", @i18n&.abbrev)
+        replace_title(x, "//definitions[@type = 'abbreviated_terms']",
+                      @i18n&.abbrev)
         replace_title(x, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
         replace_title(x, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
                       @i18n&.termsdefsymbols, true)

data/lib/asciidoctor/standoc/converter.rb

@@ -13,7 +13,7 @@ require "asciidoctor/standoc/validate"
 require "asciidoctor/standoc/utils"
 require "asciidoctor/standoc/cleanup"
 require "asciidoctor/standoc/reqt"
-require_relative "./macros.rb"
+require_relative "./macros"
 
 module Asciidoctor
   module Standoc
@@ -39,6 +39,8 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::TermRefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexXrefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexRangeInlineMacro
+        inline_macro Asciidoctor::Standoc::AddMacro
+        inline_macro Asciidoctor::Standoc::DelMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro

data/lib/asciidoctor/standoc/inline.rb

@@ -45,7 +45,7 @@ module Asciidoctor
 
       def inline_anchor_xref_attrs(node)
         m = /^(?<drop>droploc%)?(?<case>capital%|lowercase%)?(?<drop2>droploc%)?
-          (?<fn>fn(:\s*(?<text>.*))?)?$/x.match node.text
+          (?<fn>fn:?\s*)?(?<text>.*)$/x.match node.text
         casing = m.nil? ? nil : m[:case]&.sub(/%$/, "")
         droploc = m.nil? ? nil : ((m[:drop].nil? && m[:drop2].nil?) ? nil: true)
         f = (m.nil? || m[:fn].nil?) ? "inline" : "footnote"

data/lib/asciidoctor/standoc/isodoc.rng

@@ -86,6 +86,35 @@
         <text/>
       </element>
     </define>
+    <define name="erefType">
+      <optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <attribute name="citeas"/>
+      <attribute name="type">
+        <ref name="ReferenceFormat"/>
+      </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
+      <optional>
+        <attribute name="case">
+          <choice>
+            <value>capital</value>
+            <value>lowercase</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="droploc">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <ref name="CitationType"/>
+      <text/>
+    </define>
     <define name="ul">
       <element name="ul">
         <attribute name="id">
@@ -775,6 +804,78 @@
         <ref name="paragraph"/>
       </element>
     </define>
+    <define name="em">
+      <element name="em">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strong">
+      <element name="strong">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="tt">
+      <element name="tt">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="keyword">
+      <element name="keyword">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strike">
+      <element name="strike">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="underline">
+      <element name="underline">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="smallcap">
+      <element name="smallcap">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
   <define name="colgroup">
@@ -793,7 +894,35 @@
     <value>internal</value>
   </define>
   <define name="TextElement" combine="choice">
-    <ref name="concept"/>
+    <choice>
+      <ref name="concept"/>
+      <ref name="add"/>
+      <ref name="del"/>
+    </choice>
+  </define>
+  <define name="add">
+    <element name="add">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
+  </define>
+  <define name="del">
+    <element name="del">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
   </define>
   <define name="concept">
     <element name="concept">

data/lib/asciidoctor/standoc/macros.rb

@@ -2,10 +2,10 @@ require "asciidoctor/extensions"
 require "fileutils"
 require "uuidtools"
 require "yaml"
-require_relative "./macros_plantuml.rb"
-require_relative "./macros_terms.rb"
-require_relative "./datamodel/attributes_table_preprocessor.rb"
-require_relative "./datamodel/diagram_preprocessor.rb"
+require_relative "./macros_plantuml"
+require_relative "./macros_terms"
+require_relative "./datamodel/attributes_table_preprocessor"
+require_relative "./datamodel/diagram_preprocessor"
 require "metanorma-plugin-datastruct"
 require "metanorma-plugin-lutaml"
 
@@ -29,6 +29,7 @@ module Asciidoctor
 
       def preprocess_attrs(attrs)
         return unless attrs.size > 1 && attrs.size < 5
+
         ret = { primary: attrs[1], target: attrs[attrs.size] }
         ret[:secondary] = attrs[2] if attrs.size > 2
         ret[:tertiary] = attrs[3] if attrs.size > 3
@@ -37,7 +38,8 @@ module Asciidoctor
 
       def process(_parent, target, attr)
         args = preprocess_attrs(attr) or return
-        ret = "<index-xref also='#{target == 'also'}'><primary>#{args[:primary]}</primary>"
+        ret = "<index-xref also='#{target == 'also'}'>"\
+          "<primary>#{args[:primary]}</primary>"
         ret += "<secondary>#{args[:secondary]}</secondary>" if args[:secondary]
         ret += "<tertiary>#{args[:tertiary]}</tertiary>" if args[:tertiary]
         ret + "<target>#{args[:target]}</target></index-xref>"
@@ -51,7 +53,7 @@ module Asciidoctor
 
       def process(parent, target, attr)
         text = attr["text"]
-        text = "((#{text}))" unless /^\(\(.+\)\)$/.match(text)
+        text = "((#{text}))" unless /^\(\(.+\)\)$/.match?(text)
         out = parent.sub_macros(text)
         out.sub(/<index>/, "<index to='#{target}'>")
       end
@@ -62,8 +64,8 @@ module Asciidoctor
       named :pseudocode
       on_context :example, :sourcecode
 
-      def init_indent(s)
-        /^(?<prefix>[ \t]*)(?<suffix>.*)$/ =~ s
+      def init_indent(line)
+        /^(?<prefix>[ \t]*)(?<suffix>.*)$/ =~ line
         prefix = prefix.gsub(/\t/, "\u00a0\u00a0\u00a0\u00a0")
           .gsub(/ /, "\u00a0")
         prefix + suffix
@@ -75,9 +77,10 @@ module Asciidoctor
           /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|\`\`\`\`+|____\+)$/.match(l) &&
             (ignore = !ignore)
           next if l.empty? || l.match(/ \+$/)
-          next if /^\[.*\]$/.match(l)
+          next if /^\[.*\]$/.match?(l)
           next if ignore
           next if i == lines.size - 1 || i < lines.size - 1 && lines[i + 1].empty?
+
           lines[i] += " +"
         end
         lines
@@ -86,9 +89,8 @@ module Asciidoctor
       def process(parent, reader, attrs)
         attrs["role"] = "pseudocode"
         lines = reader.lines.map { |m| init_indent(m) }
-        ret = create_block(parent, :example, supply_br(lines),
-                           attrs, content_model: :compound)
-        ret
+        create_block(parent, :example, supply_br(lines),
+                     attrs, content_model: :compound)
       end
     end
 
@@ -98,6 +100,7 @@ module Asciidoctor
       parse_content_as :text
       option :pos_attrs, %w(rpbegin rt rpend)
 
+      # for example, html5ruby:楽聖少女[がくせいしょうじょ]
       def process(_parent, target, attributes)
         rpbegin = "("
         rpend = ")"
@@ -105,7 +108,6 @@ module Asciidoctor
           rt = attributes["text"]
         elsif (attributes.size == 2) && attributes.key?(1) &&
           attributes.key?("rpbegin")
-          # for example, html5ruby:楽聖少女[がくせいしょうじょ]
           rt = attributes[1] || ""
         else
           rpbegin = attributes["rpbegin"]
@@ -135,6 +137,7 @@ module Asciidoctor
       def process(document)
         (document.find_by context: :paragraph).each do |para|
           next unless /^TODO: /.match para.lines[0]
+
           parent = para.parent
           para.set_attr("name", "todo")
           para.set_attr("caption", "TODO")
@@ -182,5 +185,29 @@ module Asciidoctor
         %{<footnoteblock>#{out}</footnoteblock>}
       end
     end
+
+    class AddMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :add
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<add>#{out}</add>}
+      end
+    end
+
+    class DelMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :del
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<del>#{out}</del>}
+      end
+    end
   end
 end