metanorma-standoc 1.9.1 → 1.9.2

data/lib/asciidoctor/standoc/isodoc.rng

@@ -876,6 +876,18 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="pagebreak">
+      <element name="pagebreak">
+        <optional>
+          <attribute name="orientation">
+            <choice>
+              <value>landscape</value>
+              <value>portrait</value>
+            </choice>
+          </attribute>
+        </optional>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
   <define name="colgroup">
@@ -943,8 +955,170 @@
       <ref name="permission"/>
       <ref name="imagemap"/>
       <ref name="svgmap"/>
+      <ref name="inputform"/>
+    </choice>
+  </define>
+  <define name="inputform">
+    <element name="form">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="name"/>
+      <attribute name="action"/>
+      <zeroOrMore>
+        <choice>
+          <ref name="TextElement"/>
+          <ref name="FormInput"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="FormInput">
+    <choice>
+      <ref name="input"/>
+      <ref name="formlabel"/>
+      <ref name="select"/>
+      <ref name="textarea"/>
+    </choice>
+  </define>
+  <define name="InputType">
+    <choice>
+      <value>button</value>
+      <value>checkbox</value>
+      <value>date</value>
+      <value>file</value>
+      <value>password</value>
+      <value>radio</value>
+      <value>submit</value>
+      <value>text</value>
     </choice>
   </define>
+  <define name="input">
+    <element name="input">
+      <attribute name="type">
+        <ref name="InputType"/>
+      </attribute>
+      <optional>
+        <attribute name="checked">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="readonly">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="maxlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="minlength">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
+  <define name="formlabel">
+    <element name="label">
+      <attribute name="for">
+        <data type="IDREF"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="select">
+    <element name="select">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="multiple">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="size">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="option"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="option">
+    <element name="option">
+      <optional>
+        <attribute name="disabled">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="textarea">
+    <element name="textarea">
+      <optional>
+        <attribute name="name"/>
+      </optional>
+      <optional>
+        <attribute name="value"/>
+      </optional>
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="rows">
+          <data type="int"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="cols">
+          <data type="int"/>
+        </attribute>
+      </optional>
+    </element>
+  </define>
   <define name="bibliography">
     <element name="bibliography">
       <oneOrMore>

data/lib/asciidoctor/standoc/macros.rb

@@ -4,6 +4,7 @@ require "uuidtools"
 require "yaml"
 require_relative "./macros_plantuml"
 require_relative "./macros_terms"
+require_relative "./macros_form"
 require_relative "./datamodel/attributes_table_preprocessor"
 require_relative "./datamodel/diagram_preprocessor"
 require "metanorma-plugin-datastruct"
@@ -74,12 +75,11 @@ module Asciidoctor
       def supply_br(lines)
         ignore = false
         lines.each_with_index do |l, i|
-          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|\`\`\`\`+|____\+)$/.match(l) &&
-            (ignore = !ignore)
-          next if l.empty? || l.match(/ \+$/)
-          next if /^\[.*\]$/.match?(l)
-          next if ignore
-          next if i == lines.size - 1 || i < lines.size - 1 && lines[i + 1].empty?
+          /^(--+|====+|\|===|\.\.\.\.+|\*\*\*\*+|\+\+\+\++|\`\`\`\`+|____\+)$/
+            .match(l) && (ignore = !ignore)
+          next if l.empty? || l.match(/ \+$/) || /^\[.*\]$/.match?(l) || ignore
+          next if i == lines.size - 1 ||
+            i < lines.size - 1 && lines[i + 1].empty?
 
           lines[i] += " +"
         end
@@ -128,22 +128,22 @@ module Asciidoctor
       def process(parent, reader, attrs)
         attrs["name"] = "todo"
         attrs["caption"] = "TODO"
-        create_block parent, :admonition, reader.lines, attrs,
-          content_model: :compound
+        create_block(parent, :admonition, reader.lines, attrs,
+                     content_model: :compound)
       end
     end
 
     class ToDoInlineAdmonitionBlock < Extensions::Treeprocessor
       def process(document)
         (document.find_by context: :paragraph).each do |para|
-          next unless /^TODO: /.match para.lines[0]
+          next unless /^TODO: /.match? para.lines[0]
 
           parent = para.parent
           para.set_attr("name", "todo")
           para.set_attr("caption", "TODO")
           para.lines[0].sub!(/^TODO: /, "")
-          todo = Block.new parent, :admonition, attributes: para.attributes,
-            source: para.lines, content_model: :compound
+          todo = Block.new(parent, :admonition, attributes: para.attributes,
+                           source: para.lines, content_model: :compound)
           parent.blocks[parent.blocks.index(para)] = todo
         end
       end

data/lib/asciidoctor/standoc/macros_form.rb

@@ -0,0 +1,63 @@
+module Asciidoctor
+  module Standoc
+    class FormInputMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :input
+
+      def process(_parent, target, attr)
+        m = %w(id name value disabled readonly checked maxlength minlength)
+          .map { |a| attr[a] ? " #{a}='#{attr[a]}'" : nil }.compact
+        %{<input type='#{target}' #{m.join}/>}
+      end
+    end
+
+    class FormLabelMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :label
+      parse_content_as :text
+
+      def process(parent, target, attr)
+        out = Asciidoctor::Inline.new(parent, :quoted, attr["text"]).convert
+        %{<label for="#{target}">#{out}</label>}
+      end
+    end
+
+    class FormTextareaMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :textarea
+      using_format :short
+
+      def process(_parent, _target, attr)
+        m = %w(id name rows cols value)
+          .map { |a| attr[a] ? " #{a}='#{attr[a]}'" : nil }.compact
+        %{<textarea #{m.join}/>}
+      end
+    end
+
+    class FormSelectMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :select
+      using_format :short
+
+      def process(parent, _target, attr)
+        m = %w(id name size disabled multiple value)
+          .map { |a| attr[a] ? " #{a}='#{attr[a]}'" : nil }.compact
+        out = Asciidoctor::Inline.new(parent, :quoted, attr["text"]).convert
+        %{<select #{m.join}>#{out}</select>}
+      end
+    end
+
+    class FormOptionMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :option
+      using_format :short
+
+      def process(parent, _target, attr)
+        m = %w(disabled value)
+          .map { |a| attr[a] ? " #{a}='#{attr[a]}'" : nil }.compact
+        out = Asciidoctor::Inline.new(parent, :quoted, attr["text"]).convert
+        %{<option #{m.join}">#{out}</option>}
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/ref_sect.rb

@@ -10,10 +10,10 @@ module Asciidoctor
       end
 
       def reference(node)
-          noko do |xml|
-            node.items.each { |item| reference1(node, item.text, xml) }
-          end.join
-        end
+        noko do |xml|
+          node.items.each { |item| reference1(node, item.text, xml) }
+        end.join
+      end
 
       def bibliography_parse(attrs, xml, node)
         node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
@@ -43,12 +43,12 @@ module Asciidoctor
         node.attr("style") == "bibliography" or
           @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
         @norm_ref = true
-        xml.references **attr_code(attrs.merge(
-          normative: node.attr("normative") || true)) do |xml_section|
-            xml_section.title { |t| t << node.title }
-            xml_section << node.content
-          end
-          @norm_ref = false
+        attrs = attrs.merge(normative: node.attr("normative") || true)
+        xml.references **attr_code(attrs) do |xml_section|
+          xml_section.title { |t| t << node.title }
+          xml_section << node.content
+        end
+        @norm_ref = false
       end
 
       def global_ievcache_name
@@ -57,6 +57,7 @@ module Asciidoctor
 
       def local_ievcache_name(cachename)
         return nil if cachename.nil?
+
         cachename += "_iev" unless cachename.empty?
         cachename = "iev" if cachename.empty?
         "#{cachename}/cache"
@@ -64,10 +65,11 @@ module Asciidoctor
 
       def fetch_ref(xml, code, year, **opts)
         return nil if opts[:no_year]
+
         code = code.sub(/^\([^)]+\)/, "")
-        #require "byebug"; byebug if opts[:lang] == "fr"
         hit = @bibdb&.fetch(code, year, opts)
         return nil if hit.nil?
+
         xml.parent.add_child(smart_render_xml(hit, code, opts))
         xml
       rescue RelatonBib::RequestError
@@ -91,10 +93,9 @@ module Asciidoctor
           "<docidentifier type='metanorma'>#{mn_code(usrlbl)}</docidentifier>"
       end
 
-      def smart_render_xml(x, code, opts)
-        x.respond_to? :to_xml or return nil
-        xstr = x.to_xml(lang: opts[:lang])
-        xml = Nokogiri::XML(xstr)
+      def smart_render_xml(xml, code, opts)
+        xml.respond_to? :to_xml or return nil
+        xml = Nokogiri::XML(xml.to_xml(lang: opts[:lang]))
         emend_biblio(xml, code, opts[:title], opts[:usrlbl])
         xml.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
         xml.traverse do |n|
@@ -105,17 +106,19 @@ module Asciidoctor
 
       def init_bib_caches(node)
         return if @no_isobib
+
         global = !@no_isobib_cache && !node.attr("local-cache-only")
         local = node.attr("local-cache") || node.attr("local-cache-only")
         local = nil if @no_isobib_cache
         @bibdb = Relaton::DbCache.init_bib_caches(
           local_cache: local,
           flush_caches: node.attr("flush-caches"),
-          global_cache: global)
+          global_cache: global
+        )
       end
 
       def init_iev_caches(node)
-        unless (@no_isobib_cache || @no_isobib)
+        unless @no_isobib_cache || @no_isobib
           node.attr("local-cache-only") or
             @iev_globalname = global_ievcache_name
           @iev_localname = local_ievcache_name(node.attr("local-cache") ||

data/lib/asciidoctor/standoc/section.rb

@@ -10,7 +10,9 @@ module Asciidoctor
       @norm_ref = false
 
       def sectiontype1(node)
-        node&.attr("heading")&.downcase || node.title.gsub(/<[^>]+>/, "").downcase
+        node&.attr("heading")&.downcase ||
+          node.title.gsub(%r{<index>.*?</index>}m, "").gsub(/<[^>]+>/, "")
+          .strip.downcase
       end
 
       def sectiontype(node, level = true)

data/lib/asciidoctor/standoc/terms.rb

@@ -12,12 +12,13 @@ module Asciidoctor
         @definitions = defs
       end
 
-      def symbols_attrs(node, a)
+      def symbols_attrs(node, attr)
         case sectiontype1(node)
-        when "symbols" then a.merge(type: "symbols")
-        when "abbreviated terms", "abbreviations" then a.merge(type: "abbreviated_terms")
+        when "symbols" then attr.merge(type: "symbols")
+        when "abbreviated terms", "abbreviations"
+          attr.merge(type: "abbreviated_terms")
         else
-          a
+          attr
         end
       end
 
@@ -51,13 +52,17 @@ module Asciidoctor
 
       # 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)
+        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 == "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
@@ -69,7 +74,7 @@ module Asciidoctor
         end
       end
 
-      def term_def_parse(attrs, xml, node, toplevel)
+      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|
@@ -79,14 +84,14 @@ module Asciidoctor
         end
       end
 
-      def term_source_attrs(node, seen_xref)
-          { case: seen_xref.children[0]["case"],
-            droploc: seen_xref.children[0]["droploc"],
-            bibitemid: seen_xref.children[0]["target"],
-            format: seen_xref.children[0]["format"], type: "inline" }
+      def term_source_attrs(_node, seen_xref)
+        { case: seen_xref.children[0]["case"],
+          droploc: seen_xref.children[0]["droploc"],
+          bibitemid: seen_xref.children[0]["target"],
+          format: seen_xref.children[0]["format"], type: "inline" }
       end
 
-      def add_term_source(node, xml_t, seen_xref, m)
+      def add_term_source(node, xml_t, seen_xref, match)
         if seen_xref.children[0].name == "concept"
           xml_t.origin { |o| o << seen_xref.children[0].to_xml }
         else
@@ -94,8 +99,8 @@ module Asciidoctor
           attrs.delete(:text)
           xml_t.origin seen_xref.children[0].content, **attr_code(attrs)
         end
-        m[:text] && xml_t.modification do |mod|
-          mod.p { |p| p << m[:text].sub(/^\s+/, "") }
+        match[:text] && xml_t.modification do |mod|
+          mod.p { |p| p << match[:text].sub(/^\s+/, "") }
         end
       end
 
@@ -110,7 +115,9 @@ module Asciidoctor
 
       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.nil? and @log.add("AsciiDoc Input", node,
+                                  "term reference not in expected format:"\
+                                  "#{text}")
         matched
       end