metanorma-generic 2.6.5 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 362b19c7415032ba198d240f6c5a68be9b78940805adf49dc2a326c367ef5b85
-  data.tar.gz: 75c6592984d97612670ea424b475497a5d0b63e13c05971944cf7cf476b9ba9d
+  metadata.gz: bd710f710d4ac3b76fed5d6f647c2fec15372b84f2d86e01380a310b5d772db5
+  data.tar.gz: bf48530b643adc2078b880f6913df915bc8c6696d727e792baac2014f7605bb7
 SHA512:
-  metadata.gz: d700d636ee17e775efa41fe6b3ffca21c1ebee6cc3e05b88854836ae8ca3209ce5aef30cc0163091e0b34dc8bf7d41d7530b43f9df168369bc7fc9e4c0aac818
-  data.tar.gz: 71b1247e84c43031bb4ff5dae8a9a44bb8b7d717b8a512f8e9b6f6541746f252b953876a3c4bbe4a1cf070405ac77e8e3340650015cccc4b5071b0d5b5880e7d
+  metadata.gz: 8d45aca2e37d6987437b9cb12f287740d05a5c209c3f01f249b3ffa266995303cf62db2e391d10904344271da4058fb8b21ba6dcb228d600a88bb7dc134aeed6
+  data.tar.gz: c4f75e08a3ffe7f68dde7076fa94cb7209f1345a41fe423750e6110aebf5efd7676913998576dd594a72008157e2545d8e25c847ca19ba873330173f9edb878f

data/lib/isodoc/generic/pdf_convert.rb

@@ -0,0 +1,21 @@
+require_relative "base_convert"
+require "metanorma-generic"
+require "isodoc"
+
+module IsoDoc
+  module Generic
+    class PdfConvert < IsoDoc::XslfoPdfConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
+      def pdf_stylesheet(docxml)
+        configuration.pdf_stylesheet
+      end
+
+      include BaseConvert
+      include Init
+    end
+  end
+end

data/lib/isodoc/generic.rb

@@ -1,6 +1,7 @@
 require "isodoc/generic/metadata"
 require "isodoc/generic/html_convert"
 require "isodoc/generic/word_convert"
+require "isodoc/generic/pdf_convert"
 require "isodoc/generic/presentation_xml_convert"
 
 module IsoDoc

data/lib/metanorma/generic/basicdoc.rng

@@ -1000,14 +1000,14 @@
   <define name="PureTextElement">
     <choice>
       <text/>
-      <ref name="em"/>
-      <ref name="strong"/>
+      <ref name="pure_em"/>
+      <ref name="pure_strong"/>
       <ref name="sub"/>
       <ref name="sup"/>
-      <ref name="tt"/>
-      <ref name="underline"/>
-      <ref name="strike"/>
-      <ref name="smallcap"/>
+      <ref name="pure_tt"/>
+      <ref name="pure_underline"/>
+      <ref name="pure_strike"/>
+      <ref name="pure_smallcap"/>
       <ref name="br"/>
     </choice>
   </define>
@@ -1031,6 +1031,13 @@
       </zeroOrMore>
     </element>
   </define>
+  <define name="pure_em">
+    <element name="em">
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="strong">
     <element name="strong">
       <zeroOrMore>
@@ -1046,6 +1053,13 @@
       </zeroOrMore>
     </element>
   </define>
+  <define name="pure_strong">
+    <element name="strong">
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="tt">
     <element name="tt">
       <zeroOrMore>
@@ -1060,6 +1074,13 @@
       </zeroOrMore>
     </element>
   </define>
+  <define name="pure_tt">
+    <element name="tt">
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="keyword">
     <element name="keyword">
       <zeroOrMore>
@@ -1090,13 +1111,42 @@
       <zeroOrMore>
         <choice>
           <ref name="PureTextElement"/>
+          <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
           <ref name="index"/>
           <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
   </define>
+  <define name="pure_strike">
+    <element name="strike">
+      <zeroOrMore>
+        <ref name="PureTextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="underline">
+    <element name="underline">
+      <optional>
+        <attribute name="style"/>
+      </optional>
+      <zeroOrMore>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="pure_underline">
     <element name="underline">
       <optional>
         <attribute name="style"/>
@@ -1107,6 +1157,21 @@
     </element>
   </define>
   <define name="smallcap">
+    <element name="smallcap">
+      <zeroOrMore>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="pure_smallcap">
     <element name="smallcap">
       <zeroOrMore>
         <ref name="PureTextElement"/>

data/lib/metanorma/generic/biblio.rng

@@ -1204,7 +1204,9 @@
       <optional>
         <ref name="formattedref"/>
       </optional>
-      <ref name="btitle"/>
+      <oneOrMore>
+        <ref name="btitle"/>
+      </oneOrMore>
       <optional>
         <ref name="bplace"/>
       </optional>

data/lib/metanorma/generic/converter.rb

@@ -2,6 +2,8 @@ require "asciidoctor"
 require "metanorma/standoc/converter"
 require "fileutils"
 require_relative "front"
+require "metanorma"
+require "pathname"
 
 module Metanorma
   module Generic
@@ -20,20 +22,17 @@ module Metanorma
       end
 
       def baselocation(loc)
-        return nil if loc.nil?
-
+        loc.nil? and return nil
         return loc
-        File.expand_path(File.join(File.dirname(
-                                     self.class::_file || __FILE__,
-                                   ), "..", "..", "..", loc))
       end
 
       def docidentifier_cleanup(xmldoc)
+        b = boilerplate_isodoc(xmldoc) or return
         template = configuration.docid_template ||
           "{{ organization_name_short }} {{ docnumeric }}"
         docid = xmldoc.at("//bibdata/docidentifier")
         docid&.text&.empty? or return
-        id = boilerplate_isodoc(xmldoc).populate_template(template, nil)
+        id = b.populate_template(template, nil)
         (id.empty? and docid.remove) or docid.children = id
       end
 
@@ -58,6 +57,10 @@ module Metanorma
       def read_config_file(path_to_config_file)
         Metanorma::Generic.configuration
           .set_default_values_from_yaml_file(path_to_config_file)
+        # reregister Processor to Metanorma with updated values
+        if defined? Metanorma::Registry
+          Metanorma::Registry.instance.register(Metanorma::Generic::Processor)
+        end
       end
 
       def sectiontype_streamline(ret)
@@ -75,7 +78,12 @@ module Metanorma
       end
 
       def document(node)
-        read_config_file(node.attr("customize")) if node.attr("customize")
+        if node.attr("customize")
+          p = node.attr("customize")
+          (Pathname.new p).absolute? or
+            p = File.expand_path(File.join(Metanorma::Utils::localdir(node), p))
+          read_config_file(p)
+        end
         super
       end
 
@@ -158,7 +166,7 @@ module Metanorma
       end
 
       def boilerplate_isodoc(xmldoc)
-        conv = super
+        conv = super or return nil
         Metanorma::Generic::Configuration::CONFIG_ATTRS.each do |a|
           conv.meta.set(a, configuration.send(a))
         end

data/lib/metanorma/generic/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v1.3.2 -->
+<!-- VERSION v1.3.3 -->
 <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">
@@ -331,9 +331,9 @@
       <zeroOrMore>
         <ref name="table-note"/>
       </zeroOrMore>
-      <optional>
+      <zeroOrMore>
         <ref name="source"/>
-      </optional>
+      </zeroOrMore>
     </define>
     <define name="FigureAttr">
       <optional>
@@ -380,9 +380,9 @@
       <zeroOrMore>
         <ref name="note"/>
       </zeroOrMore>
-      <optional>
+      <zeroOrMore>
         <ref name="source"/>
-      </optional>
+      </zeroOrMore>
     </define>
     <define name="source">
       <element name="source">
@@ -662,6 +662,9 @@
             <value>LatexMath</value>
           </choice>
         </attribute>
+        <optional>
+          <attribute name="number-format"/>
+        </optional>
         <attribute name="block">
           <data type="boolean"/>
         </attribute>

data/lib/metanorma/generic/processor.rb

@@ -15,10 +15,11 @@ module Metanorma
       end
 
       def output_formats
-        super.merge(
-          html: "html",
-          doc: "doc",
-        )
+        configuration.formats
+      end
+
+      def fonts_manifest
+        configuration&.fonts_manifest
       end
 
       def version

data/lib/metanorma/generic/reqt.rng

@@ -66,6 +66,9 @@
         <ref name="MultilingualRenderingType"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="class"/>
+    </optional>
     <optional>
       <ref name="reqtitle"/>
     </optional>

data/lib/metanorma/generic/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Generic
-    VERSION = "2.6.5".freeze
+    VERSION = "2.7.1".freeze
   end
 end

data/lib/metanorma/generic.rb

@@ -10,6 +10,10 @@ module Metanorma
     DOCUMENT_NAMESPACE = "https://www.metanorma.org/ns/generic"
     YAML_CONFIG_FILE = "metanorma.yml"
 
+    class DummyProcessor < ::Metanorma::Processor
+      def initialize; end # rubocop:disable Lint/MissingSuper
+    end
+
     class Configuration
       CONFIG_ATTRS = %i[
         organization_name_short
@@ -21,6 +25,7 @@ module Metanorma
         docid_template
         doctypes
         default_doctype
+        fonts_manifest
         i18nyaml
         logo_path
         logo_paths
@@ -60,13 +65,15 @@ module Metanorma
         word_smallerfontsize
         word_footnotefontsize
         xml_root_tag
+        pdf_stylesheet
+        formats
       ].freeze
 
       def filepath_attrs
-        %i[i18nyaml boilerplate logo_path logo_paths header
+        %i[i18nyaml boilerplate logo_path logo_paths header boilerplate
            htmlcoverpage htmlintropage htmlstylesheet scripts scripts_pdf
            standardstylesheet validate_rng_file wordcoverpage wordintropage
-           wordstylesheet]
+           wordstylesheet pdf_stylesheet]
       end
 
       attr_accessor(*CONFIG_ATTRS)
@@ -84,11 +91,31 @@ module Metanorma
         # Try to set config values from yaml file in current directory
         @yaml = File.join(File.dirname(self.class::_file || __FILE__), "..",
                           "..", YAML_CONFIG_FILE)
-        set_default_values_from_yaml_file(@yaml) if File.file?(@yaml)
+        set_default_values_from_yaml_file(@yaml)
+      end
+
+      # may be invoked multiple times, needs to not overwrite
+      def postprocess_defaults
+        default_org
+        default_formats
+        default_titles
+      end
+
+      def default_org
         self.organization_name_short ||= ORGANIZATION_NAME_SHORT
         self.organization_name_long ||= ORGANIZATION_NAME_LONG
         self.document_namespace ||= DOCUMENT_NAMESPACE
-        default_titles
+      end
+
+      # convert array to hash; if already is hash (no override in customize),
+      # don't reconvert
+      def default_formats
+        formats.is_a?(Hash) and return
+        self.formats ||= %w(html doc)
+        self.formats = self.formats.each_with_object({}) do |k, m|
+          m[k.to_sym] = k
+        end
+        self.formats.merge! DummyProcessor.new.output_formats
       end
 
       def default_titles
@@ -105,18 +132,26 @@ module Metanorma
       end
 
       def set_default_values_from_yaml_file(config_file)
-        root_path, default_config_options =
-          set_default_values_from_yaml_file_prep(config_file)
-        CONFIG_ATTRS.each do |attr_name|
-          value = default_config_options[attr_name.to_s]
-          value && filepath_attrs.include?(attr_name) and
-            value = absolute_path(value, root_path)
-          instance_variable_set("@#{attr_name}", value)
+        if File.file?(config_file)
+          root_path, default_config_options =
+            set_default_values_from_yaml_file_prep(config_file)
+          CONFIG_ATTRS.each do |attr|
+            set_default_value_from_yaml_file(attr, root_path,
+                                             default_config_options)
+          end
         end
+        postprocess_defaults
+      end
+
+      def set_default_value_from_yaml_file(attr, root_path, default_options)
+        value = default_options[attr.to_s]
+        value && filepath_attrs.include?(attr) and
+          value = absolute_path(value, root_path)
+        instance_variable_set("@#{attr}", value)
       end
 
       def set_default_values_from_yaml_file_prep(config_file)
-        root_path = File.dirname(self.class::_file || __FILE__)
+        root_path = File.dirname(config_file)
         default_config_options =
           YAML.safe_load(File.read(config_file, encoding: "UTF-8"))
         default_config_options["doctypes"].is_a? Array and
@@ -132,13 +167,14 @@ module Metanorma
       end
 
       def absolute_path(value, root_path)
-        if value.is_a? Hash then absolute_path1(value, root_path)
-        elsif value.is_a? Array
-          value.reject { |a| blank?(a) }.each_with_object([]) do |v1, g|
-            g << absolute_path(v1, root_path)
+        case value
+        when Hash then absolute_path1(value, root_path)
+        when Array then absolute_path1_array(value, root_path)
+        when String
+          if !value.empty? && !Pathname.new(value).absolute?
+            Pathname.new(File.join(root_path, value)).cleanpath.to_s
+          else value
           end
-        elsif value.is_a?(String) && !value.empty?
-          File.join(root_path, "..", "..", value)
         else value
         end
       end
@@ -148,6 +184,12 @@ module Metanorma
           absolute_path(v, pref)
         end
       end
+
+      def absolute_path1_array(value, pref)
+        value.reject { |a| blank?(a) }.each_with_object([]) do |v1, g|
+          g << absolute_path(v1, pref)
+        end
+      end
     end
 
     class << self

data/metanorma-generic.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 2.9.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.9.3"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
@@ -39,4 +39,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sassc", "2.4.0"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
+  spec.add_development_dependency "xml-c14n"
 end

data/metanorma.yml.example

@@ -8,6 +8,10 @@ logo_paths:
   - /metanorma-mine/lib/isodoc/mine/html/logo1.jpg
   - /metanorma-mine/lib/isodoc/mine/html/logo2.jpg
 validate_rng_file: /metanorma-mine/lib/metanorma/mine/mine.rng
+formats:
+  - html
+  - pdf
+  - doc
 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
@@ -25,6 +29,7 @@ header: /metanorma-mine/lib/isodoc/mine/html/header.html
 wordcoverpage: /metanorma-mine/lib/isodoc/mine/html/word_mine_titlepage.html
 wordintropage: /metanorma-mine/lib/isodoc/mine/html/word_mine_intro.html
 wordstylesheet: /metanorma-mine/lib/isodoc/mine/html/wordstyle.scss
+pdf_stylesheet: /metanorma-mine/lib/isodoc/mine/html/mine.xsl
 word_bodyfont: '"Source Sans Pro","Arial",sans-serif'
 word_headerfont: '"Source Sans Pro","Arial",sans-serif'
 word_monospacefont: '"Source Code Pro",monospace'
@@ -72,3 +77,6 @@ normref_titles:
   - Normative references
 bibliography_titles:
   - Bibliography
+fonts_manifest:
+  Font1:
+  Font2:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-generic
 version: !ruby/object:Gem::Version
-  version: 2.6.5
+  version: 2.7.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-08 00:00:00.000000000 Z
+date: 2024-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.9.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: 2.9.3
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: xml-c14n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   Metanorma template gem for customisation. This gem is meant to be customised for any downstream use.
 
@@ -201,6 +215,7 @@ files:
 - lib/isodoc/generic/i18n.rb
 - lib/isodoc/generic/init.rb
 - lib/isodoc/generic/metadata.rb
+- lib/isodoc/generic/pdf_convert.rb
 - lib/isodoc/generic/presentation_xml_convert.rb
 - lib/isodoc/generic/utils.rb
 - lib/isodoc/generic/word_convert.rb