metanorma-ieee 0.0.1 → 0.0.2

data/lib/isodoc/ieee/xref.rb

@@ -72,6 +72,37 @@ module IsoDoc
           )
         end
       end
+
+      def termnote_anchor_names(docxml)
+        docxml.xpath(ns("//*[termnote]")).each do |t|
+          c = Counter.new
+          sequence = UUIDTools::UUID.random_create.to_s
+          notes = t.xpath(ns("./termnote"))
+          notes.reject { |n| blank?(n["id"]) }.each do |n|
+            @anchors[n["id"]] =
+              anchor_struct("#{@labels['termnote']} #{increment_label(notes, n, c)}",
+                            n,
+                            @labels["note_xref"], "termnote", false)
+                .merge(sequence: sequence)
+          end
+        end
+      end
+
+      def note_anchor_names1(notes, counter)
+        sequence = UUIDTools::UUID.random_create.to_s
+        notes.each do |n|
+          next if @anchors[n["id"]] || blank?(n["id"])
+
+          @anchors[n["id"]] =
+            anchor_struct(increment_label(notes, n, counter), n,
+                          @labels["note_xref"], "note", false)
+              .merge(sequence: sequence)
+        end
+      end
+
+      def annex_name_lbl(clause, num)
+        super.sub(%r{<br/>(.*)$}, "<br/><span class='obligation'>\\1</span>")
+      end
     end
   end
 end

data/lib/metanorma/ieee/boilerplate.xml

@@ -280,7 +280,7 @@
     </clause>
 
     <clause>
-      <table unnumbered="true">
+      <table unnumbered="true" id="_isbn_pdf_print">
         <tbody>
           <tr><td>PDF:</td>	<td>ISBN {{ isbn_pdf }}</td>	<td>{{ stdid_pdf}}</td></tr>
           <tr><td>Print:</td>	<td>ISBN {{ isbn_print}}</td>	<td>{{ stdid_print}}</td></tr>
@@ -289,9 +289,9 @@
     </clause>
 
     <clause>
-      <p>IEEE prohibits discrimination, harassment, and bullying.</p>
-      <p>For more information, visit <link target="https://www.ieee.org/about/corporate/governance/p9-26.html"/>.</p>
-      <p>No part of this publication may be reproduced in any form, in an electronic retrieval system or otherwise, without the prior written permission of the publisher.</p>
+      <p><em>IEEE prohibits discrimination, harassment, and bullying.</em><br/>
+        <em>For more information, visit <link target="https://www.ieee.org/about/corporate/governance/p9-26.html"/>.</em><br/>
+        <em>No part of this publication may be reproduced in any form, in an electronic retrieval system or otherwise, without the prior written permission of the publisher.</em></p>
     </clause>
   </feedback-statement>
 </boilerplate>

data/lib/metanorma/ieee/cleanup.rb

@@ -1,25 +1,8 @@
+require_relative "cleanup_ref"
+
 module Metanorma
   module IEEE
     class Converter < Standoc::Converter
-      BIBLIO =
-        "//bibliography/references[@normative = 'false'][not(@hidden)] | "\
-        "//bibliography/clause[.//references[@normative = 'false']] | "\
-        "//annex//references[@normative = 'false'][not(@hidden)]".freeze
-
-      def boilerplate_cleanup(xmldoc)
-        f = xmldoc.at(BIBLIO) and biblio_preface(f)
-        super
-      end
-
-      def biblio_preface(ref)
-        if ref.at("./note[@type = 'boilerplate']")
-          unwrap_boilerplate_clauses(ref, ".")
-        else
-          pref = @i18n.biblio_pref
-          ref.at("./title").next = "<p>#{pref}</p>"
-        end
-      end
-
       def initial_boilerplate(xml, isodoc)
         intro_boilerplate(xml, isodoc)
         super
@@ -29,7 +12,7 @@ module Metanorma
         return unless intro = xml.at("//introduction/title")
 
         template = <<~ADM
-          This introduction is not part of P{{ docnumeric }}{% if draft %}/D{{ draft }}{% endif %}, {{ doctitle }}
+          This introduction is not part of P{{ docnumeric }}{% if draft %}/D{{ draft }}{% endif %}, {{ full_doctitle }}
         ADM
         adm = isodoc.populate_template(template)
         intro.next = "<admonition>#{adm}</admonition>"
@@ -70,59 +53,6 @@ module Metanorma
         ins << "<fn><p>#{@i18n.note_inform_fn}</p></fn>"
       end
 
-      def sort_biblio(bib)
-        bib.sort do |a, b|
-          sort_biblio_key(a) <=> sort_biblio_key(b)
-        end
-      end
-
-      OTHERIDS = "@type = 'DOI' or @type = 'metanorma' or @type = 'ISSN' or "\
-                 "@type = 'ISBN'".freeze
-
-      def sort_biblio_key(bib)
-        id = bib.at("./docidentifier[not(#{OTHERIDS})]")
-        title = bib.at("./title[@type = 'main']") ||
-          bib.at("./title") || bib.at("./formattedref")
-        "#{id&.text || 'ZZZZZ'} :: #{title&.text}"
-      end
-
-      def normref_cleanup(xmldoc)
-        super
-        normref_reorder(xmldoc)
-      end
-
-      def normref_reorder(xmldoc)
-        xmldoc.xpath("//references[@normative = 'true']").each do |r|
-          biblio_reorder1(r)
-        end
-      end
-
-      # end of citeas generation
-      def quotesource_cleanup(xmldoc)
-        super
-        trademark_ieee_erefs(xmldoc)
-      end
-
-      # Style manual 12.3.5
-      def trademark_ieee_erefs(xmldoc)
-        ieee = xmldoc.xpath("//references/bibitem")
-          .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
-        end
-        trademark_ieee_erefs1(xmldoc, "//preface//eref", ieee)
-        trademark_ieee_erefs1(xmldoc, "//sections//eref | //annex//eref", ieee)
-      end
-
-      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"]] = true
-        end
-      end
-
       def termdef_cleanup(xmldoc)
         term_reorder(xmldoc)
         super
@@ -155,6 +85,40 @@ module Metanorma
                     "./preferred/graphical-symbol/figure/@id")
         d.text.downcase
       end
+
+      def table_footnote_renumber1(fnote, idx, seen)
+        content = footnote_content(fnote)
+        idx += 1
+        if seen[content]
+          fnote.children = "<p>See Footnote #{seen[content]}.</p>"
+        else seen[content] = idx
+        end
+        fnote["reference"] = (idx - 1 + "a".ord).chr
+        fnote["table"] = true
+        [idx, seen]
+      end
+
+      def other_footnote_renumber1(fnote, idx, seen)
+        return [idx, seen] if fnote["table"]
+
+        content = footnote_content(fnote)
+        idx += 1
+        if seen[content]
+          fnote.children = "<p>See Footnote #{seen[content]}.</p>"
+        else seen[content] = idx
+        end
+        fnote["reference"] = idx.to_s
+        [idx, seen]
+      end
+
+      TERM_CLAUSE = "//sections//terms".freeze
+
+      def termdef_boilerplate_insert(xmldoc, isodoc, once = false)
+        once = true
+        super
+      end
+
+      def term_defs_boilerplate_cont(src, term, isodoc); end
     end
   end
 end

data/lib/metanorma/ieee/cleanup_ref.rb

@@ -0,0 +1,117 @@
+module Metanorma
+  module IEEE
+    class Converter < Standoc::Converter
+      BIBLIO =
+        "//bibliography/references[@normative = 'false'][not(@hidden)] | "\
+        "//bibliography/clause[.//references[@normative = 'false']] | "\
+        "//annex//references[@normative = 'false'][not(@hidden)]".freeze
+
+      def boilerplate_cleanup(xmldoc)
+        f = xmldoc.at(BIBLIO) and biblio_preface(f)
+        super
+      end
+
+      def biblio_preface(ref)
+        if ref.at("./note[@type = 'boilerplate']")
+          unwrap_boilerplate_clauses(ref, ".")
+        else
+          pref = @i18n.biblio_pref
+          ref.at("./title").next = "<p>#{pref}</p>"
+        end
+      end
+
+      def sort_biblio(bib)
+        bib.sort do |a, b|
+          sort_biblio_key(a) <=> sort_biblio_key(b)
+        end
+      end
+
+      OTHERIDS = "@type = 'DOI' or @type = 'metanorma' or @type = 'ISSN' or "\
+                 "@type = 'ISBN'".freeze
+
+      # Alphabetic by rendering: author surname or designation, followed by title
+      def sort_biblio_key(bib)
+        name = designator_or_name(bib)
+        title = bib.at("./title[@type = 'main']")&.text ||
+          bib.at("./title")&.text || bib.at("./formattedref")&.text
+        "#{name}. #{title}"
+      end
+
+      def designator_or_name(bib)
+        case bib["type"]
+        when "standard", "techreport"
+          n = bib.at("./docidentifier[@primary]") ||
+            bib.at("./docidentifier[not(#{OTHERIDS})]")
+          n&.text || "ZZZZ"
+        else
+          bib1 = bib.dup
+          bib1.add_namespace(nil, self.class::XML_NAMESPACE)
+          i = IsoDoc::IEEE::PresentationXMLConvert.new({ lang: @lang,
+                                                         script: @script })
+          i.i18n_init(@lang, @script)
+          i.creatornames(bib1)
+        end
+      end
+
+      def normref_cleanup(xmldoc)
+        super
+        normref_reorder(xmldoc)
+      end
+
+      def normref_reorder(xmldoc)
+        xmldoc.xpath("//references[@normative = 'true']").each do |r|
+          biblio_reorder1(r)
+        end
+      end
+
+      # end of citeas generation
+      def quotesource_cleanup(xmldoc)
+        super
+        trademark_ieee_erefs(xmldoc)
+      end
+
+      # Style manual 12.3.5
+      def trademark_ieee_erefs(xmldoc)
+        ieee = xmldoc.xpath("//references/bibitem")
+          .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
+        end
+        trademark_ieee_erefs1(xmldoc, "//preface//eref", ieee)
+        trademark_ieee_erefs1(xmldoc, "//sections//eref | //annex//eref", ieee)
+      end
+
+      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"]] = true
+        end
+      end
+
+      def biblio_renumber(xmldoc)
+        i = 0
+        xmldoc.xpath("//references[not(@normative = 'true')]"\
+                     "[not(@hidden = 'true')]").each do |r|
+                       r.xpath("./bibitem[not(@hidden = 'true')]").each do |b|
+                         i += 1
+                         biblio_renumber1(b, i)
+                       end
+                     end
+      end
+
+      def biblio_renumber1(bib, idx)
+        docid = bib.at("./docidentifier[@type = 'metanorma' or "\
+                       "@type = 'metanorma-ordinal']")
+        if /^\[?\d+\]?$/.match?(docid&.text)
+          docid.children = "[B#{idx}]"
+        elsif docid = bib.at("./docidentifier") || bib.at("./title[last()]") ||
+            bib.at("./formattedref")
+          docid.next =
+            "<docidentifier type='metanorma-ordinal'>[B#{idx}]</docidentifier>"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ieee/front.rb

@@ -54,31 +54,31 @@ module Metanorma
       end
 
       def wg_members(node, xml)
-        a = node.attr("wg_chair") and
+        a = node.attr("wg-chair") and
           metadata_editor(a, "Working Group Chair", xml)
-        a = node.attr("wg_vicechair") and
+        a = node.attr("wg-vicechair") and
           metadata_editor(a, "Working Group Vice-Chair", xml)
-        a = node.attr("wg_secretary") and
+        a = node.attr("wg-secretary") and
           metadata_editor(a, "Working Group Secretary", xml)
-        a = node.attr("wg_members") and
+        a = node.attr("wg-members") and
           metadata_multi_editors(a, "Working Group Member", xml)
       end
 
       def bg_members(node, xml)
-        a = node.attr("balloting_group_members") and
+        a = node.attr("balloting-group-members") and
           metadata_multi_editors(a, "Balloting Group Member", xml)
       end
 
       def std_board_members(node, xml)
-        a = node.attr("std_board_chair") and
+        a = node.attr("std-board-chair") and
           metadata_editor(a, "Standards Board Chair", xml)
-        a = node.attr("std_board_vicechair") and
+        a = node.attr("std-board-vicechair") and
           metadata_editor(a, "Standards Board Vice-Chair", xml)
-        a = node.attr("std_board_pastchair") and
+        a = node.attr("std-board-pastchair") and
           metadata_editor(a, "Standards Board Past Chair", xml)
-        a = node.attr("std_board_secretary") and
+        a = node.attr("std-board-secretary") and
           metadata_editor(a, "Standards Board Secretary", xml)
-        a = node.attr("balloting_group_members") and
+        a = node.attr("balloting-group-members") and
           metadata_multi_editors(a, "Standards Board Member", xml)
       end
 
@@ -115,6 +115,10 @@ module Metanorma
       def org_abbrev
         { "Institute of Electrical and Electronic Engineers" => "IEEE" }
       end
+
+      def relaton_relations
+        super + %w(merges updates)
+      end
     end
   end
 end

data/lib/metanorma/ieee/isodoc.rng

@@ -69,6 +69,17 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="AdmonitionType">
+      <choice>
+        <value>warning</value>
+        <value>note</value>
+        <value>tip</value>
+        <value>important</value>
+        <value>caution</value>
+        <value>statement</value>
+        <value>editorial</value>
+      </choice>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -116,6 +127,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="suppress_identifier">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <ref name="BibliographicItem"/>
       </element>
     </define>

data/lib/metanorma/ieee/validate.rb

@@ -14,9 +14,9 @@ module Metanorma
         super
         bibdata_validate(doc.root)
         title_validate(doc.root)
-        locality_erefs_validate(doc.root)
+        locality_validate(doc.root)
         bibitem_validate(doc.root)
-        listcount_validate(doc)
+        list_validate(doc)
         table_style(doc)
         figure_validate(doc)
       end
@@ -86,12 +86,26 @@ module Metanorma
            up upon versus via with within without a an the).include?(word)
       end
 
+      def locality_validate(root)
+        locality_range_validate(root)
+        locality_erefs_validate(root)
+      end
+
+      # Style manual 17.2 &c
+      def locality_range_validate(root)
+        root.xpath("//eref | xref").each do |e|
+          e.at(".//localityStack[@connective = 'from'] | .//referenceTo") and
+            @log.add("Style", e, "Cross-reference contains range, "\
+                                 "should be separate cross-references")
+        end
+      end
+
       # Style manual 12.3.2
       def locality_erefs_validate(root)
         root.xpath("//eref[descendant::locality]").each do |t|
           if !/[:-](\d+{4})$/.match?(t["citeas"])
             @log.add("Style", t,
-                     "undated reference #{t['citeas']} should not contain "\
+                     "Undated reference #{t['citeas']} should not contain "\
                      "specific elements")
           end
         end
@@ -110,9 +124,30 @@ module Metanorma
         end
       end
 
+      def list_validate(doc)
+        listcount_validate(doc)
+        listdepth_validate(doc)
+      end
+
+      # Template provision of styles
+      def listdepth_validate(doc)
+        doc.xpath("//ul[.//ul//ul]").each do |u|
+          next unless u.ancestors("ul").empty?
+
+          @log.add("Style", u,
+                   "Use ordered lists for lists more than two levels deep.")
+        end
+        doc.xpath("//ol[.//ol//ol//ol//ol//ol]").each do |u|
+          next unless u.ancestors("ol").empty?
+
+          @log.add("Style", u,
+                   "Ordered lists should not be more than five levels deep.")
+        end
+      end
+
       # Style manual 13.3
       def listcount_validate(doc)
-        doc.xpath("//clause | //annex").each do |c|
+        doc.xpath("//sections//clause | //annex").each do |c|
           next if c.xpath(".//ol").empty?
 
           ols = c.xpath(".//ol") -
@@ -127,6 +162,7 @@ module Metanorma
       def figure_validate(xmldoc)
         xrefs = xrefs(xmldoc)
         figure_name_validate(xmldoc, xrefs)
+        figure_name_style_validate(xmldoc)
         table_figure_name_validate(xmldoc, xrefs)
         table_figure_quantity_validate(xmldoc)
       end
@@ -159,10 +195,18 @@ module Metanorma
             num = xrefs.anchor(f["id"], :label)
             File.basename(i["src"], ".*") == "#{pref}_fig#{num}" or
               @log.add("Style", i,
-                       "image name #{i['src']} is expected to be #{pref}_fig#{num}")
+                       "Image name #{i['src']} is expected to be #{pref}_fig#{num}")
           end
       end
 
+      # Style manual 17.2
+      def figure_name_style_validate(docxml)
+        docxml.xpath("//figure/name").each do |td|
+          style_regex(/^(?<num>\p{Lower}\s*)/, "figure heading should be capitalised",
+                      td, td.text)
+        end
+      end
+
       def table_figure_name_validate(xmldoc, xrefs)
         xmldoc.xpath("//table[.//figure]").each do |t|
           xmldoc.xpath(".//figure").each do |f|
@@ -172,7 +216,7 @@ module Metanorma
             num = tablefigurenumber(t, f, xrefs)
             File.basename(i["src"]) == num or
               @log.add("Style", i,
-                       "image name #{i['src']} is expected to be #{num}")
+                       "Image name #{i['src']} is expected to be #{num}")
           end
         end
       end

data/lib/metanorma/ieee/validate_section.rb

@@ -58,6 +58,7 @@ module Metanorma
         names, n = sections_sequence_validate_start(root)
         names, n = sections_sequence_validate_body(names, n)
         sections_sequence_validate_end(names, n)
+        bibliography_validate(root)
       end
 
       def sections_sequence_validate_start(root)
@@ -86,13 +87,6 @@ module Metanorma
         elem&.at("./self::references[@normative = 'true']") ||
           @log.add("Style", nil, "Document must include (references) "\
                                  "Normative References")
-        elem = names&.shift
-        elem&.at("./self::references[@normative = 'false']") ||
-          @log.add("Style", elem,
-                   "Final section must be (references) Bibliography")
-        names.empty? ||
-          @log.add("Style", elem,
-                   "There are sections after the final Bibliography")
       end
 
       # Style manual 13.1
@@ -114,6 +108,19 @@ module Metanorma
           @log.add("Style", nil, "#{location}: subclause is only child")
         end
       end
+
+      # Style manual 19.1
+      def bibliography_validate(root)
+        bib = root.at("//references[@normative = 'false']") or return
+        if annex = bib.at(".//ancestor::annex")
+          prec = annex.xpath("./preceding-sibling::annex")
+          foll = annex.xpath("./following-sibling::annex")
+          valid = prec.empty? || foll.empty?
+        else valid = false
+        end
+        valid or @log.add("Style", bib, "Bibliography must be either the first "\
+                                        "or the last document annex")
+      end
     end
   end
 end

data/lib/metanorma/ieee/validate_style.rb

@@ -68,13 +68,17 @@ module Metanorma
                     "unit is needed on both value and tolerance", node, text)
       end
 
-      # Style manual 16.3.2
+      # Style manual 16.2, 16.3.2
       def table_style(docxml)
         docxml.xpath("//td").each do |td|
           style_regex(/^(?<num>[\u2212-]?[0-9]{5,}[.0-9]*|-?[0-9]+\.[0-9]{5,})$/,
                       "number in table not broken up in threes", td, td.text)
         end
         docxml.xpath("//table").each { |t| table_style_columns(t) }
+        docxml.xpath("//table/name | //th").each do |td|
+          style_regex(/^(?<num>\p{Lower}\S*)/, "table heading should be capitalised",
+                      td, td.text)
+        end
       end
 
       # deliberately doing naive, ignoring rowspan

data/lib/metanorma/ieee/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module IEEE
-    VERSION = "0.0.1".freeze
+    VERSION = "0.0.2".freeze
   end
 end

data/lib/relaton/render/config.yml

@@ -0,0 +1,44 @@
+nametemplate:
+  one: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} ,_{{initials[0] | join: '. '}}.{% endif %}"
+  two: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} ,_{{initials[0] | join: '. '}}.{% endif %} , {{ labels['and'] }} {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{initials[1] | join: '. '}}. {{surname[1] }}{% endif %}"
+  more: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} ,_{{initials[0] | join: '. '}}.{% endif %} , {% if nonpersonal[1] %}{{ nonpersonal[1] }}{% else %}{{initials[1] | join: '. '}}. {{surname[1] }}{% endif %} , {{ labels['and'] }} {% if nonpersonal[2] %}{{ nonpersonal[2] }}{% else %}{{initials[2] | join: '. '}}. {{surname[2] }}{% endif %}"
+extenttemplate:
+  misc: "{{ volume }}, {{issue}}, {{ page }}, {{ duration }}"
+template:
+  # skip standardidentifier, it is inserted in front of formattedref within metanorma
+  standard: "{{ title }}."
+  techreport: standard
+  article: "{{creatornames}}, “{{title}},” <em>{{ series }}</em>, {{ extent }}, {{ date }}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
+  book: "{{creatornames}}, <em>{{title}}</em>, {{ edition }}, {{place}}: {{publisher}}, {{date}}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
+  booklet: book
+  manual: book
+  proceedings: book
+  inproceedings: "{{ creatornames }}, “{{ title }},” <em>{{host_title}}</em>, {{place}}, {{extent}}, {{date}}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
+  inbook: "{{ creatornames }}, “{{ title }},” {{ labels['in'] }} {{ host_creatornames}} ({{ host_role}}) : <em>{{host_title}}</em>, {{place}}: {{publisher}}, {{date}}, {{extent}}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
+  incollection: inbook
+  thesis: "{{ creatornames }} , “{{ title }}.” {{ medium | capitalize }}, {{ publisher }}, {{ date }}, {{ labels['viewed'] }}_{{date_accessed}}, {{ uri }} ."
+  unpublished: thesis
+  misc: thesis
+  website: thesis
+  webresource: thesis
+  software: thesis
+  dataset: thesis
+  map: thesis
+  audiovisual: thesis
+  film: thesis
+  video: thesis
+  broadcast: thesis
+  graphic_work: thesis
+  music: thesis
+  performance: thesis
+  patent: thesis
+  archival: thesis
+  social_media: thesis
+  alert: thesis
+  message: thesis
+  conversation: thesis
+  internal: thesis
+
+
+
+

data/lib/relaton/render/general.rb

@@ -0,0 +1,13 @@
+require "relaton-render"
+
+module Relaton
+  module Render
+    module IEEE
+      class General < ::Relaton::Render::IsoDoc::General
+        def config_loc
+          YAML.load_file(File.join(File.dirname(__FILE__), "config.yml"))
+        end
+      end
+    end
+  end
+end