metanorma-standoc 1.10.8 → 1.11.0

data/lib/asciidoctor/standoc/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<grammar ns="https://www.metanorma.org/ns/standoc" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+<grammar ns="https://www.metanorma.org/ns/standoc" 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">
   <include href="reqt.rng"/>
   <!-- include "biblio.rnc" { } -->
   <include href="basicdoc.rng">
@@ -1803,17 +1803,20 @@
         <ref name="admitted"/>
       </zeroOrMore>
       <zeroOrMore>
-        <ref name="related"/>
+        <ref name="deprecates"/>
       </zeroOrMore>
       <zeroOrMore>
-        <ref name="deprecates"/>
+        <ref name="related"/>
       </zeroOrMore>
       <optional>
         <ref name="termdomain"/>
       </optional>
-      <zeroOrMore>
-        <ref name="termgrammar"/>
-      </zeroOrMore>
+      <optional>
+        <ref name="termsubject"/>
+      </optional>
+      <optional>
+        <ref name="termusage"/>
+      </optional>
       <oneOrMore>
         <ref name="termdefinition"/>
       </oneOrMore>
@@ -1830,41 +1833,200 @@
   </define>
   <define name="preferred">
     <element name="preferred">
-      <oneOrMore>
-        <ref name="TextElement"/>
-      </oneOrMore>
+      <ref name="Designation"/>
     </element>
   </define>
   <define name="admitted">
     <element name="admitted">
-      <oneOrMore>
-        <ref name="TextElement"/>
-      </oneOrMore>
+      <ref name="Designation"/>
     </element>
   </define>
   <define name="related">
     <element name="related">
+      <attribute name="type">
+        <ref name="RelatedTermType"/>
+      </attribute>
+      <element name="preferred">
+        <ref name="Designation"/>
+      </element>
+      <choice>
+        <ref name="eref"/>
+        <ref name="xref"/>
+        <ref name="termref"/>
+      </choice>
+    </element>
+  </define>
+  <define name="RelatedTermType">
+    <choice>
+      <value>deprecates</value>
+      <value>supersedes</value>
+      <value>narrower</value>
+      <value>broader</value>
+      <value>equivalent</value>
+      <value>compare</value>
+      <value>contrast</value>
+      <value>see</value>
+    </choice>
+  </define>
+  <define name="deprecates">
+    <element name="deprecates">
+      <ref name="Designation"/>
+    </element>
+  </define>
+  <define name="Designation">
+    <optional>
+      <attribute name="absent">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="geographicArea"/>
+    </optional>
+    <choice>
+      <ref name="expression_designation"/>
+      <ref name="letter_symbol_designation"/>
+      <ref name="graphical_symbol_designation"/>
+    </choice>
+    <zeroOrMore>
+      <ref name="termsource"/>
+    </zeroOrMore>
+  </define>
+  <define name="letter_symbol_designation">
+    <element name="letter-symbol">
       <optional>
-        <attribute name="type">
+        <attribute name="isInternational">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <element name="name">
+        <oneOrMore>
           <choice>
-            <value>compare</value>
-            <value>contrast</value>
-            <value>see</value>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
           </choice>
+        </oneOrMore>
+      </element>
+    </element>
+  </define>
+  <define name="graphical_symbol_designation">
+    <element name="graphical-symbol">
+      <optional>
+        <attribute name="isInternational">
+          <data type="boolean"/>
         </attribute>
       </optional>
-      <oneOrMore>
-        <ref name="TextElement"/>
-      </oneOrMore>
+      <ref name="figure"/>
     </element>
   </define>
-  <define name="deprecates">
-    <element name="deprecates">
-      <oneOrMore>
-        <ref name="TextElement"/>
-      </oneOrMore>
+  <define name="expression_designation">
+    <element name="expression">
+      <optional>
+        <attribute name="language">
+          <a:documentation>ISO-639</a:documentation>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="script">
+          <a:documentation>ISO-15924</a:documentation>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="type">
+          <ref name="ExpressionDesignationType"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="isInternational">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <element name="name">
+        <zeroOrMore>
+          <ref name="PureTextElement"/>
+        </zeroOrMore>
+      </element>
+      <optional>
+        <element name="abbreviationType">
+          <ref name="AbbreviationType"/>
+        </element>
+      </optional>
+      <optional>
+        <element name="pronunciation">
+          <ref name="LocalizedString"/>
+        </element>
+      </optional>
+      <optional>
+        <element name="grammarInfo">
+          <ref name="Grammar"/>
+        </element>
+      </optional>
     </element>
   </define>
+  <define name="ExpressionDesignationType">
+    <choice>
+      <value>prefix</value>
+      <value>suffix</value>
+      <value>abbreviation</value>
+      <value>full</value>
+    </choice>
+  </define>
+  <define name="AbbreviationType">
+    <choice>
+      <value>truncation</value>
+      <value>acronym</value>
+      <value>initialism</value>
+    </choice>
+  </define>
+  <define name="Grammar">
+    <zeroOrMore>
+      <element name="gender">
+        <ref name="GrammarGender"/>
+      </element>
+    </zeroOrMore>
+    <optional>
+      <element name="isPreposition">
+        <data type="boolean"/>
+      </element>
+    </optional>
+    <optional>
+      <element name="isParticiple">
+        <data type="boolean"/>
+      </element>
+    </optional>
+    <optional>
+      <element name="isAdjective">
+        <data type="boolean"/>
+      </element>
+    </optional>
+    <optional>
+      <element name="isVerb">
+        <data type="boolean"/>
+      </element>
+    </optional>
+    <optional>
+      <element name="isAdverb">
+        <data type="boolean"/>
+      </element>
+    </optional>
+    <optional>
+      <element name="isNoun">
+        <data type="boolean"/>
+      </element>
+    </optional>
+    <zeroOrMore>
+      <element name="grammarvalue">
+        <text/>
+      </element>
+    </zeroOrMore>
+  </define>
+  <define name="GrammarGender">
+    <choice>
+      <value>masculine</value>
+      <value>feminine</value>
+      <value>neuter</value>
+      <value>common</value>
+    </choice>
+  </define>
   <define name="termdomain">
     <element name="domain">
       <oneOrMore>
@@ -1872,18 +2034,47 @@
       </oneOrMore>
     </element>
   </define>
-  <define name="termgrammar">
-    <element name="grammar">
+  <define name="termsubject">
+    <element name="subject">
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>
     </element>
   </define>
+  <define name="termusage">
+    <element name="usageinfo">
+      <oneOrMore>
+        <ref name="BasicBlock"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="termdefinition">
     <element name="definition">
+      <choice>
+        <ref name="verbaldefinition"/>
+        <ref name="nonverbalrep"/>
+        <group>
+          <ref name="verbaldefinition"/>
+          <ref name="nonverbalrep"/>
+        </group>
+      </choice>
+    </element>
+  </define>
+  <define name="verbaldefinition">
+    <element name="verbaldefinition">
+      <oneOrMore>
+        <ref name="paragraph"/>
+      </oneOrMore>
+      <zeroOrMore>
+        <ref name="termsource"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="nonverbalrep">
+    <element name="nonverbalrepresentation">
       <oneOrMore>
         <choice>
-          <ref name="paragraph"/>
+          <ref name="table"/>
           <ref name="figure"/>
           <ref name="formula"/>
         </choice>

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -28,32 +28,38 @@ module Asciidoctor
       # sleep need for windows because dot works in separate process and
       # plantuml process may finish earlier then dot, as result png file
       # maybe not created yet after plantuml finish
+      #
+      # # Warning: metanorma/metanorma-standoc#187
+      # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
+      # This is why we need to copy and then unlink.
       def self.generate_file(parent, reader)
         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})!"
+        run(umlfile, outfile) or
+          raise "No image output from PlantUML (#{umlfile}, #{outfile})!"
         umlfile.unlink
 
-        path = Pathname.new(localdir) + (imagesdir || "plantuml")
-        File.writable?(localdir) or raise "Destination path #{path} not writable for PlantUML!"
-        path.mkpath
-        File.writable?(path) or raise "Destination path #{path} not writable for PlantUML!"
-        # File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"
-
-        # Warning: metanorma/metanorma-standoc#187
-        # Windows Ruby 2.4 will crash if a Tempfile is "mv"ed.
-        # This is why we need to copy and then unlink.
+        path = path_prep(localdir, imagesdir)
         filename = File.basename(outfile.to_s)
-        FileUtils.cp(outfile, path) && outfile.unlink
+        FileUtils.cp(outfile, path) and outfile.unlink
 
         imagesdir ? filename : File.join(path, filename)
       end
 
+      def self.path_prep(localdir, imagesdir)
+        path = Pathname.new(localdir) + (imagesdir || "plantuml")
+        File.writable?(localdir) or
+          raise "Destination path #{path} not writable for PlantUML!"
+        path.mkpath
+        File.writable?(path) or
+          raise "Destination path #{path} not writable for PlantUML!"
+        # File.exist?(path) or raise "Destination path #{path} already exists for PlantUML!"
+        path
+      end
+
       def self.save_plantuml(_parent, reader, _localdir)
-        src = reader.source
-        reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
-          src = "@startuml\n#{src}\n@enduml\n"
+        src = prep_source(reader)
         /^@startuml (?<fn>[^\n]+)\n/ =~ src
         Tempfile.open(["plantuml", ".pml"], encoding: "utf-8") do |f|
           f.write(src)
@@ -62,6 +68,15 @@ module Asciidoctor
         end
       end
 
+      def self.prep_source(reader)
+        src = reader.source
+        reader.lines.first.sub(/\s+$/, "").match /^@startuml($| )/ or
+          src = "@startuml\n#{src}\n@enduml\n"
+        %r{@enduml\s*$}m.match?(src) or
+          raise "@startuml without matching @enduml in PlantUML!"
+        src
+      end
+
       def self.generate_attrs(attrs)
         %w(id align float title role width height alt)
           .inject({}) do |memo, key|

data/lib/asciidoctor/standoc/macros_terms.rb

@@ -2,6 +2,18 @@ require "csv"
 
 module Asciidoctor
   module Standoc
+    class PreferredTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :preferred
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<preferred><expression><name>#{out}</name></expression></preferred>}
+      end
+    end
+
     class AltTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :alt
@@ -9,8 +21,9 @@ module Asciidoctor
       using_format :short
 
       def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<admitted>#{out}</admitted>}
+        out = Asciidoctor::Inline.new(parent, :quoted,
+                                      attrs["text"]).convert
+        %{<admitted><expression><name>#{out}</name></expression></admitted>}
       end
     end
 
@@ -21,8 +34,9 @@ module Asciidoctor
       using_format :short
 
       def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
-        %{<deprecates>#{out}</deprecates>}
+        out = Asciidoctor::Inline.new(parent, :quoted,
+                                      attrs["text"]).convert
+        %{<deprecates><expression><name>#{out}</name></expression></deprecates>}
       end
     end
 
@@ -33,7 +47,8 @@ module Asciidoctor
       using_format :short
 
       def process(parent, _target, attrs)
-        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        out = Asciidoctor::Inline.new(parent, :quoted,
+                                      attrs["text"]).convert
         %{<domain>#{out}</domain>}
       end
     end
@@ -133,5 +148,34 @@ module Asciidoctor
         raise("processing {{#{target}}}: #{e.message}")
       end
     end
+
+    # Possibilities:
+    # related:relation[<<id>>, term]
+    # related:relation[<<termbase:id>>, term]
+    # related:relation[term] equivalent to a crossreference to term:[term]
+    class RelatedTermInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :related
+      parse_content_as :text
+
+      def preprocess_attrs(target)
+        m = /^(?<id>&lt;&lt;.+?&gt;&gt;, ?)?(?<rest>.*)$/.match(target)
+        { id: m[:id]&.sub(/^&lt;&lt;/, "")&.sub(/&gt;&gt;, ?$/, ""),
+          term: m[:rest] }
+      end
+
+      def process(parent, target, attrs)
+        out = preprocess_attrs(attrs["text"])
+        term = Asciidoctor::Inline.new(parent, :quoted,
+                                       out[:term]).convert
+        if out[:id] then "<related type='#{target}' key='#{out[:id]}'>"\
+          "<refterm>#{term}</refterm></related>"
+        else "<related type='#{target}'><termxref>#{term}</termxref>"\
+          "<xrefrender>#{term}</xrefrender></related>"
+        end
+      rescue StandardError => e
+        raise("processing related:#{target}[#{attrs['text']}]: #{e.message}")
+      end
+    end
   end
 end

data/lib/asciidoctor/standoc/ref_sect.rb

@@ -16,16 +16,14 @@ module Asciidoctor
       end
 
       def bibliography_parse(attrs, xml, node)
-        node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
-        node.attr("style") == "bibliography" or
-          @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
+        x = biblio_prep(attrs, xml, node) and return x
         @biblio = true
-        xml.references **attr_code(attrs.merge(
-          normative: node.attr("normative") || false)) do |xml_section|
-            xml_section.title { |t| t << node.title }
-            xml_section << node.content
-          end
-          @biblio = false
+        attrs = attrs.merge(normative: node.attr("normative") || false)
+        xml.references **attr_code(attrs) do |xml_section|
+          xml_section.title { |t| t << node.title }
+          xml_section << node.content
+        end
+        @biblio = false
       end
 
       def bibitem_parse(attrs, xml, node)
@@ -39,9 +37,7 @@ module Asciidoctor
       end
 
       def norm_ref_parse(attrs, xml, node)
-        node.option? "bibitem" and return bibitem_parse(attrs, xml, node)
-        node.attr("style") == "bibliography" or
-          @log.add("AsciiDoc Input", node, "Section not marked up as [bibliography]!")
+        x = biblio_prep(attrs, xml, node) and return x
         @norm_ref = true
         attrs = attrs.merge(normative: node.attr("normative") || true)
         xml.references **attr_code(attrs) do |xml_section|
@@ -51,6 +47,17 @@ module Asciidoctor
         @norm_ref = false
       end
 
+      def biblio_prep(attrs, xml, node)
+        if node.option? "bibitem"
+          bibitem_parse(attrs, xml, node)
+        else
+          node.attr("style") == "bibliography" or
+            @log.add("AsciiDoc Input", node,
+                     "Section not marked up as [bibliography]!")
+          nil
+        end
+      end
+
       def global_ievcache_name
         "#{Dir.home}/.iev/cache"
       end
@@ -74,7 +81,7 @@ module Asciidoctor
         xml
       rescue RelatonBib::RequestError
         @log.add("Bibliography", nil, "Could not retrieve #{code}: "\
-                 "no access to online site")
+                                      "no access to online site")
         nil
       end
 
@@ -87,10 +94,10 @@ module Asciidoctor
         unless xml.at("/bibitem/title[text()]")
           @log.add("Bibliography", nil,
                    "ERROR: No title retrieved for #{code}")
-          xml.root << "<title>#{title || "(MISSING TITLE)"}</title>"
+          xml.root << "<title>#{title || '(MISSING TITLE)'}</title>"
         end
         usrlbl and xml.at("/bibitem/docidentifier").next =
-          "<docidentifier type='metanorma'>#{mn_code(usrlbl)}</docidentifier>"
+                     "<docidentifier type='metanorma'>#{mn_code(usrlbl)}</docidentifier>"
       end
 
       def smart_render_xml(xml, code, opts)
@@ -113,7 +120,7 @@ module Asciidoctor
         @bibdb = Relaton::DbCache.init_bib_caches(
           local_cache: local,
           flush_caches: node.attr("flush-caches"),
-          global_cache: global
+          global_cache: global,
         )
       end
 
@@ -128,7 +135,7 @@ module Asciidoctor
             FileUtils.rm_f @iev_localname unless @iev_localname.nil?
           end
         end
-        #@iev = Iev::Db.new(globalname, localname) unless @no_isobib
+        # @iev = Iev::Db.new(globalname, localname) unless @no_isobib
       end
     end
   end