metanorma-ieee 1.4.2 → 1.4.4

data/lib/isodoc/ieee/presentation_xml_convert.rb

@@ -1,6 +1,7 @@
 require_relative "init"
 require_relative "presentation_bibdata"
 require_relative "presentation_terms"
+require_relative "presentation_concepts"
 require_relative "presentation_ref"
 require "isodoc"
 
@@ -35,7 +36,7 @@ module IsoDoc
       end
 
       def subclause?(target, type, from)
-        (from&.match?(/\./) && type == "clause") ||
+        (from&.include?(".") && type == "clause") ||
           target&.gsub(/<[^<>]+>/, "")&.match?(/^IEV$|^IEC 60050-/)
       end
 
@@ -104,16 +105,7 @@ module IsoDoc
       end
 
       def annex_delim(_elem)
-      "<br/>"
-    end
-
-      # KILL
-      def annex1_default(elem)
-        lbl = @xrefs.anchor(elem["id"], :label)
-        if t = elem.at(ns("./title"))
-          t.children = "<strong>#{to_xml(t.children)}</strong>"
-        end
-        prefix_name(elem, { caption: "<br/>" }, lbl, "title")
+        "<br/>"
       end
 
       def amend1(elem)
@@ -184,6 +176,8 @@ module IsoDoc
         end
       end
 
+      # overrides IsoDoc:: XrefGen::OlTypeProvider: we trigger
+      # @xrefs.list_anchor_names after this is called, with elem["type"] set
       def ol_depth_rotate(node, idx)
         depth = node.ancestors("ol").size + idx
         type = :alphabet
@@ -192,6 +186,15 @@ module IsoDoc
         type
       end
 
+      def ul_label_list(_elem)
+        if @doctype == "whitepaper" ||
+            %w(icap industry-connection-report).include?(@subdoctype)
+          %w(&#x25aa; &#x2014;)
+        else
+          %w(&#x2013;)
+        end
+      end
+
       def middle_title(docxml)
         s = middle_title_insert(docxml) or return
         s.previous = middle_title_body

data/lib/isodoc/ieee/word_convert.rb

@@ -87,7 +87,7 @@ module IsoDoc
         body.div class: "WordSectionMain" do |div3|
           content(div3, docxml, ns(self.class::MAIN_ELEMENTS))
           footnotes docxml, div3
-          comments div3
+          comments docxml, div3
         end
       end
 

data/lib/isodoc/ieee/word_wp_convert.rb

@@ -46,7 +46,7 @@ module IsoDoc
         body.div class: "WordSection4" do |div3|
           backcover div3
           footnotes docxml, div3
-          comments div3
+          comments docxml, div3
         end
       end
 

data/lib/isodoc/ieee/xref.rb

@@ -50,13 +50,14 @@ module IsoDoc
           "#{@klass.norm_ref_xpath} | //sections/terms | " \
           "//sections/definitions | //clause[parent::sections]"
         if @hierarchical_assets
-          hierarchical_asset_names(doc.xpath("//xmlns:preface/child::*"), "Preface")
+          hierarchical_asset_names(doc.xpath("//xmlns:preface/child::*"),
+                                   "Preface")
           doc.xpath(ns(middle_sections)).each do |c|
             hierarchical_asset_names(c, @anchors[c["id"]][:label])
           end
         else
-          sequential_asset_names(doc.xpath(ns("//preface/* | " + middle_sections)))
-          #sequential_asset_names(doc.xpath(ns(middle_sections)))
+          sequential_asset_names(doc.xpath(ns("//preface/* | #{middle_sections}")))
+          # sequential_asset_names(doc.xpath(ns(middle_sections)))
         end
       end
 
@@ -77,20 +78,12 @@ module IsoDoc
           sequence = UUIDTools::UUID.random_create.to_s
           notes = t.xpath(ns("./termnote"))
           notes.noblank.each do |n|
-              @anchors[n["id"]] =
-              { label: termnote_label(n, increment_label(notes, n, c)), type: "termnote",
+            @anchors[n["id"]] =
+              { label: termnote_label(n, increment_label(notes, n, c)),
                 value: c.print, elem: @labels["termnote"],
-                container: t["id"],
+                container: t["id"], type: "termnote",
                 xref: anchor_struct_xref(c.print, n, @labels["note_xref"]) }
-            .merge(sequence: sequence)
-=begin
-              anchor_struct(
-                termnote_label(n, increment_label(notes, n, c)),
-                #labelled_autonum(@labels["termnote"], increment_label(notes, n, c)),
-                #"#{@labels['termnote']} #{increment_label(notes, n, c)}",
-                            n, @labels["note_xref"], "termnote", { container: true })
                 .merge(sequence: sequence)
-=end
           end
         end
       end
@@ -111,7 +104,7 @@ module IsoDoc
         if @doctype == "whitepaper"
           title = Common::case_with_markup(@labels["annex"], "capital",
                                            @script)
-           l10n(labelled_autonum(title, num))
+          l10n(labelled_autonum(title, num))
         else super
         end
       end

data/lib/metanorma/ieee/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/ieee/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/ieee/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/ieee/converter.rb

@@ -20,8 +20,9 @@ module Metanorma
         @hierarchical_assets = node.attr("hierarchical-object-numbering")
       end
 
-      PREFACE_CLAUSE_NAMES = %w(abstract foreword introduction
-                                acknowledgements participants).freeze
+      PREFACE_CLAUSE_NAMES =
+        %w(abstract foreword introduction acknowledgements participants
+           metanorma-extension misc-container).freeze
 
       def sectiontype_streamline(ret)
         case ret

data/lib/metanorma/ieee/front.rb

@@ -126,7 +126,6 @@ module Metanorma
 
       def metadata_subdoctype(node, xml)
         xml.subdoctype (node.attr("docsubtype") || "document")
-        s = node.attr("trial-use") and xml.trial_use s
       end
 
       def org_abbrev
@@ -141,7 +140,7 @@ module Metanorma
 
       def metadata_ext(node, xml)
         super
-        structured_id(node, xml)
+        s = node.attr("trial-use") and xml.trial_use s
         program(node, xml)
       end
 

data/lib/metanorma/ieee/ieee.rng

@@ -1,11 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar ns='https://www.metanorma.org/ns/standoc' xmlns="http://relaxng.org/ns/structure/1.0">
-  <!--
-    VERSION v1.2.1
-    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
-    namespaces, one for isostandard and one for csand additions. And we do not want that.
-  -->
   <include href="relaton-ieee.rng"/>
   <include href="isodoc.rng">
     <define name="sections">
@@ -24,31 +18,5 @@
         </oneOrMore>
       </element>
     </define>
-    <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>