metanorma-standoc 1.6.5 → 1.8.1

data/lib/asciidoctor/standoc/isodoc.rng

@@ -55,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>
@@ -246,6 +253,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
         <optional>
           <ref name="colgroup"/>
         </optional>
@@ -779,6 +789,9 @@
       <attribute name="width"/>
     </element>
   </define>
+  <define name="BibItemType" combine="choice">
+    <value>internal</value>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -829,6 +842,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -884,9 +900,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -1056,6 +1074,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1109,6 +1130,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1211,6 +1235,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1539,6 +1566,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1569,6 +1597,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>

data/lib/asciidoctor/standoc/lists.rb

@@ -54,7 +54,7 @@ module Asciidoctor
       end
 
       def ol_attrs(node)
-        attr_code(keep_attrs(node).merge(id: Utils::anchor_or_uuid(node),
+        attr_code(keep_attrs(node).merge(id: Metanorma::Utils::anchor_or_uuid(node),
                                          type: olist_style(node.style)))
       end
 
@@ -88,7 +88,7 @@ module Asciidoctor
 
       def dl_attrs(node)
         attr_code(keep_attrs(node).
-                  merge(id: Utils::anchor_or_uuid(node),
+                  merge(id: Metanorma::Utils::anchor_or_uuid(node),
                         key: node.option?("key") ? "true" : nil))
       end
 

data/lib/asciidoctor/standoc/macros.rb

@@ -23,7 +23,7 @@ module Asciidoctor
       end
     end
 
-    class IndexInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+    class IndexXrefInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :index
 
@@ -44,6 +44,19 @@ module Asciidoctor
       end
     end
 
+    class IndexRangeInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named "index-range".to_sym
+      parse_content_as :text
+
+      def process(parent, target, attr)
+        text = attr["text"]
+        text = "((#{text}))" unless /^\(\(.+\)\)$/.match(text)
+        out = parent.sub_macros(text)
+        out.sub(/<index>/, "<index to='#{target}'>")
+      end
+    end
+
     class PseudocodeBlockMacro < Asciidoctor::Extensions::BlockProcessor
       use_dsl
       named :pseudocode

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -30,7 +30,7 @@ module Asciidoctor
       # plantuml process may finish earlier then dot, as result png file
       # maybe not created yet after plantuml finish
       def self.generate_file parent, reader
-        localdir = Utils::localdir(parent.document)
+        localdir = Metanorma::Utils::localdir(parent.document)
         imagesdir = parent.document.attr('imagesdir')
         umlfile, outfile = save_plantuml parent, reader, localdir
         run(umlfile, outfile) or raise "No image output from PlantUML (#{umlfile}, #{outfile})!"

data/lib/asciidoctor/standoc/ref_sect.rb

@@ -96,9 +96,9 @@ module Asciidoctor
         xstr = x.to_xml(lang: opts[:lang])
         xml = Nokogiri::XML(xstr)
         emend_biblio(xml, code, opts[:title], opts[:usrlbl])
-        xml.xpath("//date").each { |d| Utils::endash_date(d) }
+        xml.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
         xml.traverse do |n|
-          n.text? and n.replace(Utils::smartformat(n.text))
+          n.text? and n.replace(Metanorma::Utils::smartformat(n.text))
         end
         xml.to_xml.sub(/<\?[^>]+>/, "")
       end

data/lib/asciidoctor/standoc/reqt.rb

@@ -6,6 +6,11 @@ require "base64"
 module Asciidoctor
   module Standoc
     module Blocks
+      def reqt_subpart(x)
+        %w(specification measurement-target verification import label
+             subject inherit classification title).include? x
+      end
+
       def reqt_subpart_attrs(node)
         attr_code(keep_attrs(node).merge(exclude: node.option?("exclude"),
                                      type: node.attr("type")))
@@ -41,7 +46,7 @@ module Asciidoctor
 
       def reqt_attrs(node)
         attr_code(keep_attrs(node).merge(id_unnum_attrs(node)).merge(
-          id: Utils::anchor_or_uuid(node),
+          id: Metanorma::Utils::anchor_or_uuid(node),
           unnumbered: node.option?("unnumbered") ? "true" : nil,
           number: node.attr("number"),
           subsequence: node.attr("subsequence"),

data/lib/asciidoctor/standoc/section.rb

@@ -1,6 +1,6 @@
-require "htmlentities"
 require "uri"
 require_relative "ref_sect"
+require_relative "terms"
 
 module Asciidoctor
   module Standoc
@@ -9,13 +9,8 @@ module Asciidoctor
       @term_def = false
       @norm_ref = false
 
-      def in_terms?
-        @term_def
-      end
-
       def sectiontype1(node)
-        node&.attr("heading")&.downcase ||
-          node.title.gsub(/<[^>]+>/, "").downcase
+        node&.attr("heading")&.downcase || node.title.gsub(/<[^>]+>/, "").downcase
       end
 
       def sectiontype(node, level = true)
@@ -46,16 +41,15 @@ module Asciidoctor
       end
 
       def section_attributes(node)
-        ret = { id: Utils::anchor_or_uuid(node),
-          language: node.attributes["language"],
-          script: node.attributes["script"],
-          annex: (
-            ((node.attr("style") == "appendix" || node.role == "appendix") && 
-             node.level == 1) ? true : nil
-          ),
-          preface: (
-            (node.role == "preface" || node.attr("style") == "preface") ?
-            true : nil) }
+        ret = { id: Metanorma::Utils::anchor_or_uuid(node),
+                language: node.attributes["language"],
+                script: node.attributes["script"],
+                number: node.attributes["number"],
+                type: node.attributes["type"],
+                annex: ( ((node.attr("style") == "appendix" || node.role == "appendix") && 
+                          node.level == 1) ? true : nil),
+                         preface: (
+                           (node.role == "preface" || node.attr("style") == "preface") ?  true : nil) }
         return ret unless node.attributes["change"]
         ret.merge(change: node.attributes["change"],
                   path: node.attributes["path"],
@@ -105,9 +99,9 @@ module Asciidoctor
 
       def set_obligation(attrs, node)
         attrs[:obligation] = node.attributes.has_key?("obligation") ?
-                               node.attr("obligation") :
-                             node.parent.attributes.has_key?("obligation") ?
-                               node.parent.attr("obligation") : "normative"
+          node.attr("obligation") :
+          node.parent.attributes.has_key?("obligation") ?
+          node.parent.attr("obligation") : "normative"
       end
 
       def preamble(node)
@@ -150,75 +144,6 @@ module Asciidoctor
         end
       end
 
-      def nonterm_symbols_parse(attrs, xml, node)
-        defs = @definitions
-        @definitions = false
-        clause_parse(attrs, xml, node)
-        @definitions = defs
-      end
-
-      def symbols_attrs(node, a)
-        case sectiontype1(node)
-        when "symbols" then a.merge(type: "symbols")
-        when "abbreviated terms", "abbreviations" then a.merge(type: "abbreviated_terms")
-        else
-          a
-        end
-      end
-
-      def symbols_parse(attr, xml, node)
-        node.role == "nonterm" and return nonterm_symbols_parse(attr, xml, node)
-        xml.definitions **attr_code(attr) do |xml_section|
-          xml_section.title { |t| t << node.title }
-          defs = @definitions
-          termdefs = @term_def
-          @definitions = true
-          @term_def = false
-          xml_section << node.content
-          @definitions = defs
-          @term_def = termdefs
-        end
-      end
-
-      def nonterm_term_def_subclause_parse(attrs, xml, node)
-        defs = @term_def
-        @term_def = false
-        clause_parse(attrs, xml, node)
-        @term_def = defs
-      end
-
-      # subclause contains subclauses
-      def term_def_subclause_parse(attrs, xml, node)
-        node.role == "nonterm"  and
-          return nonterm_term_def_subclause_parse(attrs, xml, node)
-        st = sectiontype(node, false)
-        return symbols_parse(attrs, xml, node) if @definitions
-        sub = node.find_by(context: :section) { |s| s.level == node.level + 1 }
-        sub.empty? || (return term_def_parse(attrs, xml, node, false))
-        st == "symbols and abbreviated terms" and
-          (return symbols_parse(attrs, xml, node))
-        st == "terms and definitions" and
-          return clause_parse(attrs, xml, node)
-        term_def_subclause_parse1(attrs, xml, node)
-      end
-
-      def term_def_subclause_parse1(attrs, xml, node)
-        xml.term **attr_code(attrs) do |xml_section|
-          xml_section.preferred { |name| name << node.title }
-          xml_section << node.content
-        end
-      end
-
-      def term_def_parse(attrs, xml, node, toplevel)
-        xml.terms **attr_code(attrs) do |section|
-          section.title { |t| t << node.title }
-          (s = node.attr("source")) && s.split(/,/).each do |s1|
-            section.termdocsource(nil, **attr_code(bibitemid: s1))
-          end
-          section << node.content
-        end
-      end
-
       def introduction_parse(attrs, xml, node)
         xml.introduction **attr_code(attrs) do |xml_section|
           xml_section.title { |t| t << @i18n.introduction }

data/lib/asciidoctor/standoc/table.rb

@@ -2,7 +2,7 @@ module Asciidoctor
   module Standoc
     module Table
       def table_attrs(node)
-        keep_attrs(node).merge( id: Utils::anchor_or_uuid(node),
+        keep_attrs(node).merge( id: Metanorma::Utils::anchor_or_uuid(node),
           headerrows: node.attr("headerrows"),
           unnumbered: node.option?("unnumbered") ? "true" : nil,
           number: node.attr("number"),

data/lib/asciidoctor/standoc/terms.rb

@@ -0,0 +1,125 @@
+module Asciidoctor
+  module Standoc
+    module Section
+      def in_terms?
+        @term_def
+      end
+
+      def nonterm_symbols_parse(attrs, xml, node)
+        defs = @definitions
+        @definitions = false
+        clause_parse(attrs, xml, node)
+        @definitions = defs
+      end
+
+      def symbols_attrs(node, a)
+        case sectiontype1(node)
+        when "symbols" then a.merge(type: "symbols")
+        when "abbreviated terms", "abbreviations" then a.merge(type: "abbreviated_terms")
+        else
+          a
+        end
+      end
+
+      def symbols_parse(attr, xml, node)
+        node.role == "nonterm" and return nonterm_symbols_parse(attr, xml, node)
+        xml.definitions **attr_code(attr) do |xml_section|
+          xml_section.title { |t| t << node.title }
+          defs = @definitions
+          termdefs = @term_def
+          @definitions = true
+          @term_def = false
+          xml_section << node.content
+          @definitions = defs
+          @term_def = termdefs
+        end
+      end
+
+      def nonterm_term_def_subclause_parse(attrs, xml, node)
+        defs = @term_def
+        @term_def = false
+        clause_parse(attrs, xml, node)
+        @term_def = defs
+      end
+
+      def terms_boilerplate_parse(attrs, xml, node)
+        defs = @term_def
+        @term_def = false
+        clause_parse(attrs.merge(type: "boilerplate"), xml, node)
+        @term_def = defs
+      end
+
+      # subclause contains subclauses
+      def term_def_subclause_parse(attrs, xml, node)
+        node.role == "nonterm"  and return nonterm_term_def_subclause_parse(attrs, xml, node)
+        node.role == "boilerplate"  and return terms_boilerplate_parse(attrs, xml, node)
+        st = sectiontype(node, false)
+        return symbols_parse(attrs, xml, node) if @definitions
+        sub = node.find_by(context: :section) { |s| s.level == node.level + 1 }
+        sub.empty? || (return term_def_parse(attrs, xml, node, false))
+        st == "symbols and abbreviated terms" and (return symbols_parse(attrs, xml, node))
+        st == "terms and definitions" and return clause_parse(attrs, xml, node)
+        term_def_subclause_parse1(attrs, xml, node)
+      end
+
+      def term_def_subclause_parse1(attrs, xml, node)
+        xml.term **attr_code(attrs) do |xml_section|
+          xml_section.preferred { |name| name << node.title }
+          xml_section << node.content
+        end
+      end
+
+      def term_def_parse(attrs, xml, node, toplevel)
+        xml.terms **attr_code(attrs) do |section|
+          section.title { |t| t << node.title }
+          (s = node.attr("source")) && s.split(/,/).each do |s1|
+            section.termdocsource(nil, **attr_code(bibitemid: s1))
+          end
+          section << node.content
+        end
+      end
+
+      def term_source_attrs(seen_xref)
+        { bibitemid: seen_xref.children[0]["target"],
+          format: seen_xref.children[0]["format"], type: "inline" }
+      end
+
+      def add_term_source(xml_t, seen_xref, m)
+        if seen_xref.children[0].name == "concept"
+          xml_t.origin { |o| o << seen_xref.children[0].to_xml }
+        else
+          xml_t.origin seen_xref.children[0].content, **attr_code(term_source_attrs(seen_xref))
+        end
+        m[:text] && xml_t.modification do |mod|
+          mod.p { |p| p << m[:text].sub(/^\s+/, "") }
+        end
+      end
+
+      TERM_REFERENCE_RE_STR = <<~REGEXP.freeze
+        ^(?<xref><(xref|concept)[^>]+>([^<]*</(xref|concept)>)?)
+               (,\s(?<text>.*))?
+        $
+      REGEXP
+      TERM_REFERENCE_RE =
+        Regexp.new(TERM_REFERENCE_RE_STR.gsub(/\s/, "").gsub(/_/, "\\s"),
+                   Regexp::IGNORECASE | Regexp::MULTILINE)
+
+      def extract_termsource_refs(text, node)
+        matched = TERM_REFERENCE_RE.match text
+        matched.nil? and @log.add("AsciiDoc Input", node, "term reference not in expected format: #{text}")
+        matched
+      end
+
+      def termsource(node)
+        matched = extract_termsource_refs(node.content, node) || return
+        noko do |xml|
+          attrs = { status: matched[:text] ? "modified" : "identical" }
+          xml.termsource **attrs do |xml_t|
+            seen_xref = Nokogiri::XML.fragment(matched[:xref])
+            add_term_source(xml_t, seen_xref, matched)
+          end
+        end.join("\n")
+      end
+    end
+  end
+end