metanorma-iho 1.1.3 → 1.1.5

data/lib/isodoc/iho/presentation_xml_convert.rb

@@ -17,19 +17,6 @@ _bib)
 
       def middle_title(docxml); end
 
-      def preface_rearrange(doc)
-        preface_move(doc.xpath(ns("//preface/abstract")),
-                     %w(foreword executivesummary introduction clause acknowledgements), doc)
-        preface_move(doc.xpath(ns("//preface/foreword")),
-                     %w(executivesummary introduction clause acknowledgements), doc)
-        preface_move(doc.xpath(ns("//preface/executivesummary")),
-                     %w(introduction clause acknowledgements), doc)
-        preface_move(doc.xpath(ns("//preface/introduction")),
-                     %w(clause acknowledgements), doc)
-        preface_move(doc.xpath(ns("//preface/acknowledgements")),
-                     %w(), doc)
-      end
-
       def bibdata(docxml)
         super
         dochistory(docxml)
@@ -86,18 +73,19 @@ _bib)
       end
 
       def dochistory_contributor(contrib)
-        ret = contrib.at("./organization/abbreviation") ||
-          contrib.at("./organization/subdivision") ||
-          contrib.at("./organization/name") ||
-          contrib.at("./person/name/abbreviation") ||
-          contrib.at("./person/name/completename")
+        ret = contrib.at(ns("./organization/abbreviation")) ||
+          contrib.at(ns("./organization/subdivision")) ||
+          contrib.at(ns("./organization/name")) ||
+          contrib.at(ns("./person/name/abbreviation")) ||
+          contrib.at(ns("./person/name/completename"))
         ret and return ret.text
         format_personalname(contrib)
       end
 
       def format_personalname(contrib)
         Relaton::Render::General.new(template: { book: "{{ creatornames }}" })
-          .render("<bibitem type='book'>#{contrib.to_xml}</bibitem>")
+          .render("<bibitem type='book'>#{contrib.to_xml}</bibitem>",
+                  embedded: true)
       end
 
       def dochistory_description(item)
@@ -124,18 +112,6 @@ _bib)
 
       def term1(elem); end
 
-      # KILL
-      def termsource1(elem)
-        elem.parent.nil? and return
-        while elem&.next_element&.name == "termsource"
-          elem << "; #{to_xml(elem.next_element.remove.children)}"
-        end
-        t = elem.at("./ancestor::xmlns:term") or return
-        s = l10n(" [#{to_xml(elem.remove.children).strip}]")
-        defn = t.at(ns(".//definition[last()]")) or return
-        defn.elements.last << s
-      end
-
       def termsource1(elem)
         elem.parent.nil? and return
         super
@@ -143,8 +119,8 @@ _bib)
 
       def termsource_label(elem, sources)
         elem.at("./ancestor::xmlns:term") or return
-      elem.replace(l10n("[#{sources}]"))
-    end
+        elem.replace(l10n("[#{sources}]"))
+      end
 
       def termcleanup(docxml)
         collapse_term docxml
@@ -162,14 +138,13 @@ _bib)
         source.remove
       end
 
-       def clausedelim
+      def clausedelim
         ""
       end
 
-       def clause(docxml)
-         super
-         docxml.xpath(ns("//executivesummary | //appendix")).each { |x| clause1(x) }
-       end
+      def ul_label_list(_elem)
+        %w(&#x2022; &#x2014; &#x6f;)
+      end
 
       include Init
     end

data/lib/isodoc/iho/xref.rb

@@ -126,7 +126,6 @@ module IsoDoc
         lbl = clause_number_semx(parentnum, clause, num)
         @anchors[clause["id"]] =
           { label: lbl, level: level,
-            #xref: l10n("#{@labels['subclause']} #{num}"),
             xref: labelled_autonum(@labels['subclause'], lbl),
             type: "clause", elem: @labels["subclause"] }
         i = Counter.new(0)

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

@@ -9,19 +9,8 @@ module Metanorma
 
       register_for "iho"
 
-      def clause_parse(attrs, xml, node)
-        node.option? "appendix" and
-          return appendix_parse(attrs, xml, node)
-        super
-      end
-
-      def appendix_parse(attrs, xml, node)
-        attrs[:"inline-header"] = node.option? "inline-header"
-        set_obligation(attrs, node)
-        xml.appendix **attr_code(attrs) do |xml_section|
-          xml_section.title { |name| name << node.title }
-          xml_section << node.content
-        end
+      def support_appendix?(_node)
+        true
       end
 
       SERIESNAME = {

data/lib/metanorma/iho/iho.rng

@@ -1,37 +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
-    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.
-  -->
+<grammar ns='https://www.metanorma.org/ns/standoc' xmlns="http://relaxng.org/ns/structure/1.0">
   <include href="relaton-iho.rng"/>
   <include href="isodoc.rng">
     <define name="annex">
       <element name="annex">
-        <optional>
-          <attribute name="id">
-            <data type="ID"/>
-          </attribute>
-        </optional>
-        <optional>
-          <attribute name="language"/>
-        </optional>
-        <optional>
-          <attribute name="script"/>
-        </optional>
-        <optional>
-          <attribute name="inline-header">
-            <data type="boolean"/>
-          </attribute>
-        </optional>
-        <attribute name="obligation">
-          <choice>
-            <value>normative</value>
-            <value>informative</value>
-          </choice>
-        </attribute>
+        <ref name="Annex-Section-Attributes"/>
         <optional>
           <ref name="section-title"/>
         </optional>
@@ -53,36 +26,5 @@
         </zeroOrMore>
       </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>
-  <define name="annex-appendix">
-    <element name="appendix">
-      <ref name="Clause-Section"/>
-    </element>
-  </define>
 </grammar>