metanorma-ogc 2.7.3 → 2.7.5

data/lib/isodoc/ogc/presentation_sections.rb

@@ -4,15 +4,24 @@ module IsoDoc
       def middle_title(docxml); end
 
       def preface_rearrange(doc)
-        super
+        [
+          ["//preface/abstract",
+           %w(executivesummary foreword introduction clause acknowledgements)],
+          ["//preface/executivesummary",
+           %w(foreword introduction clause acknowledgements)],
+          ["//preface/foreword",
+           %w(introduction clause acknowledgements)],
+          ["//preface/introduction",
+           %w(clause acknowledgements)],
+          ["//preface/acknowledgements", %w()],
+        ].each do |x|
+          preface_move(doc.xpath(ns(x[0])), x[1], doc)
+        end
         insert_preface_sections(doc)
       end
 
       def insert_preface_sections(doc)
-        preface_insert(doc.at(ns("//preface/clause" \
-                                 "[@type = 'executivesummary']")),
-                       doc.at(ns("//preface/abstract")), doc)
-        preface_insert(doc.at(ns("//preface//submitters")),
+        preface_insert(doc.at(ns("//preface//clause[@type = 'submitters' or @type = 'contributors']")),
                        submit_orgs_append_pt(doc), doc)
         insert_submitting_orgs(doc)
         preface_insert(doc.at(ns("//preface/clause[@type = 'security']")),
@@ -39,8 +48,8 @@ module IsoDoc
       def submit_orgs_append_pt(docxml)
         docxml.at(ns("//foreword")) ||
           docxml.at(ns("//preface/clause[@type = 'keywords']")) ||
-          docxml.at(ns("//preface/clause[@type = 'executivesummary']")) ||
-          docxml.at(ns("//preface/abstract"))
+          docxml.at(ns("//preface/abstract")) ||
+          docxml.at(ns("//preface/executivesummary"))
       end
 
       def insert_submitting_orgs(docxml)
@@ -78,7 +87,7 @@ module IsoDoc
         kw = @meta.get[:keywords]
         kw.empty? and return
         if abstract =
-             docxml.at(ns("//preface/clause[@type = 'executivesummary']")) ||
+             docxml.at(ns("//preface/executivesummary")) ||
              docxml.at(ns("//preface/abstract"))
           abstract.next = keyword_clause(kw)
         else
@@ -88,12 +97,7 @@ module IsoDoc
       end
 
       def annex_delim(_elem)
-      "<br/>"
-    end
-
-      def clause(docxml)
-        super
-        docxml.xpath(ns("//submitters")).each { |f| clause1(f) }
+        "<br/>"
       end
 
       def clause1(elem)

data/lib/isodoc/ogc/presentation_xml_convert.rb

@@ -51,9 +51,7 @@ module IsoDoc
           <title>#{@i18n.dochistory}</title>
           <table><thead>
           <tr><th>Date</th><th>Release</th><th>Author</th><th>Paragraph Modified</th><th>Description</th></tr>
-          </thead><tbody>
-          #{ret}
-          </tbody></table></annex>
+          </thead><tbody>#{ret}</tbody></table></annex>
         XML
       end
 
@@ -175,15 +173,13 @@ module IsoDoc
         end
       end
 
-      #def designation_boldface(desgn); end
+      # def designation_boldface(desgn); end
 
       def source_label(elem)
         labelled_ancestor(elem) and return
-        #lbl = "<span class='fmt-element-name'>#{lower2cap @i18n.sourcecode}</span>"
         n = @xrefs.get[elem["id"]]
-        #(n.nil? || n[:label].nil? || n[:label].empty?) or
-          #lbl = l10n("#{lbl} #{autonum(elem['id'], n[:label])}")
-        lbl = labelled_autonum(lower2cap(@i18n.sourcecode), elem["id"], n&.dig(:label))
+        lbl = labelled_autonum(lower2cap(@i18n.sourcecode), elem["id"],
+                               n&.dig(:label))
         prefix_name(elem, { caption: block_delim }, lbl, "name")
       end
 
@@ -218,6 +214,20 @@ module IsoDoc
         true
       end
 
+      def ul_label_list(_elem)
+        if @doctype == "white-paper" then %w(&#x2014;)
+        else %w(&#x2022;)
+        end
+      end
+
+      def ol_label_template(_elem)
+        super
+          .merge({
+                   alphabet_upper: %{%<span class="fmt-label-delim">)</span>},
+                   arabic: %{%<span class="fmt-label-delim">.</span>},
+                 })
+      end
+
       include Init
     end
   end

data/lib/isodoc/ogc/sections.rb

@@ -1,13 +1,6 @@
 module IsoDoc
   module Ogc
     module BaseConvert
-      def top_element_render(node, out)
-        case node.name
-        when "submitters" then intro_clause node, out
-        else super
-        end
-      end
-
       def preface(clause, out)
         case clause["type"]
         when "toc"
@@ -17,10 +10,6 @@ module IsoDoc
         end
       end
 
-      def sections_names
-        super + %w[submitters]
-      end
-
       def intro_clause(elem, out)
         out.div class: "Section3", id: elem["id"] do |div|
           clause_name(elem, elem&.at(ns("./fmt-title")), div,

data/lib/isodoc/ogc/xref.rb

@@ -42,7 +42,7 @@ module IsoDoc
       def middle_section_asset_names(doc)
         middle_sections =
           "//clause[@type = 'scope' or @type = 'conformance'] | //foreword | " \
-          "//introduction | //preface/abstract | //submitters | " \
+          "//introduction | //preface/abstract | " \
           "//acknowledgements | //preface/clause | " \
           "#{@klass.norm_ref_xpath} | //sections/terms | " \
           "//sections/definitions | //clause[parent::sections]"
@@ -69,7 +69,7 @@ module IsoDoc
       def preface_names_numbered1(clause, parentnum, num, level)
         lbl = clause_number_semx(parentnum, clause, num)
         @anchors[clause["id"]] =
-          { label: lbl, level: level, 
+          { label: lbl, level: level,
             xref: labelled_autonum(@labels["clause"], lbl),
             type: "clause", elem: @labels["clause"] }
         clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
@@ -110,7 +110,7 @@ module IsoDoc
           @anchors[t["id"]] = anchor_struct(
             c.print, t,
             @labels["sourcecode"], "sourcecode",
-            { unnumb: t["unnumbered"], container: container}
+            { unnumb: t["unnumbered"], container: container }
           )
         end
       end
@@ -123,13 +123,12 @@ module IsoDoc
       def hierarchical_sourcecode_names(clauses, num)
         c = Counter.new
         nodeSet(clauses).each do |clause|
-        clause.xpath(ns(LISTING)).noblank.each do |t|
-          @anchors[t["id"]] =
-            anchor_struct(#"#{num}#{hier_separator}#{c.increment(t).print}", 
-                          hiersemx(clause, num, c.increment(t), t),
-                          t, @labels["sourcecode"],
-                          "sourcecode", { unnumb:t["unnumbered"] })
-        end
+          clause.xpath(ns(LISTING)).noblank.each do |t|
+            @anchors[t["id"]] =
+              anchor_struct(hiersemx(clause, num, c.increment(t), t),
+                            t, @labels["sourcecode"],
+                            "sourcecode", { unnumb: t["unnumbered"] })
+          end
         end
       end
     end

data/lib/metanorma/ogc/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/ogc/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/ogc/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/ogc/cleanup.rb

@@ -14,7 +14,6 @@ module Metanorma
 
       def make_preface(xml, sect)
         super
-        insert_execsummary(xml, sect)
         insert_security(xml, sect)
         insert_submitters(xml, sect)
       end
@@ -23,17 +22,9 @@ module Metanorma
         %(id="_#{UUIDTools::UUID.random_create}")
       end
 
-      def insert_execsummary(xml, sect)
-        summ = xml&.at("//clause[@type = 'executivesummary']")&.remove or
-          return
-        preface = sect.at("//preface") ||
-          sect.add_previous_sibling("<preface/>").first
-        preface.add_child summ
-      end
-
       def insert_security(xml, sect)
-        description = "document"
-        description = "standard" if %w(standard community-standard)
+        "document"
+        "standard" if %w(standard community-standard)
           .include?(@doctype)
         @doctype == "engineering-report" and return remove_security(xml)
         preface = sect.at("//preface") ||
@@ -61,14 +52,13 @@ module Metanorma
       end
 
       def insert_submitters(xml, sect)
-        if xml.at("//submitters")
-          preface = sect.at("//preface") ||
+        if xml.at("//clause[@type = 'submitters' or @type = 'contributors']")
+          p = sect.at("//preface") ||
             sect.add_previous_sibling("<preface/>").first
-          xml.xpath("//submitters").each do |s|
-            s.xpath(".//table").each do |t|
-              t["unnumbered"] = true
-            end
-            preface.add_child s.remove
+          xml.xpath("//clause[@type = 'submitters' or @type = 'contributors']")
+            .each do |s|
+            s.xpath(".//table").each { |t| t["unnumbered"] = true }
+            p.add_child s.remove
           end
         end
       end

data/lib/metanorma/ogc/converter.rb

@@ -11,9 +11,6 @@ module Metanorma
     # schema encapsulation of the document for validation
     #
     class Converter < Standoc::Converter
-      #XML_ROOT_TAG = "ogc-standard".freeze
-      #XML_NAMESPACE = "https://www.metanorma.org/ns/ogc".freeze
-
       register_for "ogc"
 
       def init_toc(node)
@@ -71,10 +68,8 @@ module Metanorma
 
       def override_style(node)
         s = node.attr("style")
-        if %w(executive_summary overview future_outlook value_proposition
-              contributors).include?(s)
+        if %w(overview future_outlook value_proposition contributors).include?(s)
           node.set_attr("style", "preface")
-          s == "executive_summary" and s = "executivesummary"
           node.set_attr("type", s)
         end
         if %w(aims objectives topics outlook security).include?(s)
@@ -93,6 +88,12 @@ module Metanorma
         end
       end
 
+      # legacy encoding
+      def sectiontype1(node)
+        role_style(node, "executive_summary") and return "executivesummary"
+        super
+      end
+
       def outputs(node, ret)
         File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
         presentation_xml_converter(node).convert("#{@filename}.xml")
@@ -105,20 +106,18 @@ module Metanorma
       end
 
       def clause_parse(attrs, xml, node)
-        %w(executivesummary overview future_outlook value_proposition
+        %w(overview future_outlook value_proposition
            contributors aims objectives topics outlook security)
           .include?(node.attr("type")) and
           attrs = attrs.merge(type: node.attr("type"))
         case node.attr("heading")&.downcase || node.title.downcase
         when "submitters"
-          return submitters_parse(attrs, xml, node)
+          return submitters_parse(attrs.merge(type: "submitters"), xml, node)
         when "contributors"
           return submitters_parse(attrs.merge(type: "contributors"), xml, node)
         when "conformance" then attrs = attrs.merge(type: "conformance")
         when "security considerations"
           attrs = attrs.merge(type: "security")
-        when "executive summary"
-          attrs = attrs.merge(type: "executivesummary")
         end
         super
       end
@@ -128,7 +127,7 @@ module Metanorma
         doctype(node) == "engineering-report" ||
           attrs[:type] == "contributors" and
           title = @i18n.contributors_clause
-        xml.submitters **attr_code(attrs) do |xml_section|
+        xml.clause **attr_code(attrs) do |xml_section|
           xml_section.title title
           xml_section << node.content
         end
@@ -164,7 +163,8 @@ module Metanorma
         end
       end
 
-      def highlight_parse(text, xml)
+      # KILL 
+      def highlight_parsex(text, xml)
         xml.hi { |s| s << text }
       end