metanorma-iec 2.6.2 → 2.6.4

data/lib/isodoc/iec/presentation_terms.rb

@@ -4,11 +4,11 @@ module IsoDoc
       def termclause1(elem)
         @is_iev or return clause1(elem)
         @suppressheadingnumbers || elem["unnumbered"] or
-        lbl = @xrefs.anchor(elem["id"], :label, true)
+          lbl = @xrefs.anchor(elem["id"], :label, true)
         if lbl
-        prefix_name(elem, { caption: " " }, "#{lbl}#{clausedelim}", "title")
+          prefix_name(elem, { caption: " " }, "#{lbl}#{clausedelim}", "title")
         else
-        prefix_name(elem, {}, nil, "title")
+          prefix_name(elem, {}, nil, "title")
         end
       end
 
@@ -46,8 +46,8 @@ module IsoDoc
 
       def termdomain(elem, fmt_defn)
         if @is_iev
-          #d = elem.at(ns("./domain")) or return
-          #d["hidden"] = true
+          # d = elem.at(ns("./domain")) or return
+          # d["hidden"] = true
         else super
         end
       end
@@ -60,19 +60,21 @@ module IsoDoc
         end
         # renumber
         @xrefs.parse_inclusions(clauses: true).parse docxml
-        docxml.xpath(ns("//term/fmt-name | //term/fmt-xref-label")).each(&:remove)
+        docxml.xpath(ns("//term/fmt-name | //term/fmt-xref-label"))
+          .each(&:remove)
         term(docxml)
       end
 
       def merge_fr_into_en_term1(en_term, fr_term)
         dl = en_term&.at(ns("./dl[@type = 'other-lang']"))&.remove
-        #en_term << fr_term.remove.children
+        # en_term << fr_term.remove.children
         dup = semx_fmt_dup(fr_term)
         dup.xpath(ns("./fmt-name | ./fmt-xref-label")).each(&:remove)
         en_term << dup
         fr_term.xpath(ns(".//fmt-name | .//fmt-xref-label | " \
           ".//fmt-preferred | .//fmt-admitted | .//fmt-deprecates | " \
-          ".//fmt-definition | .//fmt-related | .//fmt-termsource")).each(&:remove)
+          ".//fmt-definition | .//fmt-related | .//fmt-termsource"))
+          .each(&:remove)
         fr_term["unnumbered"] = "true"
         en_term << dl if dl
         en_term["language"] = "en,fr"
@@ -89,28 +91,15 @@ module IsoDoc
       def remove_otherlang_designations(docxml)
         @is_iev or return
         docxml.xpath(ns("//term")).each do |t|
-          remove_otherlang_designations1(t, t["language"]&.split(",") || %w(en fr))
+          remove_otherlang_designations1(t,
+                                         t["language"]&.split(",") || %w(en fr))
         end
       end
 
-      # KILL
       def extract_otherlang_designations(term, lgs)
         term.xpath(ns(".//preferred/expression[@language]"))
           .each_with_object([]) do |d, m|
           lg = d["language"]
-          d.delete("language")
-          lgs.include?(lg) and next
-          p = d.parent
-          designation_annotate(p, p.at(ns("./name")))
-          m << { lang: lg, script: Metanorma::Utils.default_script(lg),
-                 designation: to_xml(l10n_recursive(p.remove, lg)).strip }
-        end
-      end
-
-      def extract_otherlang_designations(term, lgs)
-        term.xpath(ns(".//preferred/expression[@language]"))
-          .each_with_object([]) do |d, m|
-            lg = d["language"]
           lgs.include?(lg) and next
           p = semx_fmt_dup(d.parent)
           e = p.at(ns("./expression"))
@@ -156,52 +145,32 @@ module IsoDoc
       end
 
       def remove_otherlang_designations1(term, lgs)
-        term.xpath(ns(".//fmt-preferred/p/semx[@element = 'preferred']")).each do |s|
+        term.xpath(ns(".//fmt-preferred/p/semx[@element = 'preferred']"))
+          .each do |s|
           p = semx_orig(s, term)
           lg = p.at(ns("./expression/@language"))&.text or next
           lgs.include?(lg) and next
           s.parent.remove
-      end
+        end
       end
 
       def related(docxml)
-        #docxml.xpath(ns("//term[related]")).each { |f| move_related(f) }
         super
         docxml.xpath(ns("//term[related]")).each { |f| move_related(f) }
       end
 
-      # KILL
-            def move_related(term)
-        defn = term.at(ns("./definition")) or return
-        term.xpath(ns("./related")).reverse_each do |r|
-          defn.next = r.remove
-        end
-      end
-
       def move_related(term)
         defn = term.at(ns("./fmt-definition")) or return
         rel = term.at(ns("./fmt-related")) or return
         defn << rel.children
       end
 
-      # KILL
       def related1(node)
         lg = node.at("./ancestor::xmlns:term/@language")&.text
         @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
-        p = node.at(ns("./preferred"))
-        ref = node.at(ns("./xref | ./eref | ./termref"))
-        label = @i18n.relatedterms[node["type"]].upcase
-        node.replace(l10n("<p>#{label}: " \
-                          "#{to_xml(p.children)} (#{to_xml(ref)})</p>"))
-        @i18n = @i18n_lg["default"]
-      end
-
-            def related1(node)
-        lg = node.at("./ancestor::xmlns:term/@language")&.text
-        @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
         p, ref, orig = related1_prep(node)
-      label = @i18n.relatedterms[orig["type"]].upcase
-        node.children =(l10n("<p>#{label}: " \
+        label = @i18n.relatedterms[orig["type"]].upcase
+        node.children = (l10n("<p>#{label}: " \
                           "#{to_xml(p)} (#{Common::to_xml(ref)})</p>"))
         @i18n = @i18n_lg["default"]
       end
@@ -213,31 +182,13 @@ module IsoDoc
         @i18n = @i18n_lg["default"]
       end
 
-      # KILL
-      def termsource1xx(node)
-        lg = node&.at("./ancestor::xmlns:term/@language")&.text
-        @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
-        if @is_iev then termsource1_iev(node)
-        else super
-        end
-        @i18n = @i18n_lg["default"]
-      end
-
-      # KILL
-      def termsource1_iev(elem)
-        while elem&.next_element&.name == "termsource"
-          elem << "; #{to_xml(elem.next_element.remove.children)}"
-        end
-        elem.children = l10n("#{@i18n.source}: #{to_xml(elem.children).strip}")
-      end
-
       def termsource_label(elem, sources)
         @is_iev or return super
         lg = elem&.at("./ancestor::xmlns:term/@language")&.text
         @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
-      elem.replace(l10n("#{@i18n.source}: #{sources}"))
-      @i18n = @i18n_lg["default"]
-    end
+        elem.replace(l10n("#{@i18n.source}: #{sources}"))
+        @i18n = @i18n_lg["default"]
+      end
 
       def termexample(docxml)
         docxml.xpath(ns("//termexample")).each do |f|
@@ -247,7 +198,6 @@ module IsoDoc
 
       def termexample1(elem)
         lg = elem&.at("./ancestor::xmlns:term/@language")&.text
-        #require "debug"; binding.b
         @i18n = @i18n_lg[lg] if lg && @i18n_lg[lg]
         example1(elem)
         @i18n = @i18n_lg["default"]
@@ -263,11 +213,6 @@ module IsoDoc
         @i18n = @i18n_lg["default"]
         ret
       end
-
-      def term1(elem)
-        #require 'debug'; binding.b
-        super
-      end
     end
   end
 end

data/lib/isodoc/iec/presentation_xml_convert.rb

@@ -71,7 +71,7 @@ module IsoDoc
         ins = elem.at(ns("./title")) || elem.children.first.before(" ").previous
         ins.next = <<~CLAUSE
           <clause type='boilerplate_legal'>#{to_xml(boilerplate.children)}</clause>
-          CLAUSE
+        CLAUSE
       end
 
       def insert_middle_title(docxml)
@@ -124,6 +124,10 @@ module IsoDoc
         s.add_first_child ret
       end
 
+      def ul_label_list(_elem)
+        %w(&#x2022; &#x2014; &#x6f;)
+      end
+
       include Init
     end
   end

data/lib/isodoc/iec/word_convert.rb

@@ -104,9 +104,8 @@ module IsoDoc
       end
 
       def tr_parse(node, out, ord, totalrows, header)
-        c = node.parent.parent["class"]
-        bordered = %w(modspec).include?(c) || !c
-        out.tr do |r|
+        bordered = table_bordered?(node)
+        out.tr **attr_code(style: node["style"]) do |r|
           node.elements.each do |td|
             attrs = make_tr_attr(td, ord, totalrows - 1, header, bordered)
             attrs[:class] = "TABLE-col-heading" if header

data/lib/metanorma/iec/basicdoc.rng

@@ -382,33 +382,7 @@ in a document (e.g. sourcecode annotations)</a:documentation>
     <a:documentation>Block intended to capture reviewer comments about some text in the document</a:documentation>
     <element name="review">
       <ref name="RequiredId"/>
-      <attribute name="reviewer">
-        <a:documentation>The party who has offered the comment</a:documentation>
-      </attribute>
-      <optional>
-        <attribute name="type">
-          <a:documentation>The type of reviewer comment</a:documentation>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="date">
-          <a:documentation>The date when the comment was made</a:documentation>
-          <data type="dateTime"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="from">
-          <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
-If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
-          <data type="IDREF"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="to">
-          <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
-          <data type="IDREF"/>
-        </attribute>
-      </optional>
+      <ref name="ReviewAttributes"/>
       <oneOrMore>
         <ref name="paragraph">
           <a:documentation>Reviewer comments content</a:documentation>
@@ -416,6 +390,35 @@ If not provided, the comment applies in the vicinity of the place it has been in
       </oneOrMore>
     </element>
   </define>
+  <define name="ReviewAttributes">
+    <attribute name="reviewer">
+      <a:documentation>The party who has offered the comment</a:documentation>
+    </attribute>
+    <optional>
+      <attribute name="type">
+        <a:documentation>The type of reviewer comment</a:documentation>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="date">
+        <a:documentation>The date when the comment was made</a:documentation>
+        <data type="dateTime"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="from">
+        <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
+If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
+        <data type="IDREF"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="to">
+        <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
+        <data type="IDREF"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="NumberingAttributes">
     <optional>
       <attribute name="unnumbered">
@@ -857,6 +860,7 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
   <define name="tr">
     <a:documentation>Sequence of cells to be displayed as a row in a table</a:documentation>
     <element name="tr">
+      <ref name="TrAttributes"/>
       <oneOrMore>
         <choice>
           <ref name="td">
@@ -869,6 +873,9 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="TrAttributes">
+    <empty/>
+  </define>
   <define name="tr-no-id">
     <a:documentation>Sequence of cells to be displayed as a row in a table: optional ID attributes recursively (for use in Relaton, metadata)</a:documentation>
     <element name="tr">
@@ -1694,16 +1701,22 @@ which can be bookmarks as well as block or section references</a:documentation>
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as a footnote.
 The target of a footnote is the location it is embedded in within the text</a:documentation>
     <element name="fn">
-      <attribute name="reference">
-        <a:documentation>The number of the footnote, used to identify it visually</a:documentation>
-      </attribute>
-      <oneOrMore>
-        <ref name="paragraph">
-          <a:documentation>The content of the footnote</a:documentation>
-        </ref>
-      </oneOrMore>
+      <ref name="FnAttributes"/>
+      <ref name="FnBody"/>
     </element>
   </define>
+  <define name="FnBody">
+    <oneOrMore>
+      <ref name="paragraph">
+        <a:documentation>The content of the footnote</a:documentation>
+      </ref>
+    </oneOrMore>
+  </define>
+  <define name="FnAttributes">
+    <attribute name="reference">
+      <a:documentation>The number of the footnote, used to identify it visually</a:documentation>
+    </attribute>
+  </define>
   <define name="callout">
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as annotation of source code</a:documentation>
     <element name="callout">

data/lib/metanorma/iec/biblio-standoc.rng

@@ -1,13 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0">
-  <!--
-    Add-ons to biblio.rnc for standoc model: defines the extension point BibDataExtensionType
-    of relaton
-    
-    Specialisations as for biblio.rnc. Extension point can be redefined completely for a flavour of standoc
-    (SDO); but other elements in Bibdata can only be extended (more specialised vocabularies for Bibdata)
-  -->
   <include href="biblio.rng">
+    <!-- ALERT: we cannot have comments on root element, as they intervene with https://github.com/metanorma/metanorma/issues/437 fix -->
+    <!--
+      Add-ons to biblio.rnc for standoc model: defines the extension point BibDataExtensionType
+      of relaton
+      
+      Specialisations as for biblio.rnc. Extension point can be redefined completely for a flavour of standoc
+      (SDO); but other elements in Bibdata can only be extended (more specialised vocabularies for Bibdata)
+    -->
     <define name="BibData">
       <a:documentation>The bibliographic description of a standardisation document</a:documentation>
       <ref name="StandardBibliographicItem"/>
@@ -91,6 +92,9 @@ a standards definition organization</a:documentation>
         <a:documentation>Representation of the identifier for the standardisation document, giving its individual semantic components</a:documentation>
       </ref>
     </zeroOrMore>
+    <ref name="DocumentImages">
+      <a:documentation>Coverpage and other images to be rendered with document</a:documentation>
+    </ref>
   </define>
   <define name="doctype">
     <a:documentation>Classification of the standardisation document</a:documentation>
@@ -268,6 +272,32 @@ and not those document components</a:documentation>
       </optional>
     </element>
   </define>
+  <define name="DocumentImages">
+    <zeroOrMore>
+      <element name="coverpage-image">
+        <a:documentation>Images to be displayed on the coverpage of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <element name="innercoverpage-image">
+        <a:documentation>Images to be displayed on the inner coverpage of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <element name="tocside-image">
+        <a:documentation>Images to be displayed on the Table of Contents page of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <element name="backpage-image">
+        <a:documentation>Images to be displayed on the backpage of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+  </define>
   <define name="StandardBibliographicItem">
     <ref name="BibliographicItem"/>
     <zeroOrMore>

data/lib/metanorma/iec/biblio.rng

@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-  instantiations of this grammar may replace leaf strings
-  with more elaborated types; e.g. title (text) replaced with
-  title-main, title-intro, title-part; type replaced with
-  enum.
-  
-  some renaming at leaf nodes is permissible
-  
-  obligations can change both from optional to mandatory,
-  and from mandatory to optional; optional elements may
-  be omitted; freely positioned alternatives may be replaced
-  with strict ordering
-  
-  DO NOT introduce a namespace here. We do not want a distinct namespace
-  for these elements, and a distinct namespace for any grammar inheriting
-  these elements; we just want one namespace for any child grammars
-  of this.
--->
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!--
+    ALERT: we cannot have comments on root element, as they intervene with https://github.com/metanorma/metanorma/issues/437 fix
+    
+    Instantiations of this grammar may replace leaf strings
+    with more elaborated types; e.g. title (text) replaced with
+    title-main, title-intro, title-part; type replaced with
+    enum.
+    
+    Some renaming at leaf nodes is permissible
+    
+    Obligations can change both from optional to mandatory,
+    and from mandatory to optional; optional elements may
+    be omitted; freely positioned alternatives may be replaced
+    with strict ordering
+    
+    DO NOT introduce a namespace here. We do not want a distinct namespace
+    for these elements, and a distinct namespace for any grammar inheriting
+    these elements; we just want one namespace for any child grammars
+    of this.
+  -->
   <!--
     https://www.myintervals.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/
     iso8601date = xsd:string { pattern = "([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?" }
@@ -1241,6 +1243,11 @@ Refer to `BibliographicItem` for definitions</a:documentation>
   </define>
   <define name="formattedref">
     <element name="formattedref">
+      <optional>
+        <attribute name="format">
+          <a:documentation>format of formatted reference; Metanorma assumes references are formatted as Metanorma XML</a:documentation>
+        </attribute>
+      </optional>
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>
@@ -1812,6 +1819,11 @@ May be used to differentiate rendering of notes in bibliographies</a:documentati
     <a:documentation>Abstract of bibliographic item</a:documentation>
     <element name="abstract">
       <ref name="LocalizedStringAttributes"/>
+      <optional>
+        <attribute name="format">
+          <a:documentation>What format the formatted abstract is in. In Metanorma, assumed to be Metanorma XML</a:documentation>
+        </attribute>
+      </optional>
       <choice>
         <oneOrMore>
           <ref name="BasicBlockNoId">

data/lib/metanorma/iec/converter.rb

@@ -45,10 +45,8 @@ module Metanorma
         end
       end
 
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "iec.rng"))
+      def schema_file
+        "iec.rng"
       end
 
       def html_converter(node)
@@ -157,7 +155,6 @@ module Metanorma
       end
 
       # TODO remove when I adopt pubid-iec
-      #
       def get_id_prefix(xmldoc)
         xmldoc.xpath("//bibdata/contributor[role/@type = 'publisher']" \
                      "/organization").each_with_object([]) do |x, prefix|

data/lib/metanorma/iec/front.rb

@@ -157,13 +157,9 @@ module Metanorma
         @log.add("Document Attributes", nil, err)
       end
 
-      def metadata_subdoctype(node, xml)
-        super
-        a = node.attr("function") and xml.function a
-      end
-
       def metadata_ext(node, xml)
         super
+        a = node.attr("function") and xml.function a
         a = node.attr("accessibility-color-inside") and
           xml.accessibility_color_inside a
         a = node.attr("cen-processing") and xml.cen_processing a

data/lib/metanorma/iec/iec.rng

@@ -1,25 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar ns='https://www.metanorma.org/ns/standoc' xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-  <!--
-    VERSION v1.2.1
-    default namespace = "https://www.metanorma.com/ns/iec"
-  -->
+<grammar ns='https://www.metanorma.org/ns/standoc' xmlns="http://relaxng.org/ns/structure/1.0">
   <include href="relaton-iec.rng"/>
   <include href="isostandard.rng">
     <define name="term">
       <element name="term">
-        <optional>
-          <attribute name="id">
-            <data type="ID"/>
-          </attribute>
-        </optional>
-        <optional>
-          <attribute name="language"/>
-        </optional>
-        <optional>
-          <attribute name="script"/>
-        </optional>
-        <ref name="BlockAttributes"/>
+        <ref name="TermAttributes"/>
         <oneOrMore>
           <ref name="preferred"/>
         </oneOrMore>
@@ -47,36 +32,6 @@
         </zeroOrMore>
       </element>
     </define>
-    <!--
-      We display the Normative References between scope and terms; but to keep the
-      grammar simple, we keep the references together
-    -->
-    <define name="standard-document">
-      <element name="metanorma">
-        <ref name="Root-Attributes"/>
-        <ref name="bibdata"/>
-        <zeroOrMore>
-          <ref name="termdocsource"/>
-        </zeroOrMore>
-        <optional>
-          <ref name="misccontainer"/>
-        </optional>
-        <optional>
-          <ref name="boilerplate"/>
-        </optional>
-        <ref name="preface"/>
-        <oneOrMore>
-          <ref name="sections"/>
-        </oneOrMore>
-        <zeroOrMore>
-          <ref name="annex"/>
-        </zeroOrMore>
-        <ref name="bibliography"/>
-        <zeroOrMore>
-          <ref name="indexsect"/>
-        </zeroOrMore>
-      </element>
-    </define>
   </include>
 </grammar>
 <!-- end overrides -->