metanorma-ieee 0.0.3 → 0.0.6

data/lib/isodoc/ieee/metadata.rb

@@ -93,6 +93,8 @@ module IsoDoc
         doctype(isoxml, _out)
         set(:full_doctitle, fulltitle(@metadata[:doctype], draft))
         set(:abbrev_doctitle, fulltitle(@metadata[:doctype_abbrev], draft))
+        prov = isoxml&.at(ns("//bibdata/title[@type='provenance']")) and
+          set(:provenance_doctitle, prov.children.to_xml)
       end
 
       def fulltitle(type, draft)
@@ -101,23 +103,6 @@ module IsoDoc
         title
       end
 
-      def relations(isoxml, _out)
-        super
-        relations_get(isoxml, "updates")
-        relations_get(isoxml, "merges")
-      end
-
-      def relations_get(isoxml, type)
-        std = isoxml.xpath(ns("//bibdata/relation[@type = '#{type}']"))
-        return if std.empty?
-
-        ret = std.map do |x|
-          x.at(ns(".//docidentifier[@primary = 'true']"))&.text ||
-            x.at(ns(".//docidentifier"))&.text
-        end
-        set(type.to_sym, ret)
-      end
-
       def ddMMMyyyy(isodate)
         return nil if isodate.nil?
 

data/lib/isodoc/ieee/presentation_ref.rb

@@ -14,7 +14,7 @@ module IsoDoc
         if %w(techreport standard).include?(bib[:type])
           node["citeas"] + " #{bib[:ord]}"
         else
-          "#{bib[:title]} " + node["citeas"]
+          "#{bib[:author]} " + node["citeas"]
         end
       end
 
@@ -23,8 +23,10 @@ module IsoDoc
           .each_with_object({}) do |b, m|
           m[b["id"]] =
             { docid: pref_ref_code(b), type: b["type"],
-              title: b.at(ns("./title"))&.text ||
-                     b.at(ns("./formattedref"))&.text,
+              title: (b.at(ns("./title")) ||
+                     b.at(ns("./formattedref")))&.text,
+              author: @author[b["id"]] || (b.at(ns("./title")) ||
+                     b.at(ns("./formattedref")))&.text,
               ord: b.at(ns("./docidentifier[@type = 'metanorma' or "\
                            "@type = 'metanorma-ordinal']")).text }
         end
@@ -35,13 +37,22 @@ module IsoDoc
                                              i18nhash: @i18n.get)
       end
 
-      def bibrender_relaton(xml)
-        bib = xml.dup
-        bib["suppress_identifier"] == true and
-          bib.xpath(ns("./docidentifier")).each(&:remove)
+      def citestyle
+        "author-date"
+      end
+
+      def references_render(docxml)
+        @author = {}
+        super
+      end
+
+      def bibrender_relaton(xml, renderings)
+        f = renderings[xml["id"]][:formattedref]
+        f &&= "<formattedref>#{f}</formattedref>"
         xml.children =
-          "#{bibrenderer.render(bib.to_xml)}"\
-          "#{xml.xpath(ns('./docidentifier | ./uri | ./note | ./title')).to_xml}"
+          "#{f}#{xml.xpath(ns('./docidentifier | ./uri | ./note | ./title'))
+          .to_xml}"
+        @author[xml["id"]] = renderings[xml["id"]][:author]
       end
 
       def creatornames(bibitem)

data/lib/isodoc/ieee/presentation_terms.rb

@@ -26,25 +26,24 @@ module IsoDoc
 
       def unwrap_multidef(coll)
         if coll.all? do |c|
-          c.elements.size == 1 && c.elements.first.name == "p"
-        end
+             c.elements.size == 1 && c.elements.first.name == "p"
+           end
           ret = coll.map do |c|
             c.elements.first.children.to_xml
           end
-          "<p>#{ret.join}</p>"
-        else
-          coll.map { |c| c.children.to_xml }.join
+          return "<p>#{ret.join}</p>"
         end
+        coll.map { |c| c.children.to_xml }.join
       end
 
       def unwrap_definition(docxml)
         docxml.xpath(ns("//definition/verbal-definition")).each do |v|
           next unless v.elements.all? { |e| %w(termsource p).include?(e.name) }
 
-          s = v.xpath(ns("./termsource"))
           p = v.xpath(ns("./p"))
           v.children =
-            "<p>#{p.map(&:children).map(&:to_xml).join("\n")}</p>#{s.to_xml}"
+            "<p>#{p.map(&:children).map(&:to_xml).join("\n")}</p>"\
+            "#{v.xpath(ns('./termsource')).to_xml}"
         end
         super
       end
@@ -61,12 +60,13 @@ module IsoDoc
       def term_related_collapse(coll)
         prev = 0
         coll[1..-1].each_with_index do |r, i|
-          if coll[prev]["type"] == r["type"]
-            coll[prev].at(ns("./preferred")) << "; #{r.at(ns('./preferred'))
-              .children.to_xml}"
-            r.remove
-          else prev = i
+          if coll[prev]["type"] != r["type"]
+            prev = i
+            next
           end
+          coll[prev].at(ns("./preferred")) << "; #{r.at(ns('./preferred'))
+              .children.to_xml}"
+          r.remove
         end
       end
 
@@ -74,8 +74,14 @@ module IsoDoc
         d = term.at(ns("./preferred/expression/name | "\
                        "./preferred/letter-symbol/name | "\
                        "./preferred/graphical-symbol/figure/name | "\
-                       "./preferred/graphical-symbol/figure/@id"))
-        HTMLEntities.new.decode(d&.text&.strip&.downcase) || "ZZZ"
+                       "./preferred/graphical-symbol/figure/@id | "\
+                       "./preferred"))
+        f = term.at(ns("./field-of-application")) || term.at(ns("./domain"))
+        HTMLEntities.new.decode("#{sort_terms_key1(d)} :: #{sort_terms_key1(f)}")
+      end
+
+      def sort_terms_key1(elem)
+        elem&.text&.strip&.downcase || "zzzz"
       end
 
       def term_related_reorder(coll)
@@ -110,8 +116,12 @@ module IsoDoc
       end
 
       def admitted_to_related(docxml)
-        docxml.xpath(ns("//term/admitted")).each do |a|
-          admitted_to_related1(a, a.parent.at(ns("./preferred")))
+        docxml.xpath(ns("//term")).each do |t|
+          t.xpath(ns("./admitted | ./preferred")).each_with_index do |a, i|
+            (i.zero? ||
+             a.at(ns("./abbreviation-type | ./graphical-symbol"))) and next
+            admitted_to_related1(a, t.at(ns("./preferred")))
+          end
         end
         term_reorder(docxml)
       end
@@ -217,12 +227,15 @@ module IsoDoc
       end
 
       def merge_second_preferred(term)
-        prefs = term.xpath(ns("./preferred[expression/name]"))
-        prefs.size > 1 or return
-        alts = prefs[1..-1].map do |p|
+        pref =
+          term.at(ns("./preferred[not(abbreviation-type)]/expression/name"))
+        x = term.xpath(ns("./preferred[expression/name][abbreviation-type] | "\
+                          "./admitted[expression/name][abbreviation-type]"))
+        (pref && !x.empty?) or return
+        tail = x.map do |p|
           p.remove.at(ns("./expression/name")).children.to_xml.strip
-        end
-        prefs.first.at(ns("./expression/name")) << " (#{alts.join(', ')})"
+        end.join(", ")
+        pref << " (#{tail})"
       end
 
       def termnote1(elem)

data/lib/isodoc/ieee/presentation_xml_convert.rb

@@ -166,13 +166,26 @@ module IsoDoc
           ulist.xpath(ns("./li")).each { |list| participants1(list, idx) }
           ulist.replace(ulist.children)
         end
+        affiliation_header(clause)
+      end
+
+      def affiliation_header(clause)
+        clause.xpath(ns(".//p[@type = 'officeorgrepmember']")).each do |p|
+          prev = p.previous_element
+          prev && prev.name == "p" &&
+            prev["type"] == "officeorgrepmember" and next
+          p.previous = <<~HDR
+            <p type='officeorgrepmemberhdr'><em>Organization
+            Represented</em><tab/><em>Name of Representative</em></p>
+          HDR
+        end
       end
 
       def participants1(list, idx)
         key = ""
         map = list.xpath(ns(".//dt | .//dd")).each_with_object({}) do |dtd, m|
           (dtd.name == "dt" and key = dtd.text) or
-            m[key] = dtd.text.strip
+            m[key] = @c.encode(dtd.text.strip, :hexadecimal)
         end
         list.replace(participant_para(map, idx))
       end
@@ -187,8 +200,12 @@ module IsoDoc
       end
 
       def participant_member_para(map, name, _idx)
-        (map["company"] and "<p type='officeorgmember'>#{name}</p>") or
-          "<p type='officemember'>#{name}</p>"
+        if map["company"] && (map["name"] || map["surname"])
+          pers = map["name"] || "#{map['given']} #{map['surname']}"
+          "<p type='officeorgrepmember'>#{name}<tab/>#{pers}</p>"
+        elsif map["company"] then "<p type='officeorgmember'>#{name}</p>"
+        else "<p type='officemember'>#{name}</p>"
+        end
       end
 
       def participant_officeholder_para(map, name, idx)

data/lib/isodoc/ieee/word_authority.rb

@@ -46,6 +46,7 @@ module IsoDoc
           officeholder_style(p)
         end
         officemember_style(docxml)
+        officeorgrep_style(docxml)
         three_column_officemembers(docxml
           .at("//div[@id = 'boilerplate-participants']"))
       end
@@ -77,6 +78,19 @@ module IsoDoc
         end
       end
 
+      def officeorgrep_style(docxml)
+        docxml.xpath("//p[@type = 'officeorgrepmemberhdr']").each do |p|
+          p["class"] = "IEEEStdsNamesList"
+          p["style"] =
+            "margin-bottom:6.0pt;tab-stops:right 432.0pt;"
+        end
+        docxml.xpath("//p[@type = 'officeorgrepmember']").each do |p|
+          p["class"] = "IEEEStdsNamesList"
+          p["style"] =
+            "margin-top:6.0pt;tab-stops:right dotted 432.0pt;"
+        end
+      end
+
       def three_column_officemembers(div)
         return unless div
 

data/lib/metanorma/ieee/biblio.rng

@@ -225,9 +225,9 @@
         <zeroOrMore>
           <ref name="forename"/>
         </zeroOrMore>
-        <zeroOrMore>
-          <ref name="initial"/>
-        </zeroOrMore>
+        <optional>
+          <ref name="formatted-initials"/>
+        </optional>
         <ref name="surname"/>
         <zeroOrMore>
           <ref name="addition"/>
@@ -247,8 +247,8 @@
       <ref name="LocalizedString"/>
     </element>
   </define>
-  <define name="initial">
-    <element name="initial">
+  <define name="formatted-initials">
+    <element name="formatted-initials">
       <ref name="LocalizedString"/>
     </element>
   </define>
@@ -264,6 +264,9 @@
   </define>
   <define name="forename">
     <element name="forename">
+      <optional>
+        <attribute name="initial"/>
+      </optional>
       <ref name="LocalizedString"/>
     </element>
   </define>

data/lib/metanorma/ieee/cleanup.rb

@@ -6,7 +6,7 @@ module Metanorma
     class Converter < Standoc::Converter
       def initial_boilerplate(xml, isodoc)
         intro_boilerplate(xml, isodoc)
-        super
+        super if @document_scheme == "ieee-sa-2021"
         initial_note(xml)
         word_usage(xml)
         participants(xml)
@@ -31,6 +31,8 @@ module Metanorma
       end
 
       def word_usage(xml)
+        return unless @document_scheme == "ieee-sa-2021"
+
         n = xml.at("//boilerplate//clause[@id = 'boilerplate_word_usage']")
           &.remove
         s = xml.at("//clause[@type = 'overview']")
@@ -122,12 +124,13 @@ module Metanorma
       end
 
       def participants(xml)
-        populate_participants(xml, "boilerplate-participants-wg",
-                              "working group")
-        populate_participants(xml, "boilerplate-participants-bg",
-                              "balloting group")
-        populate_participants(xml, "boilerplate-participants-sb",
-                              "standards board")
+        return unless @document_scheme == "ieee-sa-2021"
+
+        { "boilerplate-participants-wg": "working group",
+          "boilerplate-participants-bg": "balloting group",
+          "boilerplate-participants-sb": "standards board" }.each do |k, v|
+            populate_participants(xml, k.to_s, v)
+          end
         p = xml.at(".//p[@type = 'emeritus_sign']")
         ul = xml.at("//clause[@id = 'boilerplate-participants-sb']//ul")
         p && ul and ul.next = p
@@ -153,7 +156,9 @@ module Metanorma
       end
 
       def participants_dl_to_ul(clause)
-        clause.xpath(".//dl[.//dl]").each do |dl|
+        clause.xpath(".//dl").each do |dl|
+          next unless dl.ancestors("dl, ul, ol").empty?
+
           dl.name = "ul"
           dl.xpath("./dt").each(&:remove)
           dl.xpath("./dd").each { |li| li.name = "li" }
@@ -161,11 +166,10 @@ module Metanorma
       end
 
       def populate_participants2(list)
-        c = HTMLEntities.new
         if dl = list.at("./dl")
           ret = extract_participants(dl)
           dl.children = ret.keys.map do |k|
-            "<dt>#{k}</dt><dd>#{c.encode(ret[k], :hexadecimal)}</dd>"
+            "<dt>#{k}</dt><dd>#{ret[k]}</dd>"
           end.join
         else
           list.children = "<dl><dt>name</dt><dd>#{list.children.to_xml}</dd>"\
@@ -177,11 +181,45 @@ module Metanorma
         key = ""
         map = dlist.xpath("./dt | ./dd").each_with_object({}) do |dtd, m|
           (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) or
-            m[key.strip.downcase] = dtd.text.strip
+            m[key.strip.downcase] =
+              @c.encode(@c.decode(dtd.text.strip), :hexadecimal)
         end
         map["role"] ||= "member"
         map
       end
+
+      def bibdata_cleanup(xmldoc)
+        super
+        provenance_title(xmldoc)
+      end
+
+      def provenance_title(xmldoc)
+        u = xmldoc.xpath("//bibdata/relation[@type = 'updates']")
+        m = xmldoc.xpath("//bibdata/relation[@type = 'merges']")
+        u.empty? and m.empty? and return
+        ins = xmldoc.at("//bibdata/title")
+        t = provenance_title1(u, m)
+        ins.next = "<title type='provenance' language='en' "\
+                   "format='application/xml'>#{t}</title>"
+      end
+
+      def provenance_title1(updates, merges)
+        ret = ""
+        u = @isodoc.i18n.boolean_conj(tm_id_extract(updates), "and")
+        m = @isodoc.i18n.boolean_conj(tm_id_extract(merges), "and")
+        u.empty? or ret += "Revision of #{u}"
+        !u.empty? && !m.empty? and ret += "<br/>"
+        m.empty? or ret += "Incorporates #{m}"
+        ret
+      end
+
+      def tm_id_extract(relations)
+        relations.map do |u|
+          u.at("./bibitem/docidentifier[@scope = 'trademark']") ||
+            u.at("./bibitem/docidentifier[@primary = 'true']") ||
+            u.at("./bibitem/docidentifier")
+        end.map(&:text)
+      end
     end
   end
 end

data/lib/metanorma/ieee/cleanup_ref.rb

@@ -77,7 +77,7 @@ module Metanorma
           .each_with_object({}) do |b, m|
           n = b.at("./contributor[role/@type = 'publisher']/organization/name")
           n&.text == "Institute of Electrical and Electronics Engineers" and
-            m[b["id"]] = true
+            m[b["id"]] = b.at("./docidentifier[@scope = 'trademark']")&.text
         end
         trademark_ieee_erefs1(xmldoc, "//preface//eref", ieee)
         trademark_ieee_erefs1(xmldoc, "//sections//eref | //annex//eref", ieee)
@@ -86,7 +86,7 @@ module Metanorma
       def trademark_ieee_erefs1(xmldoc, path, ieee)
         xmldoc.xpath(path).each_with_object({}) do |e, m|
           ieee[e["bibitemid"]] or next
-          m[e["bibitemid"]] or e["citeas"] += "\u2122"
+          m[e["bibitemid"]] or e["citeas"] = ieee[e["bibitemid"]]
           m[e["bibitemid"]] = true
         end
       end
@@ -113,6 +113,14 @@ module Metanorma
             "<docidentifier type='metanorma-ordinal'>[B#{idx}]</docidentifier>"
         end
       end
+
+      def select_docid(ref)
+        ret = super
+        if %w(standard techreport).include?(ref["type"]) then ret
+        else
+          ref.at("./docidentifier[@type = 'metanorma-ordinal']") || ret
+        end
+      end
     end
   end
 end

data/lib/metanorma/ieee/converter.rb

@@ -16,6 +16,7 @@ module Metanorma
 
       def init(node)
         super
+        @document_scheme ||= "ieee-sa-2021"
         @hierarchical_assets = node.attr("hierarchical-object-numbering")
       end
 

data/lib/metanorma/ieee/front.rb

@@ -1,3 +1,5 @@
+require "isoics"
+
 module Metanorma
   module IEEE
     class Converter < Standoc::Converter
@@ -64,7 +66,7 @@ module Metanorma
 
       def metadata_status(node, xml)
         status = node.attr("status") || node.attr("docstage") ||
-          (node.attr("draft") ? "developing" : "active")
+          (node.attr("draft") ? "draft" : "approved")
         xml.status do |s|
           s.stage status
         end

data/lib/metanorma/ieee/ieee.rng

@@ -14,22 +14,32 @@
         <value>guide</value>
         <value>recommended-practice</value>
         <value>standard</value>
+        <value>whitepaper</value>
+        <value>redline</value>
+        <value>other</value>
       </choice>
     </define>
     <define name="stage">
       <element name="stage">
         <choice>
-          <value>developing</value>
-          <value>active</value>
-          <value>inactive</value>
+          <value>draft</value>
+          <value>approved</value>
+          <value>superseded</value>
+          <value>withdrawn</value>
         </choice>
       </element>
     </define>
     <define name="editorialgroup">
       <element name="editorialgroup">
-        <ref name="society"/>
-        <ref name="balloting-group"/>
-        <ref name="working-group"/>
+        <optional>
+          <ref name="society"/>
+        </optional>
+        <optional>
+          <ref name="balloting-group"/>
+        </optional>
+        <optional>
+          <ref name="working-group"/>
+        </optional>
         <oneOrMore>
           <ref name="committee"/>
         </oneOrMore>
@@ -52,14 +62,65 @@
       <optional>
         <ref name="trialuse"/>
       </optional>
-      <ref name="editorialgroup"/>
+      <optional>
+        <ref name="editorialgroup"/>
+      </optional>
       <zeroOrMore>
         <ref name="ics"/>
       </zeroOrMore>
+      <optional>
+        <ref name="standard_status"/>
+      </optional>
+      <optional>
+        <ref name="standard_modified"/>
+      </optional>
+      <optional>
+        <ref name="pubstatus"/>
+      </optional>
+      <optional>
+        <ref name="holdstatus"/>
+      </optional>
     </define>
   </include>
+  <define name="standard_status">
+    <element name="standard_status">
+      <choice>
+        <value>Inactive</value>
+        <value>Active</value>
+        <value>Superseded</value>
+      </choice>
+    </element>
+  </define>
+  <define name="standard_modified">
+    <element name="standard_modified">
+      <choice>
+        <value>Draft</value>
+        <value>Withdrawn</value>
+        <value>Superseded</value>
+        <value>Approved</value>
+        <value>Reserved</value>
+        <value>Redline</value>
+      </choice>
+    </element>
+  </define>
+  <define name="pubstatus">
+    <element name="pubstatus">
+      <choice>
+        <value>Active</value>
+        <value>Inactive</value>
+      </choice>
+    </element>
+  </define>
+  <define name="holdstatus">
+    <element name="holdstatus">
+      <choice>
+        <value>Hold</value>
+        <value>Publish</value>
+      </choice>
+    </element>
+  </define>
   <define name="BibliographicDateType" combine="choice">
-    <value>feecback-ended</value>
+    <value>feedback-ended</value>
   </define>
   <define name="trialuse">
     <element name="trial-use">

data/lib/metanorma/ieee/isodoc.rng

@@ -1285,7 +1285,12 @@
   </define>
   <define name="span">
     <element name="span">
-      <attribute name="class"/>
+      <optional>
+        <attribute name="class"/>
+      </optional>
+      <optional>
+        <attribute name="style"/>
+      </optional>
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>

data/lib/metanorma/ieee/reqt.rng

@@ -108,7 +108,7 @@
     </element>
   </define>
   <define name="label">
-    <element name="label">
+    <element name="identifier">
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>

data/lib/metanorma/ieee/validate.rb

@@ -29,7 +29,8 @@ module Metanorma
 
       def doctype_validate(xmldoc)
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
-        %w(standard recommended-practice guide).include? doctype or
+        %w(standard recommended-practice guide whitepaper redline other)
+          .include? doctype or
           @log.add("Document Attributes", nil,
                    "#{doctype} is not a recognised document type")
         docsubtype = xmldoc&.at("//bibdata/ext/subdoctype")&.text or return
@@ -40,7 +41,7 @@ module Metanorma
 
       def stage_validate(xmldoc)
         stage = xmldoc&.at("//bibdata/status/stage")&.text
-        %w(active inactive developing).include? stage or
+        %w(draft approved superseded withdrawn).include? stage or
           @log.add("Document Attributes", nil,
                    "#{stage} is not a recognised stage")
       end
@@ -148,13 +149,13 @@ module Metanorma
         pref = image_name_prefix(xmldoc)
         (xmldoc.xpath("//figure") - xmldoc.xpath("//table//figure"))
           .each do |f|
-            i = f.at("./image") or next
-            next if i["src"].start_with?("data:")
+            (i = f.at("./image") and !i["src"]&.start_with?("data:")) or next
 
             num = xrefs.anchor(f["id"], :label)
-            File.basename(i["src"], ".*") == "#{pref}_fig#{num}" or
+            base = File.basename(i["src"], ".*")
+            base == "#{pref}_fig#{num}" or
               @log.add("Style", i,
-                       "Image name #{i['src']} is expected to be #{pref}_fig#{num}")
+                       "Image name #{base} is expected to be #{pref}_fig#{num}")
           end
       end
 
@@ -169,13 +170,13 @@ module Metanorma
       def table_figure_name_validate(xmldoc, xrefs)
         xmldoc.xpath("//table[.//figure]").each do |t|
           xmldoc.xpath(".//figure").each do |f|
-            i = f.at("./image") or next
-            next if i["src"].start_with?("data:")
+            (i = f.at("./image") and !i["src"]&.start_with?("data:")) or next
 
             num = tablefigurenumber(t, f, xrefs)
-            File.basename(i["src"]) == num or
+            base = File.basename(i["src"])
+            base == num or
               @log.add("Style", i,
-                       "Image name #{i['src']} is expected to be #{num}")
+                       "Image name #{base} is expected to be #{num}")
           end
         end
       end

data/lib/metanorma/ieee/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module IEEE
-    VERSION = "0.0.3".freeze
+    VERSION = "0.0.6".freeze
   end
 end

data/lib/metanorma-ieee.rb

@@ -3,6 +3,6 @@ require "asciidoctor"
 require "isodoc/ieee"
 require "html2doc/ieee"
 
-if defined? Metanorma
+if defined? Metanorma::Registry
   Metanorma::Registry.instance.register(Metanorma::IEEE::Processor)
 end