metanorma-cc 1.4.3 → 1.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaec6353b69892d4cb11ddb871e78f40deac9fd7211abc4ca8453d7a90cc2e4e
-  data.tar.gz: bc3a24bd8da38ee1f601fd4537bb2f2eaa3f64b9b65ce59d7c4e05f0a55d1034
+  metadata.gz: a6d45f32ac56da049460224a7b9a264fc302db06a9023abdda10b53ab8df4e18
+  data.tar.gz: ac4e8e88813d02bca6a2fdbec491435cedd0f50de19d4de7e5cf67748341b0b5
 SHA512:
-  metadata.gz: 8c8783aee29ff7c0424e9757d5abacf9a8c723b0e542d93999cf0c2095854de9d2a3a51b21259b6646cd5a9a18158cbe030c1357fd73c2d385b73010919c576f
-  data.tar.gz: b9b58534885d70c030e184e8e1f80f2b32939407aec4b22295a4c00665e6a1d8d683dc753291e6a1042b9a73f78f295cb9e9e466a017e7e468d881d0f9ea3953
+  metadata.gz: 67cbd5fcc368c00e569451d9842db371be1ad415a4bb74a318edee209bb8fbb982263b3879613cf957f9a13f006f90d638c57ca6e236b11b6c24fe5e026b853a
+  data.tar.gz: 934db04e842a3a686d2bd30bf671e61f71456adc98605f48ad420e410197b2ee56fbfc575c207aac59ec1f25364990a56332977508a44ee1a8fa116a5e48b178

data/lib/asciidoctor/cc/basicdoc.rng

@@ -402,6 +402,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -429,6 +439,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -998,6 +1018,9 @@
           <value>alphabet_upper</value>
         </choice>
       </attribute>
+      <optional>
+        <attribute name="start"/>
+      </optional>
       <oneOrMore>
         <ref name="li"/>
       </oneOrMore>

data/lib/asciidoctor/cc/cc.rng

@@ -96,6 +96,13 @@
   </include>
   <define name="csd-standard">
     <element name="csd-standard">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <zeroOrMore>
         <ref name="termdocsource"/>

data/lib/asciidoctor/cc/converter.rb

@@ -27,9 +27,12 @@ module Asciidoctor
       def outputs(node, ret)
          File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
           presentation_xml_converter(node).convert(@filename + ".xml")
-          html_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.html")
-          doc_converter(node).convert(@filename + ".presentation.xml", nil, false, "#{@filename}.doc")
-          pdf_converter(node)&.convert(@filename + ".presentation.xml", nil, false, "#{@filename}.pdf")
+          html_converter(node).convert(@filename + ".presentation.xml", 
+                                       nil, false, "#{@filename}.html")
+          doc_converter(node).convert(@filename + ".presentation.xml", 
+                                      nil, false, "#{@filename}.doc")
+          pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+                                       nil, false, "#{@filename}.pdf")
       end
 
       def validate(doc)

data/lib/asciidoctor/cc/front.rb

@@ -4,26 +4,9 @@ require "fileutils"
 
 module Asciidoctor
   module CC
-
     class Converter < Standoc::Converter
-
-      def metadata_author(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "author" }
-          c.organization do |a|
-            a.name "CalConnect"
-          end
-        end
-        personal_author(node, xml)
-      end
-
-      def metadata_publisher(node, xml)
-        xml.contributor do |c|
-          c.role **{ type: "publisher" }
-          c.organization do |a|
-            a.name "CalConnect"
-          end
-        end
+      def default_publisher
+        "CalConnect"
       end
 
       def metadata_committee(node, xml)
@@ -50,7 +33,7 @@ module Asciidoctor
 
       def prefix_id(node)
         prefix = "CC"
-        typesuffix = ::Metanorma::CC::DOCSUFFIX[node.attr("doctype")] || ""
+        typesuffix = ::Metanorma::CC::DOCSUFFIX[doctype(node)] || ""
         prefix += "/#{typesuffix}" unless typesuffix.empty?
         status = ::Metanorma::CC::DOCSTATUS[node.attr("status")] || ""
         prefix += "/#{status}" unless status.empty?
@@ -67,27 +50,18 @@ module Asciidoctor
         xml.docnumber node.attr("docnumber")
       end
 
+      @log_doctype = false
+
       def doctype(node)
-        d = node.attr("doctype")
-        unless ::Metanorma::CC::DOCSUFFIX.keys.include?(d)
+        d = super
+        unless ::Metanorma::CC::DOCSUFFIX.keys.include?(d) && !@log_doctype
           @log.add("Document Attributes", nil,
                    "#{d} is not a legal document type: reverting to 'standard'")
+          @log_doctype = true
           d = "standard"
         end
         d
       end
-
-      def metadata_copyright(node, xml)
-        from = node.attr("copyright-year") || Date.today.year
-        xml.copyright do |c|
-          c.from from
-          c.owner do |owner|
-            owner.organization do |o|
-              o.name "CalConnect"
-            end
-          end
-        end
-      end
     end
   end
 end

data/lib/asciidoctor/cc/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -61,6 +64,11 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="droploc">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -578,6 +586,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +671,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +717,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -834,6 +864,13 @@
   </define>
   <define name="standard-document">
     <element name="standard-document">
+      <attribute name="version"/>
+      <attribute name="type">
+        <choice>
+          <value>semantic</value>
+          <value>presentation</value>
+        </choice>
+      </attribute>
       <ref name="bibdata"/>
       <optional>
         <ref name="boilerplate"/>
@@ -855,7 +892,7 @@
       <oneOrMore>
         <choice>
           <ref name="content"/>
-          <ref name="preface_abstract"/>
+          <ref name="abstract"/>
           <ref name="foreword"/>
           <ref name="introduction"/>
           <ref name="acknowledgements"/>
@@ -922,6 +959,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +1001,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1029,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1051,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1079,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1223,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1447,11 +1493,6 @@
       </optional>
     </element>
   </define>
-  <define name="preface_abstract">
-    <element name="abstract">
-      <ref name="Basic-Section"/>
-    </element>
-  </define>
   <define name="term-clause">
     <element name="clause">
       <optional>
@@ -1501,4 +1542,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/lib/asciidoctor/cc/validate_section.rb

@@ -30,9 +30,10 @@ module Asciidoctor
 
       def seqcheck(names, msg, accepted)
         n = names.shift
-        unless accepted.include? n
+        return [] if n.nil?
+        test = accepted.map { |a| n.at(a) }
+        if test.all? { |a| a.nil? }
           @log.add("Style", nil, msg)
-          names = []
         end
         names
       end
@@ -43,32 +44,20 @@ module Asciidoctor
         [
           {
             msg: "Initial section must be (content) Foreword",
-            val:  [{ tag: "foreword", title: "Foreword" }],
+            val:  ["./self::foreword"]
           },
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val:  [{ tag: "introduction", title: "Introduction" },
-                   { tag: "clause", title: "Scope" }],
+            val:  ["./self::introduction", "./self::clause[@type = 'scope']" ]
           },
           {
             msg: "Prefatory material must be followed by (clause) Scope",
-            val: [{ tag: "clause", title: "Scope" }],
+            val: ["./self::clause[@type = 'scope']" ]
           },
           {
             msg: "Normative References must be followed by "\
             "Terms and Definitions",
-            val: [
-              { tag: "terms", title: "Terms and definitions" },
-              { tag: "clause", title: "Terms and definitions" },
-              {
-                tag: "terms",
-                title: "Terms, definitions, symbols and abbreviated terms",
-              },
-              {
-                tag: "clause",
-                title: "Terms, definitions, symbols and abbreviated terms",
-              },
-            ],
+            val: ["./self::terms | .//terms"]
           },
       ].freeze
 
@@ -78,50 +67,47 @@ module Asciidoctor
         "//clause[descendant::references][not(parent::clause)]".freeze
 
       def sections_sequence_validate(root)
-        f = root.xpath(SECTIONS_XPATH)
-        names = f.map { |s| { tag: s.name, title: s&.at("./title")&.text } }
-        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) || return
+        names = root.xpath(SECTIONS_XPATH)
+        names = seqcheck(names, SEQ[0][:msg], SEQ[0][:val]) 
         n = names[0]
-        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val]) || return
-        if n == { tag: "introduction", title: "Introduction" }
-          names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) || return
+        names = seqcheck(names, SEQ[1][:msg], SEQ[1][:val])
+        if n&.at("./self::introduction")
+          names = seqcheck(names, SEQ[2][:msg], SEQ[2][:val]) 
         end
-        names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val]) || return
+        names = seqcheck(names, SEQ[3][:msg], SEQ[3][:val]) 
         n = names.shift
-        if n == { tag: "definitions", title: nil }
-          n = names.shift || return
+        if n&.at("./self::definitions")
+          n = names.shift 
         end
-        unless n
+        if n.nil? || n.name != "clause"
           @log.add("Style", nil, "Document must contain at least one clause")
-          return
         end
-        n[:tag] == "clause" ||
+        n&.at("./self::clause") ||
           @log.add("Style", nil, "Document must contain clause after "\
                "Terms and Definitions")
-        n == { tag: "clause", title: "Scope" } &&
+        n&.at("./self::clause[@type = 'scope']") &&
           @log.add("Style", nil, "Scope must occur before Terms and Definitions")
-        n = names.shift || return
-        while n[:tag] == "clause"
-          n[:title] == "Scope" &&
+        n = names.shift 
+        while n&.name == "clause"
+          n&.at("./self::clause[@type = 'scope']")
             @log.add("Style", nil, "Scope must occur before Terms and Definitions")
-          n = names.shift || return
+          n = names.shift 
         end
-        unless n[:tag] == "annex" || n[:tag] == "references"
+         unless %w(annex references).include? n&.name
           @log.add("Style", nil, "Only annexes and references can follow clauses")
         end
-        while n[:tag] == "annex"
+         while n&.name == "annex"
           n = names.shift
           if n.nil?
             @log.add("Style", nil, "Document must include (references) "\
                  "Normative References")
-            return
           end
         end
-        n == { tag: "references", title: "Normative References" } ||
+         n&.at("./self::references[@normative = 'true']") ||
           @log.add("Style", nil, "Document must include (references) "\
                "Normative References")
-        n = names.shift
-        n == { tag: "references", title: "Bibliography" } ||
+        n = names&.shift
+        n&.at("./self::references[@normative = 'false']") ||
           @log.add("Style", nil, "Final section must be (references) Bibliography")
         names.empty? ||
           @log.add("Style", nil, "There are sections after the final Bibliography")