metanorma-ieee 0.0.2 → 0.0.5

data/lib/metanorma/ieee/ieee.rng

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar ns="https://www.metanorma.org/ns/ieee" xmlns="http://relaxng.org/ns/structure/1.0">
+<grammar ns="https://www.metanorma.org/ns/ieee" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
   <!--
     Currently we inherit from a namespaced grammar, isostandard. Until we inherit from isodoc,
     we cannot have a new default namespace: we will end up with a grammar with two different
@@ -14,20 +14,43 @@
         <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>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>
       </element>
     </define>
     <define name="DocumentSubtype">
-      <value>trial-use</value>
+      <choice>
+        <value>amendment</value>
+        <value>corrigendum</value>
+        <value>erratum</value>
+      </choice>
     </define>
     <define name="BibDataExtensionType">
       <optional>
@@ -36,14 +59,82 @@
       <optional>
         <ref name="docsubtype"/>
       </optional>
-      <ref name="editorialgroup"/>
+      <optional>
+        <ref name="trialuse"/>
+      </optional>
+      <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>feedback-ended</value>
+  </define>
+  <define name="trialuse">
+    <element name="trial-use">
+      <data type="boolean"/>
+    </element>
+  </define>
   <define name="balloting-group">
     <element name="balloting-group">
+      <attribute name="type">
+        <choice>
+          <value>individual</value>
+          <value>entity</value>
+        </choice>
+      </attribute>
       <text/>
     </element>
   </define>

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>
@@ -2504,6 +2509,16 @@
           <text/>
         </element>
       </optional>
+      <optional>
+        <element name="amendment">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="corrigendum">
+          <text/>
+        </element>
+      </optional>
       <optional>
         <element name="language">
           <text/>

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/term_lookup_cleanup.rb

@@ -0,0 +1,11 @@
+module Metanorma
+  module IEEE
+    class TermLookupCleanup < Metanorma::Standoc::TermLookupCleanup
+      def remove_missing_ref_term(node, _target)
+        node.at("../xrefrender")&.remove
+        node.replace("<preferred><expression><name>#{node.children.to_xml}"\
+                     "</name></expression></preferred>")
+      end
+    end
+  end
+end

data/lib/metanorma/ieee/validate.rb

@@ -19,71 +19,31 @@ module Metanorma
         list_validate(doc)
         table_style(doc)
         figure_validate(doc)
+        amend_validate(doc)
       end
 
       def bibdata_validate(doc)
         doctype_validate(doc)
-        # stage_validate(doc)
-        # substage_validate(doc)
+        stage_validate(doc)
       end
 
       def doctype_validate(xmldoc)
         doctype = xmldoc&.at("//bibdata/ext/doctype")&.text
-        %w(standard recommended-practice guide
-           amendment technical-corrigendum).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
+        %w(amendment corrigendum erratum document).include? docsubtype or
+          @log.add("Document Attributes", nil,
+                   "#{docsubtype} is not a recognised document subtype")
       end
 
-      def title_validate(xml)
-        title_validate_type(xml)
-        title_validate_capitalisation(xml)
-      end
-
-      # Style Manual 11.3
-      def title_validate_type(xml)
-        title = xml.at("//bibdata/title") or return
-        draft = xml.at("//bibdata//draft")
-        type = xml.at("//bibdata/ext/doctype")
-        subtype = xml.at("//bibdata/ext/subdoctype")
-        target = draft ? "Draft " : ""
-        target += subtype ? "#{strict_capitalize_phrase(subtype.text)} " : ""
-        target += type ? "#{strict_capitalize_phrase(type.text)} " : ""
-        /^#{target}/.match?(title.text) or
-          @log.add("Style", title,
-                   "Expected title to start as: #{target}")
-      end
-
-      def strict_capitalize_phrase(str)
-        ret = str.split(/[ -]/).map do |w|
-          letters = w.chars
-          letters.first.upcase! unless /^[ -]/.match?(w)
-          letters.join
-        end.join(" ")
-        ret = "Trial-Use" if ret == "Trial Use"
-        ret
-      end
-
-      # Style Manual 11.3
-      def title_validate_capitalisation(xml)
-        title = xml.at("//bibdata/title") or return
-        found = false
-        title.text.split(/[ -]/).each do |w|
-          /^[[:upper:]]/.match?(w) or preposition?(w) or
-            found = true
-        end
-        found and @log.add("Style", title,
-                           "Title contains uncapitalised word other than preposition")
-      end
-
-      def preposition?(word)
-        %w(aboard about above across after against along amid among anti around
-           as at before behind below beneath beside besides between beyond but
-           by concerning considering despite down during except excepting
-           excluding following for from in inside into like minus near of off
-           on onto opposite outside over past per plus regarding round save
-           since than through to toward towards under underneath unlike until
-           up upon versus via with within without a an the).include?(word)
+      def stage_validate(xmldoc)
+        stage = xmldoc&.at("//bibdata/status/stage")&.text
+        %w(draft approved superseded withdrawn).include? stage or
+          @log.add("Document Attributes", nil,
+                   "#{stage} is not a recognised stage")
       end
 
       def locality_validate(root)
@@ -237,6 +197,51 @@ module Metanorma
                      "More than one image in the table cell")
         end
       end
+
+      # Style manual 20.2.2
+      def amend_validate(xmldoc)
+        xmldoc.xpath("//amend").each do |a|
+          desc = a.at("./description")
+          if desc && !desc.text.strip.empty?
+            amend_validate1(a, desc.text.strip,
+                            a.at("./newcontent//figure | "\
+                                 "./newcontent//formula"))
+          else @log.add("Style", a,
+                        "Editorial instruction is missing from change")
+          end
+        end
+      end
+
+      def amend_validate1(amend, description, figure_or_formula)
+        case amend["change"]
+        when "add" then /^Insert /.match?(description) or
+          @log.add("Style", amend,
+                   "'Add' change description should start with _Insert_")
+        when "delete" then /^Insert /.match?(description) or
+          @log.add("Style", amend,
+                   "'Delete' change description should start with _Delete_")
+        when "modify"
+          amend_validate_modify(amend, description, figure_or_formula)
+        end
+      end
+
+      AMD_VALID_MOD = [
+        "'Modify' change description should start with _Change_ or _Replace_",
+        "'Modify' change description for change involving figure or equation "\
+        "should start with _Replace_",
+        "'Modify' change description for change not involving figure or "\
+        "equation should start with _Change_",
+      ].freeze
+
+      def amend_validate_modify(amend, description, figure_or_formula)
+        if !/^Change |^Replace/.match?(description)
+          @log.add("Style", amend, AMD_VALID_MOD[0])
+        elsif /^Change /.match?(description)
+          !figure_or_formula or @log.add("Style", amend, AMD_VALID_MOD[1])
+        else
+          figure_or_formula or @log.add("Style", amend, AMD_VALID_MOD[2])
+        end
+      end
     end
   end
 end

data/lib/metanorma/ieee/validate_style.rb

@@ -106,6 +106,59 @@ module Metanorma
           end
         end
         ret.map { |x| x.is_a?(Array) ? x : [] }
+      end
+
+            def title_validate(xml)
+        title_validate_type(xml)
+        title_validate_capitalisation(xml)
+      end
+
+      # Style Manual 11.3
+      def title_validate_type(xml)
+        title = xml.at("//bibdata/title") or return
+        draft = xml.at("//bibdata//draft")
+        type = xml.at("//bibdata/ext/doctype")
+        subtype = xml.at("//bibdata/ext/subdoctype")
+        subtype = "" if subtype == "document"
+        trial = xml.at("//bibdata/ext/trial-use[text() = 'true']")
+        target = draft ? "Draft " : ""
+        target += trial ? "Trial-Use " : ""
+        target += type ? "#{strict_capitalize_phrase(type.text)} " : ""
+        /^#{target}/.match?(title.text) or
+          @log.add("Style", title,
+                   "Expected title to start as: #{target}")
+      end
+
+      def strict_capitalize_phrase(str)
+        ret = str.split(/[ -]/).map do |w|
+          letters = w.chars
+          letters.first.upcase! unless /^[ -]/.match?(w)
+          letters.join
+        end.join(" ")
+        ret = "Trial-Use" if ret == "Trial Use"
+        ret
+      end
+
+      # Style Manual 11.3
+      def title_validate_capitalisation(xml)
+        title = xml.at("//bibdata/title") or return
+        found = false
+        title.text.split(/[ -]/).each do |w|
+          /^[[:upper:]]/.match?(w) or preposition?(w) or
+            found = true
+        end
+        found and @log.add("Style", title,
+                           "Title contains uncapitalised word other than preposition")
+      end
+
+      def preposition?(word)
+        %w(aboard about above across after against along amid among anti around
+           as at before behind below beneath beside besides between beyond but
+           by concerning considering despite down during except excepting
+           excluding following for from in inside into like minus near of off
+           on onto opposite outside over past per plus regarding round save
+           since than through to toward towards under underneath unlike until
+           up upon versus via with within without a an the).include?(word)
       end
     end
   end

data/lib/metanorma/ieee/version.rb

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

data/lib/relaton/render/config.yml

@@ -1,5 +1,5 @@
 nametemplate:
-  one: "{% if nonpersonal[0] %}{{ nonpersonal[0] }}{% else %}{{surname[0] }} ,_{{initials[0] | join: '. '}}.{% endif %}"
+  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:

data/metanorma-itu.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 2.1.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.2.0"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ieee
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2022-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -217,6 +217,7 @@ files:
 - lib/isodoc/ieee.rb
 - lib/isodoc/ieee/base_convert.rb
 - lib/isodoc/ieee/html/header.html
+- lib/isodoc/ieee/html/header_amd.html
 - lib/isodoc/ieee/html/html_ieee_intro.html
 - lib/isodoc/ieee/html/html_ieee_titlepage.html
 - lib/isodoc/ieee/html/htmlstyle.css
@@ -237,6 +238,7 @@ files:
 - lib/isodoc/ieee/init.rb
 - lib/isodoc/ieee/metadata.rb
 - lib/isodoc/ieee/pdf_convert.rb
+- lib/isodoc/ieee/presentation_ref.rb
 - lib/isodoc/ieee/presentation_terms.rb
 - lib/isodoc/ieee/presentation_xml_convert.rb
 - lib/isodoc/ieee/word_authority.rb
@@ -257,6 +259,7 @@ files:
 - lib/metanorma/ieee/isodoc.rng
 - lib/metanorma/ieee/processor.rb
 - lib/metanorma/ieee/reqt.rng
+- lib/metanorma/ieee/term_lookup_cleanup.rb
 - lib/metanorma/ieee/validate.rb
 - lib/metanorma/ieee/validate_section.rb
 - lib/metanorma/ieee/validate_style.rb