metanorma-standoc 1.3.18 → 1.3.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29fb2b3bd1b2182033a91de521a848994d54d41592d3c1f850572fd9e4ab6bd5
-  data.tar.gz: 1cdecf3c34899fb71b342eafdf16a249e399e35c5382d41fc5965e2870b80988
+  metadata.gz: d8ed2615aea35bf1ce9472e6b55f99bffd6f918cefb1bd88e4758d5091577d31
+  data.tar.gz: bf4d2b5b381b834127f46a25705fb577705d3b72e55553a0d3de55239029feb1
 SHA512:
-  metadata.gz: 61be98b3231edd09a06711527c2c482cf276fc57bc09eaa10f83316574a9c13aba58b16ab32df29879ffe821d908dc6ad5ea72673328a440da232bd769c8b912
-  data.tar.gz: 9f41b2ccbb3e865c7b738a67d00f26c7ddd5230e67af501fc696fb5b80793e933dcd56b08f21e56fab318ad877af77a0c24cce2e454aac85dd1f8d3febc8793a
+  metadata.gz: 96a49389924a2a96eac3a31d6eb75925e4f9da49fd9030cc40fc17bab7bceac68b24e29359e8e25bf5240da827e35d90194758ba9263277c1c165c7e1862e01c
+  data.tar.gz: 0e1bb4980154384666bec21167709b1363acc2c5a466421f94ca63185fe47f894a79ab20567916ef32abecf0fefce9fc676daa4443cbb73459516c2743fd6206

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -64,10 +64,11 @@ module Asciidoctor
 
       def boilerplate_cleanup(xmldoc)
         isodoc = boilerplate_isodoc(xmldoc)
-        f = xmldoc.at(self.class::TERM_CLAUSE) and
+        xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
           term_defs_boilerplate(f.at("./title"),
                                 xmldoc.xpath(".//termdocsource"),
                                 f.at(".//term"), f.at(".//p"), isodoc)
+        end
         f = xmldoc.at(self.class::NORM_REF) and
           norm_ref_preface(f)
         initial_boilerplate(xmldoc, isodoc)
@@ -91,14 +92,14 @@ module Asciidoctor
       end
 
       def boilerplate_file(xmldoc)
-          File.join(@libdir, "boilerplate.xml")
+        File.join(@libdir, "boilerplate.xml")
       end
 
       def boilerplate(xml, conv)
         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)

data/lib/asciidoctor/standoc/cleanup_footnotes.rb

@@ -14,13 +14,15 @@ module Asciidoctor
         c.gsub(/ id="[^"]+"/, "")
       end
 
-      # include footnotes inside figure
+      # 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|
+            next if s.children.map { |c| c.text? && /[[:alpha:]]/.match(c.text) }.any?
             s.previous_element << s.first_element_child.remove
             s.remove
             nomatches = false

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -67,7 +67,7 @@ module Asciidoctor
 
       def omit_docid_prefix(prefix)
         return true if prefix.nil? || prefix.empty?
-        %(ISO IEC IEV ITU).include? prefix
+        %(ISO IEC IEV ITU metanorma).include? prefix
       end
 
       def format_ref(ref, type, isopub)
@@ -85,7 +85,8 @@ module Asciidoctor
       def reference_names(xmldoc)
         xmldoc.xpath("//bibitem[not(ancestor::bibitem)]").each do |ref|
           isopub = ref.at(ISO_PUBLISHER_XPATH)
-          docid = ref.at("./docidentifier[not(@type = 'DOI')]") or next
+          docid = ref.at("./docidentifier[@type = 'metanorma']") ||
+            ref.at("./docidentifier[not(@type = 'DOI')]") or next
           reference = format_ref(docid.text, docid["type"], isopub)
           @anchors[ref["id"]] = { xref: reference }
         end

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -9,20 +9,29 @@ require "mathml2asciimath"
 module Asciidoctor
   module Standoc
     module Cleanup
-       def make_preface(x, s)
-        if x.at("//foreword | //introduction")
+      def make_preface(x, s)
+        if x.at("//foreword | //introduction | //acknowledgements | "\
+            "//clause[@preface]")
           preface = s.add_previous_sibling("<preface/>").first
-          foreword = x.at("//foreword")
-          preface.add_child foreword.remove if foreword
-          introduction = x.at("//introduction")
-          preface.add_child introduction.remove if introduction
+          f = x.at("//foreword") and preface.add_child f.remove
+          f = x.at("//introduction") and preface.add_child f.remove
+          move_clauses_into_preface(x, preface)
+          f = x.at("//acknowledgements") and preface.add_child f.remove
         end
         make_abstract(x, s)
       end
 
+      def move_clauses_into_preface(x, preface)
+        x.xpath("//clause[@preface]").each do |c|
+          c.delete("preface")
+          preface.add_child c.remove
+        end
+      end
+
       def make_abstract(x, s)
         if x.at("//abstract[not(ancestor::bibitem)]")
-          preface = s.at("//preface") || s.add_previous_sibling("<preface/>").first
+          preface = s.at("//preface") ||
+            s.add_previous_sibling("<preface/>").first
           abstract = x.at("//abstract[not(ancestor::bibitem)]").remove
           preface.prepend_child abstract.remove
           bibabstract = bibabstract_location(x)
@@ -39,9 +48,10 @@ module Asciidoctor
           x.at("//bibdata/contributor[not(following-sibling::contributor)]") ||
           x.at("//bibdata/date[not(following-sibling::date)]") ||
           x.at("//docnumber") ||
-          x.at("//bibdata/docidentifier[not(following-sibling::docidentifier)]") ||
-          x.at("//bibdata/uri[not(following-sibling::uri)]") ||
-          x.at("//bibdata/title[not(following-sibling::title)]")
+          x.at("//bibdata/docidentifier"\
+               "[not(following-sibling::docidentifier)]") ||
+        x.at("//bibdata/uri[not(following-sibling::uri)]") ||
+        x.at("//bibdata/title[not(following-sibling::title)]")
       end
 
       def make_bibliography(x, s)
@@ -93,7 +103,9 @@ module Asciidoctor
       def obligations_cleanup_info(x)
         (s = x.at("//foreword")) && s["obligation"] = "informative"
         (s = x.at("//introduction")) && s["obligation"] = "informative"
+        (s = x.at("//acknowledgements")) && s["obligation"] = "informative"
         x.xpath("//references").each { |r| r["obligation"] = "informative" }
+        x.xpath("//preface//clause").each { |r| r["obligation"] = "informative" }
       end
 
       def obligations_cleanup_norm(x)
@@ -109,7 +121,7 @@ module Asciidoctor
           r["obligation"] = "normative" unless r["obligation"]
         end
         x.xpath(Utils::SUBCLAUSE_XPATH).each do |r|
-          r["obligation"] = r.at("./ancestor::*/@obligation").text
+          o = r&.at("./ancestor::*/@obligation")&.text and r["obligation"] = o
         end
       end
 

data/lib/asciidoctor/standoc/section.rb

@@ -61,6 +61,7 @@ module Asciidoctor
         noko do |xml|
           case sectiontype(node)
           when "introduction" then introduction_parse(a, xml, node)
+          when "foreword" then foreword_parse(a, xml, node)
           when "normative references" then norm_ref_parse(a, xml, node)
           when "terms and definitions"
             @term_def = true
@@ -68,6 +69,8 @@ module Asciidoctor
             @term_def = false
           when "symbols and abbreviated terms"
             symbols_parse(a, xml, node)
+          when "acknowledgements"
+            acknowledgements_parse(a, xml, node)
           when "bibliography" then bibliography_parse(a, xml, node)
           else
             if @term_def then term_def_subclause_parse(a, xml, node)
@@ -115,6 +118,7 @@ module Asciidoctor
       def clause_parse(attrs, xml, node)
         attrs["inline-header".to_sym] = node.option? "inline-header"
         attrs[:bibitem] = true if node.option? "bibitem"
+        attrs[:preface] = true if node.role == "preface" || node.attr("style") == "preface"
         attrs[:level] = node.attr("level")
         set_obligation(attrs, node)
         xml.send "clause", **attr_code(attrs) do |xml_section|
@@ -228,6 +232,22 @@ module Asciidoctor
           xml_section << content
         end
       end
+
+      def foreword_parse(attrs, xml, node)
+        xml.foreword **attr_code(attrs) do |xml_section|
+          xml_section.title { |t| t << node.title }
+          content = node.content
+          xml_section << content
+        end
+      end
+
+      def acknowledgements_parse(attrs, xml, node)
+        xml.acknowledgements **attr_code(attrs) do |xml_section|
+          xml_section.title { |t| t << node.title || "Acknowledgements" }
+          content = node.content
+          xml_section << content
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/utils.rb

@@ -222,8 +222,7 @@ module Asciidoctor
         type
       end
 
-      SUBCLAUSE_XPATH = "//clause[ancestor::clause or ancestor::annex or "\
-        "ancestor::introduction]".freeze
+      SUBCLAUSE_XPATH = "//clause[not(parent::sections)]".freeze
     end
   end
 end

data/lib/metanorma/standoc/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Standoc
-   VERSION = "1.3.18".freeze
+   VERSION = "1.3.19".freeze
   end
 end

data/spec/asciidoctor-standoc/cleanup_spec.rb

@@ -694,6 +694,8 @@ RSpec.describe Asciidoctor::Standoc do
       footnote:[This is a footnote to a figure]
 
       footnote:[This is another footnote to a figure]
+
+      A footnote:[This is a third footnote]
     INPUT
        #{BLANK_HDR}
        <sections><figure id="_">
@@ -703,6 +705,12 @@ RSpec.describe Asciidoctor::Standoc do
        </fn><fn reference="b">
          <p id="_">This is another footnote to a figure</p>
        </fn></figure>
+       <p id='_'>
+  A
+  <fn reference='1'>
+    <p id='_'>This is a third footnote</p>
+  </fn>
+</p>
 
        </sections>
 

data/spec/asciidoctor-standoc/refs_spec.rb

@@ -99,6 +99,10 @@ RSpec.describe Asciidoctor::Standoc do
     mock_isobib_get_123_no_docid_lbl
     input = <<~"INPUT"
         #{ISOBIB_BLANK_HDR}
+        
+        <<iso123>>
+        <<iso124>>
+
         [bibliography]
         == Normative References
 
@@ -107,6 +111,15 @@ RSpec.describe Asciidoctor::Standoc do
       INPUT
     expect(xmlpp(strip_guid(Asciidoctor.convert(input, backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp( <<~"OUTPUT")
        #{BLANK_HDR}
+       <preface>
+  <foreword obligation='informative'>
+    <title>Foreword</title>
+    <p id='_'>
+      <eref type='inline' bibitemid='iso123' citeas='ISO 123'/>
+      <eref type='inline' bibitemid='iso124' citeas='[1]'/>
+    </p>
+  </foreword>
+</preface>
        <sections>
        </sections><bibliography><references id="_" obligation="informative"><title>Normative References</title>
         #{NORM_REF_BOILERPLATE}

data/spec/asciidoctor-standoc/section_spec.rb

@@ -17,6 +17,11 @@ RSpec.describe Asciidoctor::Standoc do
 
       === Introduction Subsection
 
+      == Acknowledgements
+      
+      [.preface]
+      == Dedication
+
       == Scope
 
       Text
@@ -86,7 +91,14 @@ RSpec.describe Asciidoctor::Standoc do
   <clause id="_" inline-header="false" obligation="informative">
   <title>Introduction Subsection</title>
 </clause>
-</introduction></preface><sections>
+</introduction>
+<clause id='_' inline-header='false' obligation='informative'>
+  <title>Dedication</title>
+</clause>
+ <acknowledgements id='_' obligation='informative'>
+   <title>Acknowledgements</title>
+ </acknowledgements>
+</preface><sections>
 
 
 <clause id="_" inline-header="false" obligation="normative">
@@ -102,7 +114,9 @@ RSpec.describe Asciidoctor::Standoc do
   <preferred>Term1</preferred>
 </term>
 </terms>
-<clause id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><clause id="_" inline-header="false" obligation="normative">
+<clause id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title>
+  <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
+<clause id="_" inline-header="false" obligation="normative">
   <title>Introduction</title>
   <clause id="_" inline-header="false" obligation="normative">
   <title>Intro 1</title>
@@ -169,7 +183,8 @@ RSpec.describe Asciidoctor::Standoc do
     it "processes sections with language and script attributes" do
       expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :standoc, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
       #{ASCIIDOC_BLANK_HDR}
-      .Foreword
+      [language=en,script=Latn]
+      == Foreword
 
       Text
 
@@ -184,6 +199,13 @@ RSpec.describe Asciidoctor::Standoc do
       [language=en,script=Latn]
       === Introduction Subsection
 
+      [language=en,script=Latn]
+      == Acknowledgements
+
+      [.preface]
+      [language=en,script=Latn]
+      == Dedication
+
       [language=en,script=Latn]
       == Scope
 
@@ -266,7 +288,7 @@ RSpec.describe Asciidoctor::Standoc do
              #{BLANK_HDR.sub(/<status>/, "<abstract> <p>Text</p> </abstract><status>")}
      <preface><abstract id="_" language="en" script="Latn">
          <p id="_">Text</p>
-       </abstract><foreword obligation="informative">
+       </abstract><foreword id='_' language='en' script='Latn' obligation='informative'>
          <title>Foreword</title>
          <p id="_">Text</p>
        </foreword><introduction id="_" language="en" script="Latn" obligation="informative">
@@ -274,7 +296,14 @@ RSpec.describe Asciidoctor::Standoc do
          <clause id="_" language="en" script="Latn" inline-header="false" obligation="informative">
          <title>Introduction Subsection</title>
        </clause>
-       </introduction></preface><sections>
+       </introduction>
+       <clause id='_' language='en' script='Latn' inline-header='false' obligation='informative'>
+  <title>Dedication</title>
+</clause>
+       <acknowledgements id='_' language='en' script='Latn' obligation='informative'>
+  <title>Acknowledgements</title>
+</acknowledgements>
+</preface><sections>
 
 
        <clause id="_" language="en" script="Latn" inline-header="false" obligation="normative">
@@ -290,7 +319,9 @@ RSpec.describe Asciidoctor::Standoc do
          <preferred>Term1</preferred>
        </term>
        </terms>
-       <clause id="_" language="en" script="Latn" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><clause id="_" language="en" script="Latn" inline-header="false" obligation="normative">
+       <clause id="_" language="en" script="Latn" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title>
+  <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
+<clause id="_" language="en" script="Latn" inline-header="false" obligation="normative">
          <title>Introduction</title>
          <clause id="_" inline-header="false" obligation="normative">
          <title>Intro 1</title>
@@ -371,6 +402,9 @@ RSpec.describe Asciidoctor::Standoc do
 
       === Introduction Subsection
 
+      [heading=acknowledgements]
+      == Ευχαριστίες
+
       [heading=normative references]
       == Κανονιστικές Παραπομπές
 
@@ -423,6 +457,9 @@ RSpec.describe Asciidoctor::Standoc do
         <title>Introduction Subsection</title>
       </clause>
     </introduction>
+    <acknowledgements id='_' obligation='informative'>
+  <title>Ευχαριστίες</title>
+</acknowledgements>
   </preface>
   <sections>
     <terms id='_' obligation='normative'>
@@ -434,6 +471,7 @@ RSpec.describe Asciidoctor::Standoc do
     </terms>
     <clause id='_' obligation='normative'>
       <title>Terms and definitions</title>
+  <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
       <terms id='_' obligation='normative'>
         <title>Normal Terms</title>
         <term id='_'>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 1.3.18
+  version: 1.3.19
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor