asciidoctor-iso 0.6.0 → 0.6.1

data/lib/asciidoctor/iso/cleanup.rb

@@ -1,11 +1,10 @@
 require "date"
 require "nokogiri"
-require "htmlentities"
-require "json"
 require "pathname"
 require "open-uri"
 require "pp"
 require_relative "./cleanup_block.rb"
+require_relative "./cleanup_ref.rb"
 
 module Asciidoctor
   module ISO
@@ -15,15 +14,18 @@ module Asciidoctor
       end
 
       def cleanup(xmldoc)
+        sections_cleanup(xmldoc)
         termdef_cleanup(xmldoc)
         isotitle_cleanup(xmldoc)
         table_cleanup(xmldoc)
         formula_cleanup(xmldoc)
         figure_cleanup(xmldoc)
         ref_cleanup(xmldoc)
-        review_note_cleanup(xmldoc)
+        note_cleanup(xmldoc)
         normref_cleanup(xmldoc)
+        reference_names(xmldoc)
         xref_cleanup(xmldoc)
+        quotesource_cleanup(xmldoc)
         para_cleanup(xmldoc)
         callout_cleanup(xmldoc)
         origin_cleanup(xmldoc)
@@ -51,37 +53,16 @@ module Asciidoctor
         end
       end
 
-      def xref_cleanup(xmldoc)
-        reference_names(xmldoc)
-        xmldoc.xpath("//xref").each do |x|
-          #if InlineAnchor::is_refid? x["target"]
-          if is_refid? x["target"]
-            x.name = "eref"
-            x["bibitemid"] = x["target"]
-            x["citeas"] = @anchors[x["target"]][:xref]
-            x.delete("target")
-          else
-            x.delete("type")
-          end
-        end
-      end
-
-      def origin_cleanup(xmldoc)
-        xmldoc.xpath("//origin").each do |x|
-          x["citeas"] = @anchors[x["bibitemid"]][:xref]
-          n = x.next_element
-          if !n.nil? && n.name == "isosection"
-            n.name = "locality"
-            n["type"] = "section"
-            n.parent = x
-          end
-        end
-      end
+      LOCALITY_REGEX_STR = <<~REGEXP
+        ^((?<locality>section|clause|part|paragraph|chapter|page)\\s+
+               (?<ref>\\S+?)|(?<locality>whole))[,:]?\\s*
+         (?<text>.*)$
+      REGEXP
+      LOCALITY_RE = Regexp.new(LOCALITY_REGEX_STR.gsub(/\s/, ""),
+                               Regexp::IGNORECASE|Regexp::MULTILINE)
 
       def termdef_warn(text, re, term, msg)
-        if re.match? text
-          warn "ISO style: #{term}: #{msg}"
-        end
+        re.match? text and warn "ISO style: #{term}: #{msg}"
       end
 
       def termdef_style(xmldoc)
@@ -120,9 +101,7 @@ module Asciidoctor
           t = Nokogiri::XML::Element.new("definition", xmldoc)
           first_child.replace(t)
           t << first_child.remove
-          d.xpath("./p | ./figure | ./formula").each do |n|
-            t << n.remove
-          end
+          d.xpath("./p | ./figure | ./formula").each { |n| t << n.remove }
         end
       end
 
@@ -143,69 +122,18 @@ module Asciidoctor
         termdef_style(xmldoc)
       end
 
-      def isotitle_cleanup(xmldoc)
-        # Remove italicised ISO titles
-        xmldoc.xpath("//isotitle").each do |a|
-          if a.elements.size == 1 && a.elements[0].name == "em"
-            a.children = a.elements[0].children
-          end
-        end
-      end
-
-      def dl_table_cleanup(xmldoc)
-        # move Key dl after table footer
-        q = "//table/following-sibling::*[1]"\
-          "[self::p and normalize-space() = 'Key']"
-        xmldoc.xpath(q).each do |s|
-          if !s.next_element.nil? && s.next_element.name == "dl"
-            s.previous_element << s.next_element.remove
-            s.remove
-          end
-        end
-      end
-
-      def ref_cleanup(xmldoc)
-        # move ref before p
-        xmldoc.xpath("//p/ref").each do |r|
-          parent = r.parent
-          parent.previous = r.remove
-        end
-        xmldoc
-      end
-
-      def review_note_cleanup(xmldoc)
-        xmldoc.xpath("//review").each do |n|
-          prev = n.previous_element
-          if !prev.nil? && prev.name == "p"
-            n.parent = prev
-          end
-        end
-      end
-
-      def normref_cleanup(xmldoc)
-        q = "//references[title = 'Normative References']"
-        r = xmldoc.at(q)
-        r.elements.each do |n|
-          unless ["title", "bibitem"].include? n.name
-            n.remove
-          end
-        end
-      end
-
-      def format_ref(ref, isopub)
-        return "ISO #{ref}" if isopub
-        return "[#{ref}]" if /^\d+$/.match?(ref) && !/^\[.*\]$/.match?(ref) 
-        ref
-      end
+      ELEMS_ALLOW_NOTES = 
+        %w[p formula quote sourcecode example admonition ul ol dl figure]
 
-      def reference_names(xmldoc)
-        xmldoc.xpath("//bibitem").each do |ref|
-          isopub = ref.at(("./publisher/affiliation[name = 'ISO']"))
-          docid = ref.at(("./docidentifier"))
-          date = ref.at(("./publisherdate"))
-          reference = format_ref(docid.text, isopub)
-          reference += ": #{date.text}" if date && isopub
-          @anchors[ref["id"]] = { xref: reference }
+      # if a note is at the end of a section, it is left alone
+      # if a note is followed by a non-note block, 
+      # it is moved inside its preceding block
+      def note_cleanup(xmldoc)
+        q = "//note[following-sibling::*[not(local-name() = 'note')]]"
+        xmldoc.xpath(q).each do |n|
+          next unless n.ancestors("table").empty?
+          prev = n.previous_element or next
+          n.parent = prev if ELEMS_ALLOW_NOTES.include? prev.name
         end
       end
 

data/lib/asciidoctor/iso/cleanup_block.rb

@@ -113,7 +113,7 @@ module Asciidoctor
         figure_footnote_cleanup(xmldoc)
         figure_dl_cleanup(xmldoc)
         subfigure_cleanup(xmldoc)
-      end 
+      end
 
       def table_footnote_renumber(xmldoc)
         xmldoc.xpath("//table | //figure").each do |t|
@@ -152,6 +152,15 @@ module Asciidoctor
         other_footnote_renumber(xmldoc)
       end
 
+      def sections_cleanup(x)
+        s = x.at("//sections")
+        foreword = x.at("//foreword")
+        s.previous = foreword.remove
+        introduction = x.at("//introduction")
+        s.previous = introduction.remove if introduction
+        x.xpath("//sections/references").reverse_each { |r| s.next = r.remove }
+        x.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
+      end
     end
   end
 end

data/lib/asciidoctor/iso/cleanup_ref.rb

@@ -0,0 +1,100 @@
+module Asciidoctor
+  module ISO
+    module Cleanup
+
+      def extract_localities(x)
+        text = x.children.first.remove.text
+        m = LOCALITY_RE.match text
+        while !m.nil?
+          ref = m[:ref] ? "<reference>#{m[:ref]}</reference>" : ""
+          locality = m[:locality].downcase
+          x.add_child("<locality type='#{locality}'>#{ref}</locality>")
+          text = m[:text]
+          m = LOCALITY_RE.match text
+        end
+        x.add_child(text)
+      end
+
+      def xref_to_eref(x)
+        x["bibitemid"] = x["target"]
+        x["citeas"] = @anchors&.dig(x["target"], :xref) or
+          warn "ISO: #{x["target"]} is not a real reference!"
+        x.delete("target")
+        extract_localities(x) unless x.children.empty?
+      end
+
+      def xref_cleanup(xmldoc)
+        xmldoc.xpath("//xref").each do |x|
+          if is_refid? x["target"]
+            x.name = "eref"
+            xref_to_eref(x)
+          else
+            x.delete("type")
+          end
+        end
+      end
+
+      def quotesource_cleanup(xmldoc)
+        xmldoc.xpath("//quote/source").each do |x|
+          xref_to_eref(x)
+        end
+      end
+
+      def origin_cleanup(xmldoc)
+        xmldoc.xpath("//origin").each do |x|
+          x["citeas"] = @anchors[x["bibitemid"]][:xref]
+          n = x.next_element
+          if !n.nil? && n.name == "isosection"
+            n.name = "locality"
+            n["type"] = "section"
+            n.parent = x
+          end
+        end
+      end
+
+      def isotitle_cleanup(xmldoc)
+        # Remove italicised ISO titles
+        xmldoc.xpath("//isotitle").each do |a|
+          if a.elements.size == 1 && a.elements[0].name == "em"
+            a.children = a.elements[0].children
+          end
+        end
+      end
+
+      def ref_cleanup(xmldoc)
+        # move ref before p
+        xmldoc.xpath("//p/ref").each do |r|
+          parent = r.parent
+          parent.previous = r.remove
+        end
+        xmldoc
+      end
+
+      def normref_cleanup(xmldoc)
+        q = "//references[title = 'Normative References']"
+        r = xmldoc.at(q)
+        r.elements.each do |n|
+          n.remove unless ["title", "bibitem"].include? n.name
+        end
+      end
+
+      def format_ref(ref, isopub)
+        return ref if isopub
+        return "[#{ref}]" if /^\d+$/.match?(ref) && !/^\[.*\]$/.match?(ref)
+        ref
+      end
+
+      def reference_names(xmldoc)
+        xmldoc.xpath("//bibitem").each do |ref|
+          isopub = ref.at("./contributor[role/@type = 'publisher']/"\
+                          "organization[name = 'ISO']")
+          docid = ref.at("./docidentifier")
+          date = ref.at("./publisherdate")
+          reference = format_ref(docid.text, isopub)
+          reference += ": #{date.text}" if date && isopub
+          @anchors[ref["id"]] = { xref: reference }
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/iso/converter.rb

@@ -3,13 +3,14 @@ require "asciidoctor/iso/version"
 require "asciidoctor/iso/base"
 require "asciidoctor/iso/front"
 require "asciidoctor/iso/lists"
-require "asciidoctor/iso/inline_anchor"
+require "asciidoctor/iso/inline"
 require "asciidoctor/iso/blocks"
 require "asciidoctor/iso/section"
 require "asciidoctor/iso/table"
 require "asciidoctor/iso/validate"
 require "asciidoctor/iso/utils"
 require "asciidoctor/iso/cleanup"
+require_relative "./macros.rb"
 
 module Asciidoctor
   module ISO
@@ -22,7 +23,7 @@ module Asciidoctor
       include ::Asciidoctor::ISO::Base
       include ::Asciidoctor::ISO::Front
       include ::Asciidoctor::ISO::Lists
-      include ::Asciidoctor::ISO::InlineAnchor
+      include ::Asciidoctor::ISO::Inline
       include ::Asciidoctor::ISO::Blocks
       include ::Asciidoctor::ISO::Section
       include ::Asciidoctor::ISO::Table
@@ -50,6 +51,8 @@ module Asciidoctor
       alias_method :inline_kbd, :skip
       alias_method :inline_menu, :skip
       alias_method :inline_image, :skip
+
+
     end
   end
 end

data/lib/asciidoctor/iso/front.rb

@@ -10,7 +10,7 @@ module Asciidoctor
   module ISO
     module Front
       def metadata_id(node, xml)
-        xml.id do |i|
+        xml.docidentifier do |i|
           i.project_number node.attr("docnumber"),
             **attr_code(part: node.attr("partnumber"))
           if node.attr("tc-docnumber")
@@ -27,19 +27,30 @@ module Asciidoctor
         end
       end
 
+      def committee_component(compname, node, out)
+        out.send compname.gsub(/-/, "_"), node.attr(compname),
+          **attr_code(number: node.attr("#{compname}-number"),
+                      type: node.attr("#{compname}-type"))
+      end
+
       def metadata_author(node, xml)
-        xml.creator **{ role: "author" } do |a|
-          a.technical_committee node.attr("technical-committee"),
-            **attr_code(number: node.attr("technical-committee-number"))
-          if node.attr("subcommittee")
-            a.subcommittee node.attr("subcommittee"),
-              **attr_code(number: node.attr("subcommittee-number"))
+        xml.contributor do |c|
+          c.role **{ type: "author" }
+          c.organization do |a|
+            a.name "ISO"
           end
-          if node.attr("workgroup")
-            a.workgroup node.attr("workgroup"),
-              **attr_code(number: node.attr("workgroup-number"))
+        end
+      end
+
+      def metadata_publisher(node, xml)
+        publishers = node.attr("publisher") || "ISO"
+        publishers.split(/,[ ]?/).each do |p|
+          xml.contributor do |c|
+            c.role **{ type: "publisher" }
+            c.organization do |a|
+              a.name p
+            end
           end
-          a.secretariat node.attr("secretariat") if node.attr("secretariat")
         end
       end
 
@@ -47,8 +58,10 @@ module Asciidoctor
         from = node.attr("copyright-year") || Date.today.year
         xml.copyright do |c|
           c.from from
-          c.owner do |o|
-            o.affiliation "ISO"
+          c.owner do |owner|
+            owner.organization do |o|
+              o.name "ISO"
+            end
           end
         end
       end
@@ -60,26 +73,41 @@ module Asciidoctor
         end
       end
 
+      def metadata_committee(node, xml)
+        xml.editorialgroup do |a|
+          committee_component("technical-committee", node, a)
+          committee_component("subcommittee", node, a)
+          committee_component("workgroup", node, a)
+          node.attr("secretariat") && a.secretariat(node.attr("secretariat"))
+        end
+      end
+
       def metadata(node, xml)
-        metadata_status(node, xml)
+        title node, xml
+        metadata_id(node, xml)
         metadata_author(node, xml)
+        metadata_publisher(node, xml)
         xml.language node.attr("language")
-        xml.script "latn"
-        xml.type node.attr("doctype")
-        metadata_id(node, xml)
-        metadata_version(node, xml)
+        xml.script "Latn"
+        metadata_status(node, xml)
         metadata_copyright(node, xml)
+        metadata_committee(node, xml)
       end
 
       def title(node, xml)
         ["en", "fr"].each do |lang|
-          xml.title **{ language: lang } do |t|
-            if node.attr("title-intro-#{lang}")
-              t.title_intro { |t1| t1 << node.attr("title-intro-#{lang}") }
+          xml.title do |t|
+            at = { language: lang, format: "text/plain" }
+            node.attr("title-intro-#{lang}") and
+              t.title_intro **attr_code(at) do |t1|
+              t1 << node.attr("title-intro-#{lang}")
+            end
+            t.title_main **attr_code(at) do |t1|
+              t1 << node.attr("title-main-#{lang}")
             end
-            t.title_main { |t1| t1 << node.attr("title-main-#{lang}") }
-            if node.attr("title-part-#{lang}")
-              t.title_part node.attr("title-part-#{lang}")
+            node.attr("title-part-#{lang}") and
+              t.title_part **attr_code(at) do |t1|
+              t1 << node.attr("title-part-#{lang}")
             end
           end
         end

data/lib/asciidoctor/iso/html/header.html

@@ -11,7 +11,7 @@ xmlns:mv="http://macVmlSchemaUri" xmlns="http://www.w3.org/TR/REC-html40">
 <meta name=ProgId content=Word.Document>
 <meta name=Generator content="Microsoft Word 15">
 <meta name=Originator content="Microsoft Word 15">
-<link id=Main-File rel=Main-File href="../FILENAME.html">
+<link id=Main-File rel=Main-File href="../{{ filename }}.html">
 <!--[if gte mso 9]><xml>
  <o:shapedefaults v:ext="edit" spidmax="2049"/>
 </xml><![endif]-->
@@ -66,7 +66,7 @@ normal'><span lang=EN-GB><span style='mso-special-character:footnote-continuatio
 <div style='mso-element:header' id=eh1>
 
 <p class=MsoHeader align=left style='text-align:left;line-height:12.0pt;
-mso-line-height-rule:exactly'><span lang=EN-GB>ISO&nbsp;DOCNUMBER:DOCYEAR(E) DRAFTINFO</span></p>
+mso-line-height-rule:exactly'><span lang=EN-GB>{{ agency }}&nbsp;{{ docnumber }}:{{ docyear }}(E){{ draftinfo }}</span></p>
 
 </div>
 
@@ -74,7 +74,7 @@ mso-line-height-rule:exactly'><span lang=EN-GB>ISO&nbsp;DOCNUMBER:DOCYEAR(E) DRA
 
 <p class=MsoHeader style='margin-bottom:18.0pt'><span lang=EN-GB
 style='font-size:10.0pt;mso-bidi-font-size:11.0pt;font-weight:normal'>©
-ISO&nbsp;DOCYEAR&nbsp;– All rights reserved</span><span lang=EN-GB
+{{ agency }}&nbsp;{{ docyear }}&nbsp;– All rights reserved</span><span lang=EN-GB
 style='font-weight:normal'><o:p></o:p></span></p>
 
 </div>
@@ -93,21 +93,21 @@ style='mso-bidi-font-weight:normal'><span lang=EN-GB style='font-size:10.0pt;
 mso-bidi-font-size:11.0pt'><span style='mso-element:field-end'></span></span></b><![endif]--><span
 lang=EN-GB style='font-size:10.0pt;mso-bidi-font-size:11.0pt'><span
 style='mso-tab-count:1'>                                                                                                                                                                           </span>©
-ISO&nbsp;DOCYEAR&nbsp;– All rights reserved<o:p></o:p></span></p>
+{{ agency }}&nbsp;{{ docyear }}&nbsp;– All rights reserved<o:p></o:p></span></p>
 
 </div>
 
 <div style='mso-element:header' id=eh2>
 
 <p class=MsoHeader align=left style='text-align:left;line-height:12.0pt;
-mso-line-height-rule:exactly'><span lang=EN-GB>ISO&nbsp;DOCNUMBER:DOCYEAR(E) DRAFTINFO</span></p>
+mso-line-height-rule:exactly'><span lang=EN-GB>{{ agency }}&nbsp;{{ docnumber }}:{{ docyear }}(E){{ draftinfo }}</span></p>
 
 </div>
 
 <div style='mso-element:header' id=h2>
 
 <p class=MsoHeader align=right style='text-align:right;line-height:12.0pt;
-mso-line-height-rule:exactly'><span lang=EN-GB>ISO&nbsp;DOCNUMBER:DOCYEAR(E) DRAFTINFO</span></p>
+mso-line-height-rule:exactly'><span lang=EN-GB>{{ agency }}&nbsp;{{ docnumber }}:{{ docyear }}(E){{ draftinfo }}</span></p>
 
 </div>
 
@@ -124,14 +124,14 @@ lang=EN-GB style='font-size:10.0pt;mso-bidi-font-size:11.0pt'><span
 style='mso-element:field-end'></span></span><![endif]--><span lang=EN-GB
 style='font-size:10.0pt;mso-bidi-font-size:11.0pt'><span style='mso-tab-count:
 1'>                                                                                                                                                                           </span>©
-ISO&nbsp;DOCYEAR&nbsp;– All rights reserved<o:p></o:p></span></p>
+{{ agency }}&nbsp;{{ docyear }}&nbsp;– All rights reserved<o:p></o:p></span></p>
 
 </div>
 
 <div style='mso-element:footer' id=f2>
 
 <p class=MsoFooter style='line-height:12.0pt'><span lang=EN-GB
-style='font-size:10.0pt;mso-bidi-font-size:11.0pt'>© ISO&nbsp;DOCYEAR&nbsp;– All
+style='font-size:10.0pt;mso-bidi-font-size:11.0pt'>© {{ agency }}&nbsp;{{ docyear }}&nbsp;– All
 rights reserved<span style='mso-tab-count:1'>                                                                                                                                                                          </span></span><!--[if supportFields]><span
 lang=EN-GB style='font-size:10.0pt;mso-bidi-font-size:11.0pt'><span
 style='mso-element:field-begin'></span> PAGE<span style='mso-spacerun:yes'>  
@@ -158,14 +158,14 @@ style='mso-bidi-font-weight:normal'><span lang=EN-GB style='font-size:10.0pt;
 mso-bidi-font-size:11.0pt'><span style='mso-element:field-end'></span></span></b><![endif]--><span
 lang=EN-GB style='font-size:10.0pt;mso-bidi-font-size:11.0pt'><span
 style='mso-tab-count:1'>                                                                                                                                                                           </span>©
-ISO&nbsp;DOCYEAR&nbsp;– All rights reserved<o:p></o:p></span></p>
+{{ agency }}&nbsp;{{ docyear }}&nbsp;– All rights reserved<o:p></o:p></span></p>
 
 </div>
 
 <div style='mso-element:footer' id=f3>
 
 <p class=MsoFooter style='line-height:12.0pt'><span lang=EN-GB
-style='font-size:10.0pt;mso-bidi-font-size:11.0pt'>© ISO&nbsp;DOCYEAR&nbsp;– All
+style='font-size:10.0pt;mso-bidi-font-size:11.0pt'>© {{ agency }}&nbsp;{{ docyear }}&nbsp;– All
 rights reserved<span style='mso-tab-count:1'>                                                                                                                                                                           </span></span><!--[if supportFields]><b
 style='mso-bidi-font-weight:normal'><span lang=EN-GB style='font-size:10.0pt;
 mso-bidi-font-size:11.0pt'><span style='mso-element:field-begin'></span>