html2doc 1.7.1 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa6616fc156cf3cfe7fa3c47551f5630c359688b584fa639f8d6d93d08d1170d
-  data.tar.gz: 86bba61be244042f3f56094b053b6a9bd2fc1afb74a8e31f481e91aff063a3b0
+  metadata.gz: e9ccbcf331056dfa6edf4c3a028a1327751695589a3881ba34631fcfe0840ece
+  data.tar.gz: 50146c87c3c2b49942449917e2e549fa2d998c0d3713ce6ae4594046beb25971
 SHA512:
-  metadata.gz: dcb0a834ef0168e4e595216a7efcd3ec4a2aa3801a82bf96298fe0c2d6e37ade361c91369e17d27dc9f19f94062eda258cc47b80aeb64f96a8bdeb7a0f494c73
-  data.tar.gz: 155dfd1fb4b594ccc9dd3c4442bd62977a9c0b2e48d503efa674a12d0797f1ef4a77d9a55cba25a547b49476ceed814433084ffff41d41a43888573fa2dd7d1d
+  metadata.gz: b6d9e333ea11bf0fbfb0021a115c2359a949af78254bec227a11c144e1a9316353163ac15302be8769f744c62b0273602001013dcbf07e6f85ffde3e45cf6abc
+  data.tar.gz: 4f51999d644f50dc08ab70980418d660d8c78baba8ce58b2ed957ddb8fac41cefc1310d1078dea5150270f32c0d76f90f51f7467f6a2c5006efcbe245ec5622f

data/Gemfile

@@ -4,12 +4,6 @@ Encoding.default_internal = Encoding::UTF_8
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}" }
 
-group :development, :test do
-  gem "rspec"
-end
-
-if File.exist? "Gemfile.devel"
-  eval File.read("Gemfile.devel"), nil, "Gemfile.devel" # rubocop:disable Security/Eval
-end
-
 gemspec
+
+eval_gemfile("Gemfile.devel") rescue nil

data/README.adoc

@@ -24,7 +24,7 @@ The gem currently does the following:
 
 * Convert any AsciiMath and MathML to Word's native mathematical formatting language, OOXML. Word supports copy-pasting MathML into Word and converting it into OOXML; however the conversion is not infallible (we have in the past found problems with `\sum`: Word claims parameters were missing, and inserting dotted squares to indicate as much), and you may need to post-edit the OOXML.
 ** The gem does attempt to repair the MathML input, to bring it in line with Word's OOXML's expectations. If you find any issues with AsciiMath or MathML input, please raise an issue.
-* Identify any footnotes in the document (defined as hyperlinks with attributes `class = "Footnote"` or `epub:type = "footnote"`), and render them as Microsoft Word footnotes. 
+* Identify any footnotes in the document (defined as hyperlinks with attributes `class = "Footnote"` or `epub:type = "footnote"`), and render them as Microsoft Word footnotes.
 ** The corresponding footnote content is any `div` or `aside` element with the same `@id` attribute as the footnote points to; e.g. `<a href="#ftn1" epub:type="footnote"><sup>3</sup></a></span>`, pointing to `<aside id="ftn3">`.
 ** By default, the footnote hyperlink contents are overwritten with the autonumbering element: `<a href="#ftn1" epub:type="footnote"><sup>1</sup></a>` is replaced with `<a style='mso-footnote-id:ftn1' href='#_ftn1' name='_ftnref1' title='' id='_ftnref1'><span class='MsoFootnoteReference'><span style='mso-special-character:footnote'/></span>`
 ** If the footnote hyperlink already contains (as a child) an element marked up as `<span class='MsoFootnoteReference'>`, only that span is replaced by the Microsoft autonumber element; any text surrounding it is preserved in both the footnote reference and the footnote target. For example, `<a href="#ftn1" epub:type="footnote"><span class='MsoFootnoteReference'>1</span>)</a>` will render as the footnote _1)_, both in the link and the target.
@@ -116,22 +116,42 @@ The bad news is that Word's understanding of HTML is HTML 4. In order for bookma
 
 The good news with generating a Word document via HTML is that Word understands CSS, and you can determine much of what the Word document looks like by manipulating that CSS. That extends to features that are not part of HTML CSS: if you want to work out how to get Word to do something in CSS, save a Word document that already does what you want as HTML, and inspect the HTML and CSS you get.
 
-The bad news is that Word's implementation of CSS is poorly documented -- even if Office HTML is documented in a 1300 page document (online at https://stigmortenmyre.no/mso/, https://www.rodriguezcommaj.com/assets/resources/microsoft-office-html-and-xml-reference.pdf), and the CSS selectors are only partially and selectively implemented. For list styles, for example, `mso-level-text` governs how the list label is displayed; but it is only recognised in a `@list` style: it is ignored in a CSS rule like `ol li`, or in a `style` attribute on a node. CSS selectors only support classes, in ancestor relations: `p.class1 ol.class2` is supported, but `#id1` is not, and neither is `p > ol`. Working out the right CSS for what you want will take some trial and error, and you are better placed to try to do things Word's way than the right way.
+The bad news is that Word's implementation of CSS is poorly documented -- even
+if Office HTML is documented in a 1300 page document (online
+https://stigmortenmyre.no/mso/[here] and
+https://www.rodriguezcommaj.com/assets/resources/microsoft-office-html-and-xml-reference.pdf[here]),
+and the CSS selectors are only partially and selectively implemented. For list
+styles, for example, `mso-level-text` governs how the list label is displayed;
+but it is only recognised in a `@list` style: it is ignored in a CSS rule like
+`ol li`, or in a `style` attribute on a node. CSS selectors only support
+classes, in ancestor relations: `p.class1 ol.class2` is supported, but `#id1` is
+not, and neither is `p > ol`. Working out the right CSS for what you want will
+take some trial and error, and you are better placed to try to do things Word's
+way than the right way.
 
-=== XSLT
+=== Math
 
-This gem is published with an early draft of the XSLT stylesheet transforming MathML into OOXML, `mml2omml.xsl`, that has published for several years now as part of the https://github.com/TEIC/Stylesheets[TEI stylesheet set]. (We have made some further minor edits to the stylesheet.) The stylesheets have been published under a dual Creative Commons Sharealike/BSD licence.
+Word uses OMML instead of W3C's MathML which is now the de-facto standard of XML
+math representation.
 
-The good news is that the stylesheet is not identical to the stylesheet `mathml2omml.xsl` that is published with Microsoft Word, so it can and has been redistributed.
+The https://github.com/plurimath/plurimath[Plurimath gem] is used to convert
+Metanorma's MathML into OMML.
+
+NOTE: Previously `html2doc` use a modified, early draft of the XSLT stylesheet
+`mml2omml.xsl`, published by the
+https://github.com/TEIC/Stylesheets[TEI stylesheet set] (CC/BSD licensed).
+
+=== Math Positioning
+
+By default, mathematical formulas that are the only content of their paragraph
+are rendered as centered in Word. If you want your AsciiMath or MathML to be
+left-aligned or right-aligned, add `style="text-align:left"` or
+`style="text-align:right"` to its ancestor `div`, `p` or `td` node in HTML.
 
-The bad news is that the stylesheet is not identical to the stylesheet `mathml2omml.xsl` that is published with Microsoft Word, so it isn't guaranteed to have identical output. If you want to make sure that your MathML import is identical to what Word currently uses, replace `mml2omml.xsl` with `mathml2omml.xsl`, and edit the gem accordingly for your local installation. On Windows, you will find the stylesheet in the same directory as the `winword.exe` executable. On Mac, right-click on the Word application, and select "Show Package Contents"; you will find the stylesheet under `Contents/Resources`.
 
 === Lists
 Natively, Word does not use `<ol>`, `<ul>`, or `<dl>` lists in its HTML exports at all: it uses paragraphs styled with list styles. If you save a Word document as HTML in order to use its CSS for Word documents generated by HTML, those styles will still work (with the caveat that you will need to extract the `@list` style specific to ordered and unordered lists, and pass it as a `liststyles` parameter to the conversion). Word HTML understands `<ol>, <ul>, <li>`, but its rendering is fragile: in particular, any instance of `<p>` within a `<li>` is treated as a new list item (so Word HTML will not let you have multi-paragraph list items if you use native HTML.) This gem now exports lists as Word HTML prefers to see them, with `MsoListParagraphCxSpFirst, MsoListParagraphCxSpMiddle, MsoListParagraphCxSpLast` styles. You will need to include these in the CSS stylesheet you supply, in order to get the right indentation for lists.
 
-=== Math Positioning
-By default, mathematical formulas that are the only content of their paragraph are rendered as centered in Word. If you want your AsciiMath or MathML to be left-aligned or right-aligned, add `style="text-align:left"` or `style="text-align:right"` to its ancestor `div`, `p` or `td` node in HTML.
-
 == Example
 
 The `spec/examples` directory includes `rice.doc` and its source files: this Word document has been generated from `rice.html` through a call to html2doc from https://github.com/metanorma/metanorma-iso. (The source document `rice.html` was itself generated from Asciidoc, rather than being hand-crafted.)

data/html2doc.gemspec

@@ -32,9 +32,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mime-types"
   spec.add_dependency "nokogiri", "~> 1.15"
   spec.add_dependency "plane1converter", "~> 0.0.1"
-  spec.add_dependency "plurimath", "~> 0.5.0"
+  spec.add_dependency "plurimath", "~> 0.7.0"
   spec.add_dependency "thread_safe"
   spec.add_dependency "uuidtools"
+  spec.add_dependency "unitsml"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

data/lib/html2doc/base.rb

@@ -15,9 +15,6 @@ class Html2Doc
     @liststyles = hash[:liststyles]
     @stylesheet = hash[:stylesheet]
     @c = HTMLEntities.new
-    @xsltemplate =
-      Nokogiri::XSLT(File.read(File.join(File.dirname(__FILE__), "mml2omml.xsl"),
-                               encoding: "utf-8"))
   end
 
   def process(result)

data/lib/html2doc/math.rb

@@ -38,13 +38,13 @@ class Html2Doc
 
   # random fixes to MathML input that OOXML needs to render properly
   def ooxml_cleanup(math, docnamespaces)
-    #encode_math(
-      unwrap_accents(
-        mathml_preserve_space(
-          mathml_insert_rows(math, docnamespaces), docnamespaces
-        ),
-      )
-    #)
+    # encode_math(
+    unwrap_accents(
+      mathml_preserve_space(
+        mathml_insert_rows(math, docnamespaces), docnamespaces
+      ),
+    )
+    # )
     math.add_namespace(nil, MATHML_NS)
     math
   end
@@ -165,10 +165,9 @@ class Html2Doc
   def mathml_to_ooml1(xml, docnamespaces)
     doc = Nokogiri::XML::Document::new
     doc.root = ooxml_cleanup(xml, docnamespaces)
-    # ooxml = @xsltemplate.transform(doc)
-    d = xml.parent["block"] != "false" # display_style
-    ooxml = Nokogiri::XML(Plurimath::Math.parse(doc.to_xml(indent: 0),
-                                                :mathml).to_omml)
+    # d = xml.parent["block"] != "false" # display_style
+    ooxml = Nokogiri::XML(Plurimath::Math
+      .parse(doc.to_xml(indent: 0), :mathml).to_omml(split_on_linebreak: true))
     ooxml = unitalic(accent_tr(ooxml))
     ooxml = ooml_clean(uncenter(xml, ooxml))
     xml.swap(ooxml)
@@ -202,9 +201,10 @@ class Html2Doc
     x.text.strip.empty?
   end
 
-  def math_block?(_ooxml, mathml)
+  def math_block?(ooxml, mathml)
     # ooxml.name == "oMathPara" || mathml["displaystyle"] == "true"
-    mathml["displaystyle"] == "true"
+    mathml["displaystyle"] == "true" &&
+      ooxml.xpath("./m:oMath", "m" => OOXML_NS).size <= 1
   end
 
   STYLE_BEARING_NODE =
@@ -228,11 +228,9 @@ class Html2Doc
 
   def uncenter_unneeded(math, ooxml, alignnode)
     (math_block?(ooxml, math) || !alignnode) and return ooxml
-    if !math_only_para?(alignnode)
-      ooxml.name == "oMathPara" and
-        ooxml = ooxml.elements.detect { |x| x.name == "oMath" }
-      return ooxml
-    end
-    nil
+    math_only_para?(alignnode) and return nil
+    ooxml.name == "oMathPara" and
+      ooxml = ooxml.elements.select { |x| %w(oMath r).include?(x.name) }
+    ooxml.size > 1 ? nil : Nokogiri::XML::NodeSet.new(math.document, ooxml)
   end
 end

data/lib/html2doc/version.rb

@@ -1,3 +1,3 @@
 class Html2Doc
-  VERSION = "1.7.1".freeze
+  VERSION = "1.7.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: html2doc
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.7.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-27 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: thread_safe
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: unitsml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -301,9 +315,7 @@ files:
 - lib/html2doc/base.rb
 - lib/html2doc/lists.rb
 - lib/html2doc/math.rb
-- lib/html2doc/mathml2omml.xsl
 - lib/html2doc/mime.rb
-- lib/html2doc/mml2omml.xsl
 - lib/html2doc/notes.rb
 - lib/html2doc/version.rb
 - lib/html2doc/wordstyle.css