metanorma-generic 1.11.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68780e456b59524a58f5943a2f611eb77eb8609d71d67d0fd03493845bd77a26
-  data.tar.gz: d80def3233b10b107eae9159b981755486555782962d5ab48ef8dfbd5f476e53
+  metadata.gz: 5fa88f0baa395e56b19c26fbeb278c4b4424368d23c20282d1d41e1c2b0adfff
+  data.tar.gz: c0ca25b62c407cd76125ecba1a97e48557b4f90adf31eb34841ba1dee94a3657
 SHA512:
-  metadata.gz: 2e583a0c09780c638708932e53c6d625f291650ad66cbc0c15aad3eb8fce7f1bc728e6503b7b2c7c531558da48fd305c4575541255f501cfd68a391ab775fd17
-  data.tar.gz: 0c937c51fc767624d6c05d2d74e409a8128b4c45d57da929bed48cf301be47b5897ecff6632219bb1532b785cce3cf707686568f42e9b6c2651ea65db27cd6a5
+  metadata.gz: 2ab1796a867d326954a8e42668b77bf7b26febe4bc658d44a2f8ddab232c18834911cca7b4b7225bddffbe429d553aea5484fdb50db35f6f0adbcc9758d3e4ca
+  data.tar.gz: 9658b9faf8d7c0d70b65c8d0458534809acf4744401ec9ff899512dd3db04a94706fa25c983befe7aa633aca525a5f2ab3589426ba0b9fd48c497ba5d3f71c64

data/.github/workflows/rake.yml

@@ -9,35 +9,7 @@ on:
   pull_request:
 
 jobs:
-  rake:
-    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.experimental }}
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - run: bundle exec rake
-
-  tests-passed:
-    needs: rake
-    runs-on: ubuntu-latest
-    steps:
-      - uses: peter-evans/repository-dispatch@v1
-        with:
-          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          repository: ${{ github.repository }}
-          event-type: tests-passed
-          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+  notify:
+    uses: metanorma/metanorma-build-scripts/.github/workflows/mn-processor-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.gitignore

@@ -1,3 +1,13 @@
 .DS_Store
 
 .rubocop-https--*
+
+/.rspec_status
+/Gemfile.devel
+/Gemfile.lock
+/coverage/
+/test.doc
+/test.err
+/test.html
+/test.pdf
+/test.presentation.xml

data/README.adoc

@@ -31,7 +31,7 @@ Metanorma::Generic.configure do |config|
   config.document_namespace = 'https://open.ribose.com/standards/mine'
   config.xml_root_tag = 'mine-standard'
   config.logo_path = '/metanorma-mine/lib/isodoc/mine/html/logo.jpg'
-  config.validate_rng_file = '/metanorma-mine/lib/asciidoctor/mine/mine.rng'
+  config.validate_rng_file = '/metanorma-mine/lib/metanorma/mine/mine.rng'
   config.htmlcoverpage = '/metanorma-mine/lib/isodoc/mine/html/html_mine_titlepage.html'
   config.htmlintropage = '/metanorma-mine/lib/isodoc/mine/html/html_mine_intro.html'
   config.htmlstylesheet = '/metanorma-mine/lib/isodoc/mine/html/htmlstyle.scss'

data/lib/asciidoctor/generic/converter.rb

@@ -1,183 +1,3 @@
-require "asciidoctor"
-require "asciidoctor/standoc/converter"
-require "fileutils"
-require_relative "front"
+require "asciidoctor/generic/deprecated"
+require "metanorma/generic/converter"
 
-module Asciidoctor
-  module Generic
-    class Converter < Standoc::Converter
-      XML_ROOT_TAG = "generic-standard".freeze
-      XML_NAMESPACE = "https://www.metanorma.org/ns/generic".freeze
-
-      register_for "generic"
-
-      def xml_root_tag
-        configuration.xml_root_tag || XML_ROOT_TAG
-      end
-
-      def xml_namespace
-        configuration.document_namespace || XML_NAMESPACE
-      end
-
-      def baselocation(loc)
-        return nil if loc.nil?
-
-        return loc
-        File.expand_path(File.join(File.dirname(
-                                     self.class::_file || __FILE__,
-                                   ), "..", "..", "..", loc))
-      end
-
-      def docidentifier_cleanup(xmldoc)
-        template = configuration.docid_template ||
-          "{{ organization_name_short }} {{ docnumeric }}"
-        docid = xmldoc.at("//bibdata/docidentifier")
-        id = boilerplate_isodoc(xmldoc).populate_template(template, nil)
-        id.empty? and docid.remove or docid.children = id
-      end
-
-      def doctype(node)
-        d = super
-        configuration.doctypes or return d == "article" ?
-          (configuration.default_doctype || "standard") : d
-        type = configuration.default_doctype ||
-          configuration.doctypes.keys.dig(0) || "standard"
-        unless configuration.doctypes.keys.include? d
-          @log.add("Document Attributes", nil,
-                   "#{d} is not a legal document type: reverting to '#{type}'")
-          d = type
-        end
-        d
-      end
-
-      def read_config_file(path_to_config_file)
-        Metanorma::Generic.configuration
-          .set_default_values_from_yaml_file(path_to_config_file)
-      end
-
-      def sectiontype_streamline(ret)
-        if configuration&.termsdefs_titles&.map(&:downcase)&.include? ret
-          "terms and definitions"
-        elsif configuration&.symbols_titles&.map(&:downcase)&.include? ret
-          "symbols and abbreviated terms"
-        elsif configuration&.normref_titles&.map(&:downcase)&.include? ret
-          "normative references"
-        elsif configuration&.bibliography_titles&.map(&:downcase)&.include? ret
-          "bibliography"
-        else
-          ret
-        end
-      end
-
-      def document(node)
-        read_config_file(node.attr("customize")) if node.attr("customize")
-        super
-      end
-
-      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")
-      end
-
-      def validate(doc)
-        content_validate(doc)
-        schema_validate(formattedstr_strip(doc.dup),
-                        baselocation(configuration.validate_rng_file) ||
-                        File.join(File.dirname(__FILE__), "generic.rng"))
-      end
-
-      def content_validate(doc)
-        super
-        bibdata_validate(doc.root)
-      end
-
-      def bibdata_validate(doc)
-        stage_validate(doc)
-        committee_validate(doc)
-      end
-
-      def stage_validate(xmldoc)
-        stages = configuration&.stage_abbreviations&.keys || return
-        stages.empty? and return
-        stage = xmldoc&.at("//bibdata/status/stage")&.text
-        stages.include? stage or
-          @log.add("Document Attributes", nil,
-                   "#{stage} is not a recognised status")
-      end
-
-      def committee_validate(xmldoc)
-        committees = Array(configuration&.committees) || return
-        committees.empty? and return
-        xmldoc.xpath("//bibdata/ext/editorialgroup/committee").each do |c|
-          committees.include? c.text or
-            @log.add("Document Attributes", nil,
-                     "#{c.text} is not a recognised committee")
-        end
-      end
-
-      def sections_cleanup(xml)
-        super
-        xml.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
-        end
-      end
-
-      def blank_method(*args); end
-
-      def html_converter(node)
-        IsoDoc::Generic::HtmlConvert.new(html_extract_attributes(node))
-      end
-
-      def presentation_xml_converter(node)
-        IsoDoc::Generic::PresentationXMLConvert
-          .new(html_extract_attributes(node))
-      end
-
-      alias_method :pdf_converter, :html_converter
-      alias_method :style, :blank_method
-      alias_method :title_validate, :blank_method
-
-      def doc_converter(node)
-        IsoDoc::Generic::WordConvert.new(doc_extract_attributes(node))
-      end
-
-      def configuration
-        Metanorma::Generic.configuration
-      end
-
-      def boilerplate_isodoc(xmldoc)
-        conv = super
-        Metanorma::Generic::Configuration::CONFIG_ATTRS.each do |a|
-          conv.meta.set(a, configuration.send(a))
-        end
-        conv
-      end
-
-      def boilerplate_file(xmldoc)
-        f = configuration.boilerplate
-        f.nil? and return super
-        f.is_a? String and return baselocation(f)
-        f.is_a? Hash and f[@lang] and return baselocation(f[@lang])
-        super
-      end
-
-      def cleanup(xmldoc)
-        super
-        empty_metadata_cleanup(xmldoc)
-        xmldoc
-      end
-
-      def empty_metadata_cleanup(xmldoc)
-        xmldoc.xpath("//bibdata/ext//*").each do |x|
-          x.remove if x.children.empty?
-        end
-      end
-    end
-  end
-end

data/lib/asciidoctor/generic/deprecated.rb

@@ -0,0 +1,5 @@
+warn "Please replace your references to Asciidoctor::Generic with Metanorma::Generic and your instances of require 'asciidoctor/generic' with require 'metanorma/generic'"
+
+exit 127 if ENV['METANORMA_DEPRECATION_FAIL']
+
+Asciidoctor::Generic = Metanorma::Generic unless defined? Asciidoctor::Generic

data/lib/asciidoctor/generic/front.rb

@@ -1,108 +1,3 @@
-module Asciidoctor
-  module Generic
-    class Converter < Standoc::Converter
-      def default_publisher
-        configuration.organization_name_long
-      end
+require "asciidoctor/generic/deprecated"
+require "metanorma/generic/front"
 
-      def org_abbrev
-        if !configuration.organization_name_long.empty? &&
-            !configuration.organization_name_short.empty? &&
-            configuration.organization_name_long !=
-            configuration.organization_name_short
-          { configuration.organization_name_long =>
-            configuration.organization_name_short }
-        else
-          super
-        end
-      end
-
-      def relaton_relations
-        Array(configuration.relations) || []
-      end
-
-      def metadata_committee(node, xml)
-        return unless node.attr("committee")
-        xml.editorialgroup do |a|
-          a.committee node.attr("committee"),
-            **attr_code(type: node.attr("committee-type"))
-          i = 2
-          while node.attr("committee_#{i}") do
-            a.committee node.attr("committee_#{i}"),
-              **attr_code(type: node.attr("committee-type_#{i}"))
-            i += 1
-          end
-        end
-      end
-
-      def metadata_status(node, xml)
-        xml.status do |s|
-          s.stage ( node.attr("status") || node.attr("docstage") ||
-                   configuration.default_stage || "published" )
-          x = node.attr("substage") and s.substage x
-          x = node.attr("iteration") and s.iteration x
-        end
-      end
-
-      def metadata_id(node, xml)
-        xml.docidentifier **{ type:
-                              configuration.organization_name_short } do |i|
-          i << "DUMMY"
-        end
-        xml.docnumber { |i| i << node.attr("docnumber") }
-      end
-
-      def metadata_ext(node, ext)
-        super
-        if configuration.metadata_extensions.is_a? Hash
-          metadata_ext_hash(node, ext, configuration.metadata_extensions)
-        else
-          Array(configuration.metadata_extensions).each do |e|
-            a = node.attr(e) and ext.send e, a
-          end
-        end
-      end
-
-      def metadata_doctype(node, xml)
-        d = doctype(node)
-        xml.doctype d, attr_code(abbreviation: configuration&.doctypes&.dig(d))
-      end
-
-      EXT_STRUCT = %w(_output _attribute _list).freeze
-
-      def metadata_ext_hash(node, ext, hash)
-        hash.each do |k, v|
-          next if EXT_STRUCT.include?(k) || !v&.is_a?(Hash) && !node.attr(k)
-          if v&.is_a?(Hash) && v["_list"]
-            csv_split(node.attr(k), ",").each do |val|
-              metadata_ext_hash1(k, val, ext, v, node)
-            end
-          else
-            metadata_ext_hash1(k, node.attr(k), ext, v, node)
-          end
-        end
-      end
-
-      def metadata_ext_hash1(key, value, ext, hash, node)
-        return if hash&.is_a?(Hash) && hash["_attribute"]
-        is_hash = hash&.is_a?(Hash) &&
-            !hash.keys.reject { |n| EXT_STRUCT.include?(n) }.empty?
-        return if !is_hash && (value.nil? || value.empty?)
-        name = hash&.is_a?(Hash) ? (hash["_output"] || key) : key
-        ext.send name, **attr_code(metadata_ext_attrs(hash, node)) do |e|
-            is_hash ? metadata_ext_hash(node, e, hash) : (e << value)
-        end
-      end
-
-      def metadata_ext_attrs(hash, node)
-        return {} unless hash.is_a?(Hash)
-        ret = {}
-        hash.each do |k, v|
-          next unless v.is_a?(Hash) && v["_attribute"]
-          ret[(v["_output"] || k).to_sym] = node.attr(k)
-        end
-        ret
-      end
-    end
-  end
-end

data/lib/asciidoctor/generic.rb

@@ -1,7 +1,3 @@
-require "asciidoctor/generic/converter"
+require "asciidoctor/generic/deprecated"
+require "metanorma/generic"
 
-module Asciidoctor
-  module Generic
-
-  end
-end

data/lib/isodoc/generic/html/htmlstyle.scss

@@ -16,7 +16,7 @@ body {
 
 main {margin: 0 3em 0 6em;}
 
-#toc {
+#toc, #toc > ul > :is(.h1, .h2, .h3, .h4, .h5, .h6) {
   @include toc(#485094, #1661AD, #485094);
   @include sidebarToc();
   .toc-active a {
@@ -33,6 +33,11 @@ main {margin: 0 3em 0 6em;}
   }
 }
 
+#toc > ul > :is(.h1, .h2, .h3, .h4, .h5, .h6) {
+   margin-top: 0;
+   margin-bottom: 0;
+ }
+
 nav {
   @include sidebarNav(#f7f7f7, 323px, 45px);
 }
@@ -66,7 +71,7 @@ nav {
       margin-top: 1em;
   }
 
-  ul#toc-list {
+  ul#toc-list, ul#toc-list > :is(.h1, .h2, .h3, .h4, .h5, .h6) {
       padding:0;
       margin:0;
   }
@@ -186,7 +191,7 @@ p.document-stage {
     3.1 Titles
 */
 
-h1,h2,h3,h4,h5,h6 {
+h1,h2,h3,h4,h5,h6,.h1,.h2,.h3,.h4,.h5,.h6 {
   font-family: $headerfont;
   color: #1661AD;
   font-weight: 300;
@@ -194,23 +199,23 @@ h1,h2,h3,h4,h5,h6 {
   margin-bottom: 0.3em;
 }
 
-h1 {
+h1,.h1 {
   font-size: 1.6em;
   text-transform: uppercase;
   margin-top: 2em;
 }
 
-h1#content {
+h1#content, .h1#content {
     margin-top: 2em;
 }
 
-h2 {
+h2,.h2 {
   margin-top: 1.3em;
   font-size: 1.3em;
   font-weight: 400;
 }
 
-h3 {
+h3,.h3 {
   margin-top: 1.1em;
   font-size: 1.1em;
   font-weight: 100;
@@ -640,7 +645,7 @@ To top button
     page-break-after: always;
   }
 
-  h1, h2, h3, h4 {
+  h1, h2, h3, h4, .h1, .h2, .h3, .h4 {
     page-break-after: avoid;
     margin-top: 1.2em;
   }
@@ -675,21 +680,21 @@ To top button
       padding-left: 0;
   }
 
-    h1.content {
+    h1.content, .h1.content {
       margin-top: 2em;
       line-height: 2.5em;
     }
 
-    h1 {
+    h1,.h1 {
       font-size: 1.5em;
       line-height: 1.5;
     }
 
-    h2 {
+    h2,.h2 {
       font-size: 1.2em
     }
 
-    h3 {
+    h3,.h3 {
       font-size: 1em;
     }
 

data/lib/isodoc/generic/html/scripts.html

@@ -16,7 +16,6 @@ $('#toggle').on('click', function(){
     else {
         $('nav').show();
         $('nav').animate({ 'left': '0px' }, 'slow');
-        $('.container').animate({ 'padding-left': '360px' }, 'slow');
     }
 });
 </script>

data/lib/isodoc/generic/html/wordstyle.scss

@@ -338,7 +338,7 @@ div.figure, p.figure
         {text-align: center;}
 
 
-h1
+h1,.h1
 	{mso-style-priority:1;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -352,8 +352,6 @@ h1
 	line-height:13.5pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:1;
-	mso-list:l1 level1 lfo6;
 	mso-hyphenate:none;
 	tab-stops:20.0pt list 21.6pt left 28.0pt;
 	font-size:13.0pt;
@@ -365,6 +363,10 @@ h1
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
+h1 {
+	mso-outline-level:1;
+	mso-list:l1 level1 lfo6;
+}
 h1.Annex
 	{mso-style-priority:1;
 	mso-style-unhide:no;
@@ -421,7 +423,7 @@ h1.Annex
         mso-ansi-language:EN-GB;
         mso-fareast-language:JA;
         mso-bidi-font-weight:normal;}
-h2
+h2, .h2
 	{mso-style-priority:2;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -436,8 +438,6 @@ h2
 	line-height:12.5pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:2;
-	mso-list:l1 level2 lfo6;
 	mso-hyphenate:none;
 	tab-stops:27.0pt 35.0pt;
 	font-size:12.0pt;
@@ -448,7 +448,11 @@ h2
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
-h3
+h2 {
+	mso-outline-level:2;
+	mso-list:l1 level2 lfo6;
+}
+h3, .h3
 	{mso-style-priority:3;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -463,8 +467,6 @@ h3
 	line-height:12.0pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:3;
-	mso-list:l1 level3 lfo6;
 	mso-hyphenate:none;
 	tab-stops:list 36.0pt left 44.0pt;
 	font-size:11.0pt;
@@ -474,7 +476,11 @@ h3
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
-h4
+h3 {
+	mso-outline-level:3;
+	mso-list:l1 level3 lfo6;
+}
+h4, .h4
 	{mso-style-priority:4;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -489,8 +495,6 @@ h4
 	line-height:12.0pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:4;
-	mso-list:l1 level4 lfo6;
 	mso-hyphenate:none;
 	tab-stops:51.05pt 57.0pt 68.0pt;
 	font-size:11.0pt;
@@ -500,7 +504,11 @@ h4
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
-h5
+h4 {
+	mso-outline-level:4;
+	mso-list:l1 level4 lfo6;
+}
+h5, .h5
 	{mso-style-priority:5;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -515,8 +523,6 @@ h5
 	line-height:12.0pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:5;
-	mso-list:l1 level5 lfo6;
 	mso-hyphenate:none;
 	tab-stops:51.05pt list 54.0pt;
 	font-size:11.0pt;
@@ -526,7 +532,11 @@ h5
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
-h6
+h5 {
+	mso-outline-level:5;
+	mso-list:l1 level5 lfo6;
+}
+h6, .h6
 	{mso-style-priority:6;
 	mso-style-unhide:no;
 	mso-style-qformat:yes;
@@ -541,8 +551,6 @@ h6
 	line-height:12.0pt;
 	mso-pagination:widow-orphan;
 	page-break-after:avoid;
-	mso-outline-level:6;
-	mso-list:l1 level6 lfo6;
 	mso-hyphenate:none;
 	tab-stops:51.05pt list 72.0pt;
 	font-size:11.0pt;
@@ -552,6 +560,10 @@ h6
 	mso-ansi-language:EN-GB;
 	mso-fareast-language:JA;
 	mso-bidi-font-weight:normal;}
+h6 {
+	mso-outline-level:6;
+	mso-list:l1 level6 lfo6;
+}
 p.MsoToc1, li.MsoToc1, div.MsoToc1
 	{mso-style-priority:39;
 	mso-style-unhide:no;

data/lib/metanorma/generic/converter.rb

@@ -0,0 +1,183 @@
+require "asciidoctor"
+require "metanorma/standoc/converter"
+require "fileutils"
+require_relative "front"
+
+module Metanorma
+  module Generic
+    class Converter < Standoc::Converter
+      XML_ROOT_TAG = "generic-standard".freeze
+      XML_NAMESPACE = "https://www.metanorma.org/ns/generic".freeze
+
+      register_for "generic"
+
+      def xml_root_tag
+        configuration.xml_root_tag || XML_ROOT_TAG
+      end
+
+      def xml_namespace
+        configuration.document_namespace || XML_NAMESPACE
+      end
+
+      def baselocation(loc)
+        return nil if loc.nil?
+
+        return loc
+        File.expand_path(File.join(File.dirname(
+                                     self.class::_file || __FILE__,
+                                   ), "..", "..", "..", loc))
+      end
+
+      def docidentifier_cleanup(xmldoc)
+        template = configuration.docid_template ||
+          "{{ organization_name_short }} {{ docnumeric }}"
+        docid = xmldoc.at("//bibdata/docidentifier")
+        id = boilerplate_isodoc(xmldoc).populate_template(template, nil)
+        id.empty? and docid.remove or docid.children = id
+      end
+
+      def doctype(node)
+        d = super
+        configuration.doctypes or return d == "article" ?
+          (configuration.default_doctype || "standard") : d
+        type = configuration.default_doctype ||
+          configuration.doctypes.keys.dig(0) || "standard"
+        unless configuration.doctypes.keys.include? d
+          @log.add("Document Attributes", nil,
+                   "#{d} is not a legal document type: reverting to '#{type}'")
+          d = type
+        end
+        d
+      end
+
+      def read_config_file(path_to_config_file)
+        Metanorma::Generic.configuration
+          .set_default_values_from_yaml_file(path_to_config_file)
+      end
+
+      def sectiontype_streamline(ret)
+        if configuration&.termsdefs_titles&.map(&:downcase)&.include? ret
+          "terms and definitions"
+        elsif configuration&.symbols_titles&.map(&:downcase)&.include? ret
+          "symbols and abbreviated terms"
+        elsif configuration&.normref_titles&.map(&:downcase)&.include? ret
+          "normative references"
+        elsif configuration&.bibliography_titles&.map(&:downcase)&.include? ret
+          "bibliography"
+        else
+          ret
+        end
+      end
+
+      def document(node)
+        read_config_file(node.attr("customize")) if node.attr("customize")
+        super
+      end
+
+      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")
+      end
+
+      def validate(doc)
+        content_validate(doc)
+        schema_validate(formattedstr_strip(doc.dup),
+                        baselocation(configuration.validate_rng_file) ||
+                        File.join(File.dirname(__FILE__), "generic.rng"))
+      end
+
+      def content_validate(doc)
+        super
+        bibdata_validate(doc.root)
+      end
+
+      def bibdata_validate(doc)
+        stage_validate(doc)
+        committee_validate(doc)
+      end
+
+      def stage_validate(xmldoc)
+        stages = configuration&.stage_abbreviations&.keys || return
+        stages.empty? and return
+        stage = xmldoc&.at("//bibdata/status/stage")&.text
+        stages.include? stage or
+          @log.add("Document Attributes", nil,
+                   "#{stage} is not a recognised status")
+      end
+
+      def committee_validate(xmldoc)
+        committees = Array(configuration&.committees) || return
+        committees.empty? and return
+        xmldoc.xpath("//bibdata/ext/editorialgroup/committee").each do |c|
+          committees.include? c.text or
+            @log.add("Document Attributes", nil,
+                     "#{c.text} is not a recognised committee")
+        end
+      end
+
+      def sections_cleanup(xml)
+        super
+        xml.xpath("//*[@inline-header]").each do |h|
+          h.delete("inline-header")
+        end
+      end
+
+      def blank_method(*args); end
+
+      def html_converter(node)
+        IsoDoc::Generic::HtmlConvert.new(html_extract_attributes(node))
+      end
+
+      def presentation_xml_converter(node)
+        IsoDoc::Generic::PresentationXMLConvert
+          .new(html_extract_attributes(node))
+      end
+
+      alias_method :pdf_converter, :html_converter
+      alias_method :style, :blank_method
+      alias_method :title_validate, :blank_method
+
+      def doc_converter(node)
+        IsoDoc::Generic::WordConvert.new(doc_extract_attributes(node))
+      end
+
+      def configuration
+        Metanorma::Generic.configuration
+      end
+
+      def boilerplate_isodoc(xmldoc)
+        conv = super
+        Metanorma::Generic::Configuration::CONFIG_ATTRS.each do |a|
+          conv.meta.set(a, configuration.send(a))
+        end
+        conv
+      end
+
+      def boilerplate_file(xmldoc)
+        f = configuration.boilerplate
+        f.nil? and return super
+        f.is_a? String and return baselocation(f)
+        f.is_a? Hash and f[@lang] and return baselocation(f[@lang])
+        super
+      end
+
+      def cleanup(xmldoc)
+        super
+        empty_metadata_cleanup(xmldoc)
+        xmldoc
+      end
+
+      def empty_metadata_cleanup(xmldoc)
+        xmldoc.xpath("//bibdata/ext//*").each do |x|
+          x.remove if x.children.empty?
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/generic/front.rb

@@ -0,0 +1,108 @@
+module Metanorma
+  module Generic
+    class Converter < Standoc::Converter
+      def default_publisher
+        configuration.organization_name_long
+      end
+
+      def org_abbrev
+        if !configuration.organization_name_long.empty? &&
+            !configuration.organization_name_short.empty? &&
+            configuration.organization_name_long !=
+            configuration.organization_name_short
+          { configuration.organization_name_long =>
+            configuration.organization_name_short }
+        else
+          super
+        end
+      end
+
+      def relaton_relations
+        Array(configuration.relations) || []
+      end
+
+      def metadata_committee(node, xml)
+        return unless node.attr("committee")
+        xml.editorialgroup do |a|
+          a.committee node.attr("committee"),
+            **attr_code(type: node.attr("committee-type"))
+          i = 2
+          while node.attr("committee_#{i}") do
+            a.committee node.attr("committee_#{i}"),
+              **attr_code(type: node.attr("committee-type_#{i}"))
+            i += 1
+          end
+        end
+      end
+
+      def metadata_status(node, xml)
+        xml.status do |s|
+          s.stage ( node.attr("status") || node.attr("docstage") ||
+                   configuration.default_stage || "published" )
+          x = node.attr("substage") and s.substage x
+          x = node.attr("iteration") and s.iteration x
+        end
+      end
+
+      def metadata_id(node, xml)
+        xml.docidentifier **{ type:
+                              configuration.organization_name_short } do |i|
+          i << "DUMMY"
+        end
+        xml.docnumber { |i| i << node.attr("docnumber") }
+      end
+
+      def metadata_ext(node, ext)
+        super
+        if configuration.metadata_extensions.is_a? Hash
+          metadata_ext_hash(node, ext, configuration.metadata_extensions)
+        else
+          Array(configuration.metadata_extensions).each do |e|
+            a = node.attr(e) and ext.send e, a
+          end
+        end
+      end
+
+      def metadata_doctype(node, xml)
+        d = doctype(node)
+        xml.doctype d, attr_code(abbreviation: configuration&.doctypes&.dig(d))
+      end
+
+      EXT_STRUCT = %w(_output _attribute _list).freeze
+
+      def metadata_ext_hash(node, ext, hash)
+        hash.each do |k, v|
+          next if EXT_STRUCT.include?(k) || !v&.is_a?(Hash) && !node.attr(k)
+          if v&.is_a?(Hash) && v["_list"]
+            csv_split(node.attr(k), ",").each do |val|
+              metadata_ext_hash1(k, val, ext, v, node)
+            end
+          else
+            metadata_ext_hash1(k, node.attr(k), ext, v, node)
+          end
+        end
+      end
+
+      def metadata_ext_hash1(key, value, ext, hash, node)
+        return if hash&.is_a?(Hash) && hash["_attribute"]
+        is_hash = hash&.is_a?(Hash) &&
+            !hash.keys.reject { |n| EXT_STRUCT.include?(n) }.empty?
+        return if !is_hash && (value.nil? || value.empty?)
+        name = hash&.is_a?(Hash) ? (hash["_output"] || key) : key
+        ext.send name, **attr_code(metadata_ext_attrs(hash, node)) do |e|
+            is_hash ? metadata_ext_hash(node, e, hash) : (e << value)
+        end
+      end
+
+      def metadata_ext_attrs(hash, node)
+        return {} unless hash.is_a?(Hash)
+        ret = {}
+        hash.each do |k, v|
+          next unless v.is_a?(Hash) && v["_attribute"]
+          ret[(v["_output"] || k).to_sym] = node.attr(k)
+        end
+        ret
+      end
+    end
+  end
+end

data/lib/{asciidoctor → metanorma}/generic/isodoc.rng

@@ -32,6 +32,19 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="bibitem">
+      <element name="bibitem">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="hidden">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <ref name="BibliographicItem"/>
+      </element>
+    </define>
     <define name="section-title">
       <element name="title">
         <zeroOrMore>
@@ -690,6 +703,7 @@
             <ref name="terms"/>
             <ref name="term-clause"/>
             <ref name="definitions"/>
+            <ref name="floating-title"/>
           </choice>
         </oneOrMore>
       </element>
@@ -1680,6 +1694,7 @@
           <ref name="clause-subsection"/>
           <ref name="terms"/>
           <ref name="definitions"/>
+          <ref name="floating-title"/>
         </choice>
       </oneOrMore>
     </choice>
@@ -1722,6 +1737,7 @@
           <ref name="terms"/>
           <ref name="definitions"/>
           <ref name="references"/>
+          <ref name="floating-title"/>
         </choice>
       </zeroOrMore>
     </group>
@@ -1796,6 +1812,20 @@
           <data type="ID"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <oneOrMore>
         <ref name="preferred"/>
       </oneOrMore>
@@ -1959,7 +1989,11 @@
       </optional>
       <element name="name">
         <zeroOrMore>
-          <ref name="PureTextElement"/>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
         </zeroOrMore>
       </element>
       <optional>
@@ -1973,7 +2007,7 @@
         </element>
       </optional>
       <optional>
-        <element name="grammar-info">
+        <element name="grammar">
           <ref name="Grammar"/>
         </element>
       </optional>
@@ -2516,4 +2550,17 @@
       </oneOrMore>
     </element>
   </define>
+  <define name="floating-title">
+    <element name="floating-title">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="depth">
+        <data type="int"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="TextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
 </grammar>

data/lib/metanorma/generic/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Generic
-    VERSION = "1.11.1".freeze
+    VERSION = "2.0.1".freeze
   end
 end

data/lib/metanorma/generic.rb

@@ -3,8 +3,9 @@ require "metanorma/generic/version"
 require "forwardable"
 require "yaml"
 
+
 module Metanorma
-  module Generic
+  module Generic # rubocop:disable Style/MutableConstant
     ORGANIZATION_NAME_SHORT = "Acme"
     ORGANIZATION_NAME_LONG = "Acme Corp."
     DOCUMENT_NAMESPACE = "https://www.metanorma.org/ns/generic"
@@ -63,23 +64,10 @@ module Metanorma
       ].freeze
 
       def filepath_attrs
-        %i[
-          i18nyaml
-          boilerplate
-          logo_path
-          logo_paths
-          header
-          htmlcoverpage
-          htmlintropage
-          htmlstylesheet
-          scripts
-          scripts_pdf
-          standardstylesheet
-          validate_rng_file
-          wordcoverpage
-          wordintropage
-          wordstylesheet
-        ]
+        %i[i18nyaml boilerplate logo_path logo_paths header
+           htmlcoverpage htmlintropage htmlstylesheet scripts scripts_pdf
+           standardstylesheet validate_rng_file wordcoverpage wordintropage
+           wordstylesheet]
       end
 
       attr_accessor(*CONFIG_ATTRS)
@@ -88,7 +76,7 @@ module Metanorma
         attr_accessor :_file
       end
 
-      def self.inherited(klass)
+      def self.inherited(klass) # rubocop:disable Lint/MissingSuper
         klass._file = caller_locations(1..1).first.absolute_path
       end
 
@@ -115,7 +103,8 @@ module Metanorma
 
       def set_default_values_from_yaml_file(config_file)
         root_path = File.dirname(self.class::_file || __FILE__)
-        default_config_options = YAML.load(File.read(config_file))
+        default_config_options =
+          YAML.safe_load(File.read(config_file, encoding: "UTF-8"))
         if default_config_options["doctypes"].is_a? Array
           default_config_options["doctypes"] =
             default_config_options["doctypes"].each_with_object({}) do |k, m|
@@ -133,7 +122,7 @@ module Metanorma
       end
 
       def blank?(val)
-        val.nil? || val.respond_to?(:empty?) && val.empty?
+        val.nil? || (val.respond_to?(:empty?) && val.empty?)
       end
 
       def absolute_path(value, root_path)

data/lib/metanorma-generic.rb

@@ -1,6 +1,6 @@
 require "metanorma/generic"
 require "asciidoctor"
-require "asciidoctor/generic"
+require "metanorma/generic/converter"
 require "isodoc/generic"
 
 if defined? Metanorma

data/metanorma-generic.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.add_dependency "htmlentities", "~> 4.3.4"
-  spec.add_dependency "metanorma-standoc", "~> 1.11.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.0.0"
   spec.add_dependency "ruby-jing"
 
   spec.add_development_dependency "debug"

data/metanorma.yml.example

@@ -7,7 +7,7 @@ logo_path: /metanorma-mine/lib/isodoc/mine/html/logo.jpg
 logo_paths: 
   - /metanorma-mine/lib/isodoc/mine/html/logo1.jpg
   - /metanorma-mine/lib/isodoc/mine/html/logo2.jpg
-validate_rng_file: /metanorma-mine/lib/asciidoctor/mine/mine.rng
+validate_rng_file: /metanorma-mine/lib/metanorma/mine/mine.rng
 htmlcoverpage: /metanorma-mine/lib/isodoc/mine/html/html_mine_titlepage.html
 htmlintropage: /metanorma-mine/lib/isodoc/mine/html/html_mine_intro.html
 htmlstylesheet: /metanorma-mine/lib/isodoc/mine/html/htmlstyle.scss

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-generic
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: ruby-jing
   requirement: !ruby/object:Gem::Requirement
@@ -213,14 +213,9 @@ files:
 - bin/rspec
 - bin/setup
 - lib/asciidoctor/generic.rb
-- lib/asciidoctor/generic/basicdoc.rng
-- lib/asciidoctor/generic/biblio.rng
 - lib/asciidoctor/generic/converter.rb
+- lib/asciidoctor/generic/deprecated.rb
 - lib/asciidoctor/generic/front.rb
-- lib/asciidoctor/generic/generic.rng
-- lib/asciidoctor/generic/isodoc.rng
-- lib/asciidoctor/generic/reqt.rng
-- lib/asciidoctor/generic/rsd.rng
 - lib/isodoc/generic.rb
 - lib/isodoc/generic/base_convert.rb
 - lib/isodoc/generic/html/generic.scss
@@ -243,8 +238,16 @@ files:
 - lib/isodoc/generic/xref.rb
 - lib/metanorma-generic.rb
 - lib/metanorma/generic.rb
+- lib/metanorma/generic/basicdoc.rng
+- lib/metanorma/generic/biblio.rng
+- lib/metanorma/generic/converter.rb
 - lib/metanorma/generic/fonts_manifest.yaml
+- lib/metanorma/generic/front.rb
+- lib/metanorma/generic/generic.rng
+- lib/metanorma/generic/isodoc.rng
 - lib/metanorma/generic/processor.rb
+- lib/metanorma/generic/reqt.rng
+- lib/metanorma/generic/rsd.rng
 - lib/metanorma/generic/version.rb
 - metanorma-generic.gemspec
 - metanorma.yml.example
@@ -267,7 +270,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Metanorma template gem for customisation.