softcover 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4808d28606e926f2e31806692d5fdda88747ce99
-  data.tar.gz: cf29b0559c4cd6b3a03505dbcd92b026647137e1
+  metadata.gz: b898b99eecd64b980a244b0e8cb071d62e607beb
+  data.tar.gz: aba03346eeab27fcf482445621e0b61dc450f97a
 SHA512:
-  metadata.gz: d62b11c809d1b2e416a252314bb4368407482d3e9452eef8d2e3f888035aa32e382e560f59f5c117943fa84c5ecb904b4630410e15a1db194d2aab7212ff341f
-  data.tar.gz: 2014320f079f3e3c4927389b463424ffda8c1e16cd87b331076393cc16f4dd0afb14168fd62590c19fb0eed9be056318f769f728f1b84d905c72afc08085228e
+  metadata.gz: bc02c7d4e3bd9fc0303d87ba24c5b2dde04358701b04ccb99c0c0e5e714c2b26c3a72bcc1eeb7ac7504fd6cc2a08325797027b3f87812bbba8d92eca10a2bf18
+  data.tar.gz: 42b19d4cc49c42213cf835be214a55d3262dc18a16597827218528402a0d54b384c55841623e9dc7aa761b434cc221b9df44fbc7e58e22d7d3172cecfc114509

data/README.md

@@ -14,6 +14,8 @@ On some systems, you may need to add an extra option to handle SSL correctly:
 
     $ gem install softcover -- --with-cppflags=-I/usr/local/opt/openssl/include
 
+Then install the dependencies as described [http://manual.softcover.io/book/getting_started#sec-installing_softcover](here).
+
 ## Usage
 
 Run

data/lib/softcover/article_template/epub/OEBPS/styles/custom_epub.css

@@ -18,5 +18,5 @@
 
 body {
   font-size: 80%;
-  line-height: 1.1;
+  line-height: 1.4;
 }

data/lib/softcover/book_template/epub/OEBPS/styles/custom_epub.css

@@ -18,5 +18,5 @@
 
 body {
   font-size: 80%;
-  line-height: 1.1;
+  line-height: 1.4;
 }

data/lib/softcover/builders/epub.rb

@@ -304,7 +304,6 @@ module Softcover
         source.css('script').each(&:remove)
         # Remove all the MathJax preview spans.
         source.css('MathJax_Preview').each(&:remove)
-
         # Suck out all the SVGs
         svgs   = source.css('div#book svg')
         frames = source.css('span.MathJax_SVG')
@@ -318,17 +317,43 @@ module Softcover
           svg_filename = File.join(texmath_dir, "#{digest(output)}.svg")
           svg_filename_abspath = File.join("#{Dir.pwd}", svg_filename)
           File.write(svg_filename, output)
-          # Convert to PNG.
+          # Convert to PNG named:
           png_filename = svg_filename.sub('.svg', '.png')
           png_filename_abspath = svg_filename_abspath.sub('.svg', '.png')
           pngs << png_filename
+          #
+          # Settings for inline math in ePub / mobi
+          pt_scale_factor = 16  # scaling factor used for SVG --> PNG conversion
+          height_scale_factor = 0.50  # 1ex/1em for scaling math PNG's height
+          valign_scale_factor = 0.45  # 1ex/1em when scaling PNG's vertical-align
+          # these are used in three-step process below: Extract, Convert, Eeplace
+          # STEP1: Extract information from svg tag.
+          svg_height = svg['style'].scan(/height: (.*?);/).flatten.first
+          if svg_height
+            svg_height_in_ex = Float(svg_height.gsub('ex',''))
+            png_height = (svg_height_in_ex * height_scale_factor).to_s + 'em'
+           # MathJax sets SVG height in `ex` units but we wan `em` units for PNG
+          end
+          # Extract vertical-align css proprty for for inline math.
+          if svg.parent.parent.attr('class') == "inline_math"
+            vertical_align = svg['style'].scan(/vertical-align: (.*?);/).flatten.first
+            if vertical_align
+              valign_in_ex = Float(vertical_align.gsub('ex',''))
+              # png vertical-align in ems is the css equivalent of `depth` in TeX
+              png_valign = (valign_in_ex * valign_scale_factor).to_s + 'em'
+            else
+              png_valign = "0em"
+            end
+          else # No vertical align for displayed math
+            png_valign = nil
+          end
+          # STEP2: Generate PNG from each SVG (if necessary).
           unless File.exist?(png_filename)
+            h = pt_scale_factor * svg_height.to_f  # PNG height in pt
             unless options[:silent] || options[:quiet]
               puts "Creating #{png_filename}"
             end
-            svg_height = svg['style'].scan(/height: (.*?);/).flatten.first
-            scale_factor = 8   # This scale factor turns out to look good.
-            h = scale_factor * svg_height.to_f
+            # generate png from the MathJax_SVG using inkscape
             cmd = "#{inkscape} -f #{svg_filename_abspath} -e #{png_filename_abspath} -h #{h}pt"
             if options[:silent]
               silence { silence_stream(STDERR) { system cmd } }
@@ -337,10 +362,14 @@ module Softcover
             end
           end
           rm svg_filename
+          # STEP 3: Replace svg element with an equivalent png.
           png = Nokogiri::XML::Node.new('img', source)
-          png['src'] = File.join('images', 'texmath',
-                                 File.basename(png_filename))
+          png['src'] = File.join('images', 'texmath', File.basename(png_filename))
           png['alt'] = png_filename.sub('.png', '')
+          png['style']  = 'height:' + png_height + ';'
+          if png_valign
+            png['style'] += ' vertical-align:' + png_valign + ';'
+          end
           svg.replace(png)
         end
         # Make references relative.

data/lib/softcover/utils.rb

@@ -262,7 +262,7 @@ module Softcover::Utils
       # Finds EpubCheck anywhere on the path.
       version_3 = path('epubcheck-3.0/epubcheck-3.0.jar')
       version_4 = path('epubcheck-4.0.1/epubcheck.jar')
-      first_path(version_4) || first_path(version_3) || ""
+      first_path(version_4) || first_path(version_3) || get_filename(:'epubcheck') || ""
     when :inkscape
       default = '/Applications/Inkscape.app/Contents/Resources/bin/inkscape'
       filename_or_default(:inkscape, default)

data/lib/softcover/version.rb

@@ -1,3 +1,3 @@
 module Softcover
-  VERSION = "1.2.6"
+  VERSION = "1.2.7"
 end

data/spec/builders/epub_spec.rb

@@ -172,6 +172,24 @@ describe Softcover::Builders::Epub do
         expect(path("epub/OEBPS/images/texmath")).to exist
         expect(Dir[path("epub/OEBPS/images/texmath/*.png")]).not_to be_empty
       end
+
+      it "should record vertical-align of inline math SVGs" do
+        content = File.read(path("./epub/OEBPS/a_chapter_fragment.xhtml"))
+        html = Nokogiri::HTML(content)
+        math_imgs = html.search('span.inline_math img')
+        math_imgs.each do |math_img|
+          expect(math_img['style']).to match /vertical-align/
+        end
+      end
+
+      it "should not add vertical-align to displayed math" do
+        content = File.read(path("./epub/OEBPS/a_chapter_fragment.xhtml"))
+        html = Nokogiri::HTML(content)
+        math_imgs = html.search('div.equation img')
+        math_imgs.each do |math_img|
+          expect(math_img['style']).not_to match /vertical-align/
+        end
+      end
     end
 
     it "should create the style files" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: softcover
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-21 00:00:00.000000000 Z
+date: 2016-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polytexnic