metanorma-ieee 1.4.3 → 1.4.5

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/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

@@ -1701,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/cleanup_ref.rb

@@ -31,23 +31,25 @@ module Metanorma
 
       # Alphabetic by rendering: author surname or designation, followed by title
       def sort_biblio_key(bib)
-        name = designator_or_name(bib)
+        name, docid = designator_or_name(bib)
         title = bib.at("./title[@type = 'main']")&.text ||
           bib.at("./title")&.text || bib.at("./formattedref")&.text
         title.gsub!(/[[:punct:]]/, "")
-        @c.decode("#{name} #{title}").strip.downcase
+        @c.decode("#{name} #{title} #{docid}").strip.downcase
       end
 
       def designator_or_name(bib)
-        case bib["type"]
-        when "standard", "techreport" then designator_docid(bib)
-        else
-          bib1 = bib.dup
-          bib1.add_namespace(nil, self.class::XML_NAMESPACE)
-          n = @i.creatornames(bib1)
-          n.nil? && bib["type"].nil? and n = designator_docid(bib)
-          n
-        end
+        id = designator_docid(bib)
+        ret = case bib["type"]
+              when "standard", "techreport" then id
+              else
+                bib1 = bib.dup
+                bib1.add_namespace(nil, self.class::XML_NAMESPACE)
+                n = @i.creatornames(bib1)
+                n.nil? && bib["type"].nil? and n = id
+                n
+              end
+        [ret, id]
       end
 
       def designator_docid(bib)
@@ -66,7 +68,7 @@ module Metanorma
       def normref_no_ordinals(xmldoc)
         xmldoc.xpath("//references[@normative = 'true']/bibitem/" \
                     "docidentifier[@type = 'metanorma']").each do |d|
-                      /^\[?\d+\]?$/.match?(d.text) and d.remove
+          /^\[?\d+\]?$/.match?(d.text) and d.remove
         end
       end
 
@@ -221,7 +223,7 @@ module Metanorma
         ret = xmldoc.xpath(BIBITEM_NO_AVAIL).detect do |b|
           has_itu_t = /^ITU-T/.match?(b.at("./docidentifier[@type = 'ITU']")&.text)
           bib_pubs(b).include?("International Telecommunication Union") &&
-            (!has_itu_t && !itu_t) || (has_itu_t && itu_t)
+            !has_itu_t && !itu_t || (has_itu_t && itu_t)
         end
         insert_availability_note(ret, note)
       end

data/lib/metanorma/ieee/converter.rb

@@ -33,7 +33,7 @@ module Metanorma
         end
       end
 
-      def clause_parse(attrs, xml, node)
+      def clause_attrs_preprocess(attrs, node)
         case node.title
         when "Purpose" then attrs[:type] = "purpose"
         when "Overview" then attrs[:type] = "overview"

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>