metanorma-standoc 2.10.5 → 3.0.2

data/lib/isodoc/html/htmlstyle.scss

@@ -29,7 +29,7 @@ $docstage-colors-list: (
   retired: #2E382E
 );
 
-@import 'base_style/all';
+@use 'base_style/all' as *;
 
 /*
     1. HTML & Body
@@ -92,24 +92,6 @@ nav {
   @include sidebarNavToggle(white, #C70039)
 }
 
-@media screen and (min-width: 768px) {
-  .container {
-    padding-left: 360px;
-  }
-
-  .rule.toc {
-    display: none;
-  }
-
-  h1.toc-contents {
-    margin-top: 1em;
-  }
-
-  ul#toc-list, ul#toc-list > :is(.h1, .h2, .h3, .h4, .h5, .h6) {
-    padding: 0;
-    margin: 0;
-  }
-}
 
 div.figure {
   @include figureBlock();
@@ -643,6 +625,27 @@ To top button
   margin: 2cm 1cm;
 }
 
+
+@media screen and (min-width: 768px) {
+  .container {
+    padding-left: 360px;
+  }
+
+  .rule.toc {
+    display: none;
+  }
+
+  h1.toc-contents {
+    margin-top: 1em;
+  }
+
+  ul#toc-list, ul#toc-list > :is(.h1, .h2, .h3, .h4, .h5, .h6) {
+    padding: 0;
+    margin: 0;
+  }
+}
+
+
 @media print {
   .document-info,  nav, .copyright {
       page-break-before: always;

data/lib/metanorma/standoc/base.rb

@@ -11,21 +11,31 @@ require_relative "localbib"
 require_relative "init"
 require "mn-requirements"
 
+require 'set'
+
+module Asciidoctor
+  module Compliance
+    ADMONITION_STYLES.add('EDITOR') unless ADMONITION_STYLES.include?('EDITOR')
+  end
+end
+
 module Metanorma
   module Standoc
     module Base
-      XML_ROOT_TAG = "standard-document".freeze
-      XML_NAMESPACE = "https://www.metanorma.org/ns/standoc".freeze
+      #XML_ROOT_TAG = "standard-document".freeze
+      #XML_NAMESPACE = "https://www.metanorma.org/ns/standoc".freeze
       FONTS_MANIFEST = "fonts-manifest".freeze
 
       attr_accessor :log
 
       def xml_root_tag
-        self.class::XML_ROOT_TAG
+        #self.class::XML_ROOT_TAG
+        "metanorma"
       end
 
       def xml_namespace
-        self.class::XML_NAMESPACE
+        #self.class::XML_NAMESPACE
+        "https://www.metanorma.org/ns/standoc"
       end
 
       def document(node)
@@ -87,7 +97,8 @@ module Metanorma
       def makexml1(node)
         result = ["<?xml version='1.0' encoding='UTF-8'?>",
                   "<#{xml_root_tag} type='semantic' version='#{version}' " \
-                  "schema-version='#{schema_version}'>"]
+                  "schema-version='#{schema_version}' " \
+                  "flavor='#{processor.new.asciidoctor_backend}'>"]
         result << noko { |ixml| front node, ixml }
         result << noko { |ixml| middle node, ixml }
         result << "</#{xml_root_tag}>"

data/lib/metanorma/standoc/basicdoc.rng

@@ -599,17 +599,9 @@ It is included for convenience, in case processing the citation to extract the a
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -628,17 +620,9 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -651,6 +635,20 @@ and is intended to be referenced by a callout within the source code</a:document
       </ref>
     </zeroOrMore>
   </define>
+  <define name="sourcecodebody">
+    <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+    <element name="body">
+      <oneOrMore>
+        <choice>
+          <text/>
+          <ref name="callout">
+            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+          </ref>
+        </choice>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="pre">
     <a:documentation>Pre-formatted block. Wrapper for text to be rendered with fixed-width typeface, and preserving spaces including line breaks. 
 They are intended for a restricted number of functions, most typically ASCII Art (which is still in prominent use in some 
@@ -1672,18 +1670,25 @@ which can be bookmarks as well as block or section references</a:documentation>
     </optional>
   </define>
   <define name="XrefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="ErefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement">
+            <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+          </ref>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="fn">
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as a footnote.

data/lib/metanorma/standoc/biblio.rng

@@ -947,6 +947,8 @@ May be electronic (e.g. Twitter direct message, email) or voice (e.g. a remark m
 typically cited as "personal communication")</a:documentation>
       <value>conversation</value>
       <a:documentation>An exchange of messages between two or more persons. May be electronic (e.g. web chat) or voice (e.g. phone call)</a:documentation>
+      <value>collection</value>
+      <a:documentation>A compound resource consisting of other resources, which are themselves presupposed to have their type specified..</a:documentation>
       <value>misc</value>
       <a:documentation>Bibliographic type not adequately described in the foregoing</a:documentation>
     </choice>

data/lib/metanorma/standoc/blocks.rb

@@ -201,7 +201,9 @@ module Metanorma
         fragment = ::Nokogiri::XML::Builder.new do |xml|
           xml.sourcecode **listing_attrs(node) do |s|
             figure_title(node, s)
-            s << node.content
+            s.body do |b|
+              b << node.content
+            end
           end
         end
         fragment.to_xml(encoding: "US-ASCII", save_with:

data/lib/metanorma/standoc/blocks_notes.rb

@@ -90,8 +90,10 @@ module Metanorma
       end
 
       def admonition_name(node)
-        ret = node.attr("type") || node.attr("name")
-        ret&.downcase
+        ret = node.attr("type") || node.attr("name") or return
+        ret = ret.downcase
+        ret == "editor" and ret = "editorial"
+        ret
       end
 
       def admonition(node)

data/lib/metanorma/standoc/cleanup_bibdata.rb

@@ -132,7 +132,7 @@ module Metanorma
           bibdata = bibdata.at("./relation[@type = 'derivedFrom']/bibitem")
           ident = bibdata.at("./docidentifier[@primary = 'true']") ||
             bibdata.at("./docidentifier")
-          xmldoc.xpath("//xref[@target = '#{d}'][normalize-space(text()) = '']")
+          xmldoc.xpath("//xref[@target = '#{d}'][normalize-space(.//text()) = '']")
             .each { |x| x << ident.text }
         end
       end

data/lib/metanorma/standoc/cleanup_block.rb

@@ -119,8 +119,8 @@ module Metanorma
 
       def align_callouts_to_annotations(xmldoc)
         xmldoc.xpath("//sourcecode").each do |x|
-          callouts = x.elements.select { |e| e.name == "callout" }
-          annotations = x.elements.select { |e| e.name == "annotation" }
+          callouts = x.xpath("./body/callout")
+          annotations = x.xpath("./annotation")
           callouts.size == annotations.size and
             link_callouts_to_annotations(callouts, annotations)
         end
@@ -163,7 +163,7 @@ module Metanorma
           acc << safe_noko(a[0], node.document)
           a.size == 4 or next
           acc << Asciidoctor.convert(
-            a[2], doctype: :inline, backend: self&.backend&.to_sym || :standoc
+            a[2], doctype: :inline, backend: backend&.to_sym || :standoc
           )
         end.join
       end

data/lib/metanorma/standoc/cleanup_boilerplate.rb

@@ -46,7 +46,7 @@ module Metanorma
         xmldoc.at("//metanorma-extension/semantic-metadata/" \
                   "headless[text() = 'true']") and return nil
         x = xmldoc.dup
-        x.root.add_namespace(nil, self.class::XML_NAMESPACE)
+        x.root.add_namespace(nil, xml_namespace)
         xml = Nokogiri::XML(x.to_xml)
         @isodoc ||= isodoc(@lang, @script, @locale)
         @isodoc.info(xml, nil)

data/lib/metanorma/standoc/cleanup_toc.rb

@@ -56,7 +56,7 @@ module Metanorma
         elsif depth < entry[:depth]
           ret += "<li><ul>" * (entry[:depth] - depth)
         end
-        ret + "<li><xref target='#{entry[:target]}'>#{entry[:text]}</xref></li>"
+        ret + "<li><xref target='#{entry[:target]}'><display-text>#{entry[:text]}</display-text></xref></li>"
       end
 
       def toc_cleanup_clause(xmldoc)
@@ -70,10 +70,10 @@ module Metanorma
       end
 
       def toc_cleanup_clause_entry(xmldoc, list)
-        list.xpath(".//xref[not(text())]").each do |x|
+        list.xpath(".//xref[not(text())][not(display-text)]").each do |x|
           c1 = xmldoc.at("//*[@id = '#{x['target']}']")
           t = c1.at("./variant-title[@type = 'toc']") || c1.at("./title")
-          x << t.dup.children
+          x << "<display-text>#{to_xml(t.dup.children)}</display-text>"
         end
       end
 

data/lib/metanorma/standoc/cleanup_xref.rb

@@ -35,11 +35,12 @@ module Metanorma
       def extract_localities(elem)
         elem.children.empty? and return
         f = elem.children.first
-        f.text? or return
+        f.text? or return xref_display_text(elem, elem.children.remove)
         head = f.remove.text
         tail = elem.children.remove
-        extract_localities1(elem, head)
-        tail and elem << tail
+        d = extract_localities1(elem, head)
+        tail and d << tail
+        d.children.empty? and d.remove
       end
 
       LOCALITY_REGEX_STR_TRIPLEDASH = <<~REGEXP.freeze
@@ -69,7 +70,13 @@ module Metanorma
           b = elem.add_child("<localityStack/>").first if m[:punct] == ";"
         end
         fill_in_eref_connectives(elem)
-        elem.add_child(text) if text
+        xref_display_text(elem, text)
+      end
+
+      def xref_display_text(elem, text)
+        d = elem.add_child("<display-text></display-text>").first
+        d.add_child(text) if text
+        d
       end
 
       # clause=3;and!5 => clause=3;and!clause=5
@@ -135,6 +142,9 @@ module Metanorma
       end
 
       def eref_stack(xmldoc)
+        xmldoc.xpath("//eref/display-text[eref]").each do |e|
+          e.replace(e.children)
+        end
         xmldoc.xpath("//eref[eref]").each do |e|
           e.name = "erefstack"
           e.delete("bibitemid")
@@ -196,6 +206,11 @@ module Metanorma
         xmldoc.xpath("//xref//xref").each do |x|
           x.name = "location"
         end
+        xmldoc.xpath("//xref[not(./display-text)]").each do |x|
+          c = x.xpath("./*[not(self::locality or self::localityStack or self::location)] | ./text()")
+          c.empty? and next
+          xref_display_text(x, c.remove)
+        end
       end
 
       def xref_cleanup1(xmldoc)

data/lib/metanorma/standoc/converter.rb

@@ -23,10 +23,8 @@ module Metanorma
       Asciidoctor::Extensions.register do
         preprocessor Metanorma::Standoc::ResolveIncludePreprocessor
         preprocessor Metanorma::Plugin::Lutaml::LutamlPreprocessor
-        preprocessor Metanorma::Plugin::Lutaml::LutamlUmlAttributesTablePreprocessor
         preprocessor Metanorma::Plugin::Lutaml::LutamlUmlDatamodelDescriptionPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::LutamlEaXmiPreprocessor
-        preprocessor Metanorma::Plugin::Lutaml::LutamlUmlClassPreprocessor
         inline_macro Metanorma::Plugin::Lutaml::LutamlFigureInlineMacro
         inline_macro Metanorma::Plugin::Lutaml::LutamlTableInlineMacro
         block_macro Metanorma::Plugin::Lutaml::LutamlDiagramBlockMacro

data/lib/metanorma/standoc/front.rb

@@ -217,9 +217,9 @@ module Metanorma
         ["en"].each do |lang|
           at = { language: lang, format: "text/plain" }
           xml.title **attr_code(at) do |t|
-            title = Metanorma::Utils::asciidoc_sub(node.attr("title") ||
-                                                 node.attr("title-en"))
-            t << (title || node.title)
+            title = Metanorma::Utils::asciidoc_sub(
+              node.attr("title") || node.attr("title-en") || node.attr("doctitle"))
+            t << title
           end
         end
       end

data/lib/metanorma/standoc/isodoc-compile.rng

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar ns="https://www.metanorma.org/ns/standoc" xmlns="http://relaxng.org/ns/structure/1.0">
-  <!-- default namespace isostandard = "https://www.metanorma.com/ns/iso" -->
   <include href="biblio-standoc.rng"/>
   <include href="isodoc.rng"/>
 </grammar>

data/lib/metanorma/standoc/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v1.4.1 -->
+<!-- VERSION v2.0.0 -->
 <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">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -245,23 +245,9 @@
           <a:documentation>The caption of the block</a:documentation>
         </ref>
       </optional>
-      <oneOrMore>
-        <choice>
-          <text>
-            <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-          </text>
-          <ref name="callout">
-            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-          </ref>
-          <ref name="xref">
-            <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
-          </ref>
-          <ref name="eref">
-            <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
-          </ref>
-        </choice>
-      </oneOrMore>
+      <ref name="sourcecodebody">
+        <a:documentation>The sourcecode content</a:documentation>
+      </ref>
       <zeroOrMore>
         <ref name="annotation">
           <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -277,6 +263,26 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>A source for the block</a:documentation>
       </ref>
     </define>
+    <define name="sourcecodebody">
+      <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+      <element name="body">
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="callout">
+              <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+            </ref>
+            <ref name="xref">
+              <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
+            </ref>
+            <ref name="eref">
+              <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
+            </ref>
+          </choice>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="sections">
       <element name="sections">
         <oneOrMore>
@@ -459,11 +465,14 @@ gives an explicit page orientation</a:documentation>
           <a:documentation>Description of location in a reference, which can be combined with other locations in a single citation</a:documentation>
         </ref>
       </zeroOrMore>
-      <zeroOrMore>
-        <ref name="PureTextElement">
+      <optional>
+        <element name="display-text">
           <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-        </ref>
-      </zeroOrMore>
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
     </define>
   </include>
   <!-- end overrides -->
@@ -1205,10 +1214,13 @@ numbers</a:documentation>
         <value>presentation</value>
       </choice>
     </attribute>
+    <attribute name="flavor">
+      <a:documentation>Metanorma flavor, indicating SDO whose requiremnts the realisation aligns to</a:documentation>
+    </attribute>
   </define>
   <define name="standard-document">
     <a:documentation>Representation of a standardisation document</a:documentation>
-    <element name="standard-document">
+    <element name="metanorma">
       <ref name="Root-Attributes"/>
       <ref name="bibdata">
         <a:documentation>Bibliographic description of the document itself, expressed in the Relaton model</a:documentation>

data/lib/metanorma/standoc/macros_note.rb

@@ -44,6 +44,7 @@ module Metanorma
       on_contexts :example, :paragraph
 
       def process(parent, reader, attrs)
+        require "debug"; binding.b
         attrs["name"] = "editorial"
         attrs["caption"] = "EDITOR"
         create_block(parent, :admonition, reader.lines, attrs,

data/lib/metanorma/standoc/validate_section.rb

@@ -11,8 +11,8 @@ module Metanorma
 
       def sourcecode_style(root)
         root.xpath("//sourcecode").each do |x|
-          callouts = x.elements.select { |e| e.name == "callout" }
-          annotations = x.elements.select { |e| e.name == "annotation" }
+          callouts = x.xpath("./body/callout")
+          annotations = x.xpath("./annotation")
           callouts_error(x, callouts, annotations)
         end
       end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.10.5".freeze
+    VERSION = "3.0.2".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "asciidoctor", "~> 2.0.0"
   spec.add_dependency "crass", "~> 1.0.0"
   spec.add_dependency "iev", "~> 0.3.5"
-  spec.add_dependency "isodoc", "~> 2.12.4"
+  spec.add_dependency "isodoc", "~> 3.1.0"
   spec.add_dependency "metanorma", ">= 1.6.0"
   spec.add_dependency "metanorma-plugin-datastruct", "~> 0.3.0"
   spec.add_dependency "metanorma-plugin-glossarist", "~> 0.2.0"
@@ -54,7 +54,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 1.5.2"
-  spec.add_development_dependency "sassc", "2.4.0"
+  spec.add_development_dependency "sassc-embedded", "~> 1"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "vcr", "~> 6.1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 2.10.5
+  version: 3.0.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-20 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.4
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.4
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: metanorma
   requirement: !ruby/object:Gem::Requirement
@@ -347,19 +347,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.5.2
 - !ruby/object:Gem::Dependency
-  name: sassc
+  name: sassc-embedded
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.4.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -605,7 +605,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: metanorma-standoc realises standards following the Metanorma standoc model