metanorma-itu 2.6.2 → 2.6.4

data/lib/isodoc/itu/presentation_section.rb

@@ -1,7 +1,7 @@
 module IsoDoc
   module Itu
     class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
-            def clause1(elem)
+      def clause1(elem)
         clause1_super?(elem) and return super
         lbl = @xrefs.anchor(elem["id"], :label, false)
         oldsuppressheadingnumbers = @suppressheadingnumbers
@@ -11,8 +11,9 @@ module IsoDoc
         lbl.blank? || elem["unnumbered"] and return
         elem.previous =
           "<p keep-with-next='true' class='supertitle'>" \
-          "#{labelled_autonum(@i18n.get['section'].upcase, elem["id"], lbl)}</p>"
-          #"<span element='fmt-element-name'>#{@i18n.get['section'].upcase}</span> #{autonum(elem['id'], lbl)}</p>"
+          "#{labelled_autonum(@i18n.get['section'].upcase, elem['id'],
+                              lbl)}</p>"
+        # "<span element='fmt-element-name'>#{@i18n.get['section'].upcase}</span> #{autonum(elem['id'], lbl)}</p>"
       end
 
       def clause1_super?(elem)
@@ -31,7 +32,7 @@ module IsoDoc
 
       def annex1_resolution(elem)
         elem.elements.first.previous = annex1_supertitle(elem)
-         # TODO: do not alter title, alter semx/@element = title
+        # TODO: do not alter title, alter semx/@element = title
         t = elem.at(ns("./title")) and
           t.children = "<strong>#{to_xml(t.children)}</strong>"
         prefix_name(elem, {}, nil, "title")
@@ -49,12 +50,13 @@ module IsoDoc
         lbl = @xrefs.anchor(elem["id"], :label)
         res = elem.at(ns("//bibdata/title[@type = 'resolution']"))
         subhead = @i18n.l10n("(#{@i18n.get['to']} #{to_xml(res.children)})")
-        "<p class='supertitle'>#{autonum(elem['id'], lbl)}<br/>#{subhead}</p>"
+        "<p class='supertitle'>#{autonum(elem['id'],
+                                         lbl)}<br/>#{subhead}</p>"
       end
 
       def middle_title(isoxml)
         s = isoxml.at(ns("//sections")) or return
-        titfn = isoxml.at(ns("//note[@type = 'title-footnote']"))
+        isoxml.at(ns("//note[@type = 'title-footnote']"))
         case @doctype
         when "resolution"
           middle_title_resolution(isoxml, s.children.first)
@@ -62,16 +64,7 @@ module IsoDoc
         else
           middle_title_recommendation(isoxml, s.children.first)
         end
-        #titfn and renumber_footnotes(isoxml)
-      end
-
-      # KILL
-      def renumber_footnotesx(isoxml)
-        (isoxml.xpath(ns("//fn")) -
-         isoxml.xpath(ns("//table//fn | //figure//fn")))
-          .each_with_index do |fn, i|
-            fn["reference"] = (i + 1).to_s
-          end
+        # titfn and renumber_footnotes(isoxml)
       end
 
       def middle_title_resolution(isoxml, out)

data/lib/isodoc/itu/presentation_xml_convert.rb

@@ -134,16 +134,8 @@ module IsoDoc
         { group: "'" }
       end
 
-      def ol_depth(node)
-        node["class"] == "steps" ||
-          node.at(".//ancestor::xmlns:ol[@class = 'steps']") or return super
-        depth = node.ancestors("ul, ol").size + 1
-        type = :arabic
-        type = :alphabet if [2, 7].include? depth
-        type = :roman if [3, 8].include? depth
-        type = :alphabet_upper if [4, 9].include? depth
-        type = :roman_upper if [5, 10].include? depth
-        type
+      def ul_label_list(_elem)
+        %w(– • o)
       end
 
       def dl(xml)

data/lib/isodoc/itu/xref.rb

@@ -2,7 +2,25 @@ require "isodoc"
 require "fileutils"
 require_relative "xref_section"
 
+
 module IsoDoc
+  module XrefGen
+    module OlTypeProvider
+      def ol_type(list, depth)
+        steps = list["class"] == "steps" ||
+          list.at(".//ancestor::xmlns:ol[@class = 'steps']") 
+        !steps && list["type"] and  return list["type"].to_sym if list["type"]
+        type = steps ? :arabic : :alphabet
+        type = (steps ? :alphabet : :arabic) if [2, 7].include? depth
+        type = :roman if [3, 8].include? depth
+        type = :alphabet_upper if [4, 9].include? depth
+        type = :roman_upper if [5, 10].include? depth
+        type
+      end
+    end
+  end
+
+
   module Itu
     class Counter < IsoDoc::XrefGen::Counter
       def print
@@ -82,7 +100,7 @@ module IsoDoc
           @anchors[elem["id"]][:xref] = @anchors[elem.parent["id"]][:xref] +
             delim_wrap("-") + semx(elem, sublabel)
           x = @anchors[elem.parent["id"]][:container] and
-          @anchors[elem["id"]][:container] = x
+            @anchors[elem["id"]][:container] = x
         end
       end
 

data/lib/isodoc/itu/xref_section.rb

@@ -44,9 +44,13 @@ module IsoDoc
       def annex_name_lbl(clause, num)
         lbl = annextype(clause)
         if @doctype == "resolution"
-          l10n("<span class='fmt-element-name'>#{lbl.upcase}</span> #{semx(clause, num)}")
+          l10n("<span class='fmt-element-name'>#{lbl.upcase}</span> #{semx(
+            clause, num
+          )}")
         else
-          l10n("<strong><span class='fmt-caption-label'><span class='fmt-element-name'>#{lbl}</span> #{semx(clause, num)}</span></strong>")
+          l10n("<strong><span class='fmt-caption-label'><span class='fmt-element-name'>#{lbl}</span> #{semx(
+            clause, num
+          )}</span></strong>")
         end
       end
 
@@ -56,30 +60,12 @@ module IsoDoc
           { label: annex_name_lbl(clause, num),
             elem: lbl,
             type: "clause", value: num.to_s, level: level,
-            #xref: l10n("#{lbl} #{num}") }
-        xref: labelled_autonum(lbl, num) 
-          }
-      end
-
-      # KILL
-      def annex_names1x(clause, parentnum, num, level)
-        lbl = clause_number_semx(parentnum, clause, num)
-            #require 'debug'; binding.b
-        @anchors[clause["id"]] =
-          { label: lbl, elem: @labels["annex_subclause"],
-            xref: @doctype == "resolution" ? lbl : labelled_autonum(@labels['annex_subclause'], lbl),  # l10n("#{@labels['annex_subclause']} #{num}"),
-            level: level, type: "clause" }
-        i = Counter.new(0)
-        clause.xpath(ns("./clause | ./references | ./terms | ./definitions"))
-          .each do |c|
-            #require 'debug'; binding.b
-          annex_names1(c, lbl, i.increment(c).print, level + 1)
-        end
+            xref: labelled_autonum(lbl, num) }
       end
 
       def annex_name_anchors1(clause, lbl, level)
-        xref = labelled_autonum(@labels['annex_subclause'], lbl)
-@doctype == "resolution" and xref = lbl
+        xref = labelled_autonum(@labels["annex_subclause"], lbl)
+        @doctype == "resolution" and xref = lbl
         @anchors[clause["id"]] =
           { label: lbl, elem: @labels["annex_subclause"],
             xref: xref, level: level, type: "clause" }
@@ -105,7 +91,7 @@ module IsoDoc
         elem = @doctype == "resolution" ? @labels["section"] : @labels["clause"]
         lbl = semx(clause, num.print)
         @anchors[clause["id"]] =
-          { label: lbl, xref: labelled_autonum(elem, lbl),# l10n("#{lbl} #{num.print}"),
+          { label: lbl, xref: labelled_autonum(elem, lbl),
             level: lvl, type: "clause", elem: elem }
         i = Counter.new(0)
         clause.xpath(ns(SUBCLAUSES)).each do |c|
@@ -116,7 +102,7 @@ module IsoDoc
 
       def section_names1(clause, parentnum, num, level)
         lbl = clause_number_semx(parentnum, clause, num)
-        x = @doctype == "resolution" ? semx(clause, lbl) : labelled_autonum(@labels['clause'], lbl) #l10n("#{@labels['clause']} #{num}")
+        x = @doctype == "resolution" ? semx(clause, lbl) : labelled_autonum(@labels["clause"], lbl) # l10n("#{@labels['clause']} #{num}")
         @anchors[clause["id"]] =
           { label: lbl, level: level,
             elem: @doctype == "resolution" ? "" : @labels["clause"],
@@ -131,8 +117,7 @@ module IsoDoc
         clause.nil? and return
         lbl = clause.at(ns("./title"))&.text || "[#{clause['id']}]"
         @anchors[clause["id"]] =
-          { label: lbl, 
-            # xref: l10n(%{"#{lbl}"}),
+          { label: lbl,
             xref: semx(clause, lbl),
             level: lvl,
             type: "clause" }
@@ -145,7 +130,6 @@ module IsoDoc
         lbl = clause&.at(ns("./title"))&.text || "[#{clause['id']}]"
         @anchors[clause["id"]] =
           { label: lbl,
-            #xref: l10n(%{"#{lbl}"}), 
             xref: semx(clause, lbl),
             level: level,
             type: "clause" }

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

@@ -62,10 +62,8 @@ module Metanorma
                                        nil, false, "#{@filename}.pdf")
       end
 
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        File.join(File.dirname(__FILE__), "itu.rng"))
+      def schema_file
+        "itu.rng"
       end
 
       def style(_node, _text)

data/lib/metanorma/itu/front.rb

@@ -83,7 +83,6 @@ module Metanorma
           metadata_committee1(node, xml, "_#{suffix}")
           suffix += 1
         end
-        metadata_question(node, xml)
       end
 
       def hyphenate_node_attributes(node)
@@ -216,11 +215,11 @@ module Metanorma
 
       def metadata_ext(node, xml)
         super
+        metadata_question(node, xml)
         metadata_recommendationstatus(node, xml)
         metadata_ip_notice(node, xml)
         metadata_techreport(node, xml)
         metadata_contribution(node, xml)
-        structured_id(node, xml)
       end
     end
   end