softcover 0.8.9 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e236dc06258cb83e779007f53868d7e11a1fe12
-  data.tar.gz: 4e9cf4fd4ee6a1a03beb796004522e4cb20dce10
+  metadata.gz: 5cde257d853b87404d19decb7190ed774b6f68c2
+  data.tar.gz: 4a22997a284fa6f364c61aeee24344942a485a94
 SHA512:
-  metadata.gz: 1c0f5758cbbd305ea9b0f76a7939be1d39cbba9729d8cd5626a33c844c92415e59839d81d2442ee14d649c5e2a0b102e1dee4321fff671a9eb55b459627387ab
-  data.tar.gz: 03f7a45f12d7905abdf0f78ace0330eece59d948dcaaeb1841ab72a0018cfd390c0f8010d6cbe59775584ee34656558e432cadc086d3c7a91d186fd15c5f0e7e
+  metadata.gz: 2b5aacf11aa98f5bf6683574c138a51bb9e3b39c205001f628d5a10a82831eca40c8505561e559d7c4292f7b60cb362d95fb1d81f2e1e3495ee73b7bb4e697ae
+  data.tar.gz: 2d56e4ec07a2eb1c4e70bdd6cfc3349d989b813fb0d950d8e6a6cb7a87876d89dbdefc0feada9ce5b37282ca3da99cbc7753b80dacd11b4daf12dddec73e650b

data/lib/softcover/book_manifest.rb

@@ -35,9 +35,15 @@ class Softcover::BookManifest < OpenStruct
 
     # Returns a chapter heading for use in the navigation menu.
     def menu_heading
-      raw_html = Polytexnic::Pipeline.new(title).to_html
+      raw_html = Polytexnic::Pipeline.new(title,
+                                          language_labels: language_labels).
+                                         to_html
       html = Nokogiri::HTML(raw_html).at_css('p').inner_html
-      chapter_number.zero? ? html : "Chapter #{chapter_number}: #{html}"
+      if chapter_number.zero?
+        html
+      else
+        "#{chapter_label(chapter_number)}: #{html}"
+      end
     end
 
     def to_hash
@@ -103,7 +109,7 @@ class Softcover::BookManifest < OpenStruct
       if base_contents.match(/frontmatter/)
         @frontmatter = true
         chapters.push Chapter.new(slug:  'frontmatter',
-                                  title: 'Frontmatter',
+                                  title: language_labels["frontmatter"],
                                   sections: nil,
                                   chapter_number: 0)
       end
@@ -139,7 +145,11 @@ class Softcover::BookManifest < OpenStruct
     template_dir = File.join(File.dirname(__FILE__), 'template')
     files = [File.join(Softcover::Directories::CONFIG, 'marketing.yml'),
              path('images/cover-web.png'),
-             path('latex_styles/custom_pdf.sty')]
+             path('latex_styles/custom_pdf.sty'),
+             path('config/preamble.tex'),
+             path('config/lang.yml'),
+             path('epub/OEBPS/styles/custom_epub.css')
+           ]
     files.each do |file|
       unless File.exist?(file)
         puts "Copying missing file '#{file}' from template"
@@ -346,7 +356,9 @@ class Softcover::BookManifest < OpenStruct
       chapter_file_paths do |chapter_path|
         next if chapter_path =~ /frontmatter/
         unless File.exist?(chapter_path)
-          raise "Chapter file in manifest not found in #{chapter_path}"
+          $stderr.puts "ERROR -- document not built"
+          $stderr.puts "Chapter file '#{chapter_path}'' not found"
+          exit 1
         end
       end
     end

data/lib/softcover/builder.rb

@@ -10,6 +10,7 @@ module Softcover
       @built_files = []
       ensure_style_file_locations
       write_polytexnic_commands_file
+      write_language_customization_file
     end
 
     def build!(options={})
@@ -51,8 +52,35 @@ module Softcover
 
       # Writes out the PolyTeXnic commands from polytexnic.
       def write_polytexnic_commands_file
-        styles_dir = File.join(Dir.pwd, Softcover::Directories::STYLES)
         Polytexnic.write_polytexnic_style_file(styles_dir)
       end
+
+      def write_language_customization_file
+        filename = File.join(styles_dir, 'language_customization.sty')
+        contents = listing_customization
+        File.write(filename, contents)
+      end
+
+      def styles_dir
+        File.join(Dir.pwd, Softcover::Directories::STYLES)
+      end
+
+
+      def listing_customization
+        listing = language_labels["listing"].downcase
+        box     = language_labels["aside"]
+        <<-EOS
+% Aside box label
+\\renewcommand{\\boxlabel}{#{box}}
+
+% Codelisting captions
+\\usepackage[hypcap=false]{caption}
+\\DeclareCaptionFormat{#{listing}}{\\hspace{-0.2em}\\colorbox[gray]{.85}{\\hspace{0.1em}\\parbox{0.997\\textwidth}{#1#2#3}}\\vspace{-1.3\\baselineskip}}
+\\captionsetup[#{listing}]{format=#{listing},labelfont=bf,skip=16pt,font={rm,normalsize}}
+\\DeclareCaptionType{#{listing}}
+\\newcommand{\\codecaption}[1]{\\captionof{#{listing}}{#1}}
+        EOS
+      end
+
   end
 end

data/lib/softcover/builders/epub.rb

@@ -177,20 +177,12 @@ module Softcover
 
       # Returns the PhantomJS executable (if available).
       def phantomjs
-        filename = `which phantomjs`.chomp
-        message  = "Install PhantomJS (http://phantomjs.org/)"
-        @phantomjs ||= executable(filename, message)
+        @phantomjs ||= executable(dependency_filename(:phantomjs))
       end
 
       # Returns the Inkscape executable (if available).
       def inkscape
-        filename = `which inkscape`.chomp
-        if filename.empty?
-          filename = '/Applications/Inkscape.app/Contents/Resources/bin/' +
-                     'inkscape'
-        end
-        message  = "Install Inkscape (http://inkscape.org/)"
-        @inkscape ||= executable(filename, message)
+        @inkscape ||= executable(dependency_filename(:inkscape))
       end
 
       # Strip attributes that are invalid in EPUB documents.
@@ -342,6 +334,7 @@ module Softcover
         <item id="softcover.css" href="styles/softcover.css" media-type="text/css"/>
         <item id="epub.css" href="styles/epub.css" media-type="text/css"/>
         <item id="custom.css" href="styles/custom.css" media-type="text/css"/>
+        <item id="custom_epub.css" href="styles/custom_epub.css" media-type="text/css"/>
         <item id="cover" href="cover.html" media-type="application/xhtml+xml"/>
         #{man_ch.join("\n")}
         #{images.join("\n")}
@@ -401,7 +394,7 @@ module Softcover
       end
 
       def chapter_name(n)
-        n == 0 ? "Frontmatter" : "Chapter #{n}"
+        n == 0 ? language_labels["frontmatter"] : chapter_label(n)
       end
 
       # Returns the nav HTML content.
@@ -440,6 +433,7 @@ module Softcover
           <link rel="stylesheet" href="styles/softcover.css" type="text/css" />
           <link rel="stylesheet" href="styles/epub.css" type="text/css" />
           <link rel="stylesheet" href="styles/custom.css" type="text/css"/>
+          <link rel="stylesheet" href="styles/custom_epub.css" type="text/css"/>
           <link rel="stylesheet" type="application/vnd.adobe-page-template+xml" href="styles/page-template.xpgt" />
         </head>
 

data/lib/softcover/builders/html.rb

@@ -99,7 +99,8 @@ module Softcover
         File.write(chapter.cache_filename, digest(markdown))
         p = Polytexnic::Pipeline.new(markdown,
                                      source: :markdown,
-                                     custom_commands: Softcover.custom_styles)
+                                     custom_commands: Softcover.custom_styles,
+                                     language_labels: language_labels)
         p.polytex
       end
 
@@ -112,8 +113,9 @@ module Softcover
         polytex.gsub!(/(^\s*\\include{(.*?)})/) do
           File.read($2 + '.tex') + "\n"
         end
-        cc = Softcover.custom_styles
-        Polytexnic::Pipeline.new(polytex, custom_commands: cc).to_html
+        Polytexnic::Pipeline.new(polytex,
+                                 custom_commands: Softcover.custom_styles,
+                                 language_labels: language_labels).to_html
       end
 
       # Writes the full HTML file for the book.

data/lib/softcover/builders/mobi.rb

@@ -12,7 +12,7 @@ module Softcover
         else
           system(command)
         end
-        unless options[:kindlegen]
+        if options[:calibre]
           FileUtils.mv("ebooks/#{filename}.azw3", "ebooks/#{filename}.mobi")
           puts "MOBI saved to ebooks/#{filename}.mobi" unless silent
         end
@@ -25,28 +25,21 @@ module Softcover
 
       # Returns the command for making a MOBI, based on the options.
       def mobi_command(filename, options={})
-        if options[:kindlegen]
-          "#{kindlegen} ebooks/#{filename}.epub"
-        else
+        if options[:calibre]
           "#{calibre} ebooks/#{filename}.epub ebooks/#{filename}.azw3"
+        else
+          "#{kindlegen} ebooks/#{filename}.epub"
         end
       end
 
       private
 
         def calibre
-          filename = `which ebook-convert`.chomp
-          url = 'http://calibre-ebook.com/'
-          message  = "Install Calibre (#{url}) and enable command line tools"
-          message += " (http://manual.calibre-ebook.com/cli/cli-index.html)"
-          @calibre ||= executable(filename, message)
+          @calibre ||= executable(dependency_filename(:calibre))
         end
 
         def kindlegen
-          filename = `which kindlegen`.chomp
-          url = 'http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211'
-          message  = "Install kindlegen (#{url})"
-          @kindlegen ||= executable(filename, message)
+          @kindlegen ||= executable(dependency_filename(:kindlegen))
         end
     end
   end

data/lib/softcover/builders/pdf.rb

@@ -5,6 +5,7 @@ module Softcover
       include Softcover::Utils
 
       def build!(options={})
+        make_png_from_gif
         if manifest.markdown?
           # Build the HTML to produce PolyTeX as a side-effect,
           # then update the manifest to reduce PDF generation
@@ -29,7 +30,9 @@ module Softcover
         polytex_filenames = manifest.pdf_chapter_filenames << book_filename
         polytex_filenames.each do |filename|
           polytex = File.read(filename)
-          latex   = Polytexnic::Pipeline.new(polytex).to_latex
+          latex   = Polytexnic::Pipeline.new(polytex,
+                                             language_labels: language_labels).
+                                            to_latex
           if filename == book_filename
             latex.gsub!(/\\include{(.*?)}/) do
               "\\include{#{Softcover::Utils.tmpify(manifest, $1)}.tmp}"
@@ -67,9 +70,25 @@ module Softcover
         # The `xelatex` program is roughly equivalent to the more standard
         # `pdflatex`, but has better support for Unicode.
         def xelatex
-          filename = `which xelatex`.chomp
-          message  = "Install LaTeX (http://latex-project.org/ftp.html)"
-          @xelatex ||= executable(filename, message)
+          @xelatex ||= executable(dependency_filename(:latex))
+        end
+
+        # Make a PNG for each GIF in the images/ directory.
+        def make_png_from_gif
+          gif_pattern = File.join('images', '**', '*.gif')
+          gif_files = Dir.glob(gif_pattern).reject { |f| File.directory?(f) }
+          gif_files.each do |gif|
+            dir = File.dirname(gif)
+            ext = File.extname(gif)
+            img = File.basename(gif, ext)
+            png = File.join(dir, "#{img}.png")
+            system "#{convert} #{gif} #{png}"
+          end
+        end
+
+        # Returns the executable to ImageMagick's `convert` program.
+        def convert
+          @convert ||= executable(dependency_filename(:convert))
         end
 
         # Returns the command to build the PDF (once).

data/lib/softcover/builders/preview.rb

@@ -25,9 +25,7 @@ module Softcover
         end
 
         def ghostscript
-          filename = `which gs`.chomp
-          message  = "Install GhostScript (should come with LaTeX)"
-          @ghostscript ||= executable(filename, message)
+          @ghostscript ||= executable(dependency_filename(:ghostscript))
         end
     end
   end

data/lib/softcover/cli.rb

@@ -42,9 +42,9 @@ module Softcover
                                         desc: "Find overfull hboxes",
                                         type: :boolean
       elsif format == 'mobi'
-        method_option :kindlegen, aliases: '-k',
-                                  desc: "Use kindlegen to build the MOBI",
-                                  type: :boolean
+        method_option :calibre, aliases: '-c',
+                                desc: "Use Calibre to build the MOBI",
+                                type: :boolean
       end
       method_option :quiet, aliases: '-q',
                             desc: "Quiet output", type: :boolean
@@ -67,6 +67,27 @@ module Softcover
       Softcover::Commands::Build.preview(options)
     end
 
+    # ===============================================
+    # Clean
+    # ===============================================
+    desc "clean", "Clean unneeded files"
+    def clean
+      rm(Dir.glob('*.aux'))
+      rm(Dir.glob('*.toc'))
+      rm(Dir.glob('*.out'))
+      rm(Dir.glob('*.tmp.*'))
+      rm(Dir.glob(path('tmp/*')))
+      rm('.highlight_cache')
+    end
+
+    # ===============================================
+    # Check
+    # ===============================================
+    desc "check", "Check dependencies"
+    def check
+      Softcover::Commands::Check.check_dependencies!
+    end
+
     # ===============================================
     # Server
     # ===============================================

data/lib/softcover/commands/build.rb

@@ -2,6 +2,7 @@ module Softcover
   module Commands
     module Build
       include Softcover::Output
+      include Softcover::Utils
       extend self
 
       # Builds the book for the given format.
@@ -17,13 +18,17 @@ module Softcover
       # Builds the book for all formats.
       def all_formats(options={})
         building_message('all formats', options)
-        Softcover::BUILD_ALL_FORMATS.each do |format|
-          if format == 'mobi'
-            building_message('EPUB & MOBI', options)
-          else
-            building_message(format.upcase, options)
+        if custom?
+          build_custom_formats!
+        else
+          Softcover::BUILD_ALL_FORMATS.each do |format|
+            if format == 'mobi'
+              building_message('EPUB & MOBI', options)
+            else
+              building_message(format.upcase, options)
+            end
+            builder_for(format).build!(options)
           end
-          builder_for(format).build!(options)
         end
       end
 
@@ -38,6 +43,24 @@ module Softcover
         "Softcover::Builders::#{format.titleize}".constantize.new
       end
 
+      def custom?
+        File.exist?(build_config) && !custom_commands.empty?
+      end
+
+      def build_custom_formats!
+        execute custom_commands
+      end
+
+      # Returns custom commands (if any).
+      def custom_commands
+        commands(File.readlines(build_config).map(&:strip))
+      end
+
+      # Returns the filename for configuring `softcover build`.
+      def build_config
+        '.softcover-build'
+      end
+
       private
 
         # Shows a message when building a particular format.

data/lib/softcover/commands/check.rb

@@ -0,0 +1,103 @@
+module Softcover
+  module Commands
+    module Check
+      extend self
+      extend Softcover::Utils
+
+      def check_dependencies!
+        puts "Checking Softcover dependencies..."
+        simulate_work(1)
+        missing_dependencies = []
+        dependencies.each do |label, name|
+          printf "%-30s", "Checking for #{name}..."
+          simulate_work(0.15)
+          if present?(label)
+            puts "Found"
+          else
+            missing_dependencies << label
+            puts "Missing"
+          end
+          simulate_work(0.1)
+        end
+        simulate_work(0.25)
+        if missing_dependencies.empty?
+          puts "All dependencies satisfied."
+        else
+          puts "Missing dependencies:"
+          missing_dependencies.each do |dependency|
+            puts "  • " + missing_dependency_message(dependency)
+          end
+        end
+      end
+
+      def dependencies
+        [[:latex,       'LaTeX'],
+         [:ghostscript, 'GhostScript'],
+         [:convert,     'ImageMagick'],
+         [:node,        'Node.js'],
+         [:phantomjs,   'PhantomJS'],
+         [:inkscape,    'Inkscape'],
+         [:calibre,     'Calibre'],
+         [:kindlegen,   'KindleGen'],
+         [:java,        'Java'],
+         [:epubcheck,   'EpubCheck'],
+        ]
+      end
+
+      def dependency_labels
+        dependencies.map(&:first)
+      end
+
+      def dependency_names
+        dependencies.map { |e| e[1] }
+      end
+
+      def missing_dependency_message(label)
+        case label
+        when :latex
+          message  = "LaTeX (http://latex-project.org/ftp.html)\n"
+          message += "      ∟ Huge download—start it now!"
+        when :convert
+          "ImageMagick (http://www.imagemagick.org/script/binary-releases.php)"
+        when :node
+          "NodeJS (http://nodejs.org/)"
+        when :phantomjs
+          "PhantomJS (http://phantomjs.org/)"
+        when :kindlegen
+          url = 'http://www.amazon.com/gp/feature.html?ie=UTF8&docId=1000765211'
+          "KindleGen (#{url})"
+        when :calibre
+          url = 'http://calibre-ebook.com/'
+          message  = "Calibre (#{url})\n"
+          message += "      ∟ Enable Calibre command-line tools"
+          message += " (http://manual.calibre-ebook.com/cli/cli-index.html)"
+        when :java
+          url = 'http://www.java.com/en/download/help/index_installing.xml'
+          "Java (#{url})"
+        when :ghostscript
+          "GhostScript (should come with LaTeX)"
+        when :epubcheck
+          url  = 'https://github.com/IDPF/epubcheck/releases/'
+          url += 'download/v3.0/epubcheck-3.0.zip'
+          message  = "EpubCheck 3.0 (#{url})\n"
+          message += "      ∟ Unzip EpubCheck into your home directory"
+        when :inkscape
+          message  = "Inkscape (http://inkscape.org/)"
+        else
+          raise "Unknown label #{label}"
+        end
+      end
+
+      def present?(label)
+        File.exist?(dependency_filename(label))
+      end
+
+      # Simulate working for given time.
+      # `softcover check` is more satisfying if it looks like it's doing work.
+      def simulate_work(time)
+        sleep time unless Softcover::test?
+      end
+
+    end
+  end
+end

data/lib/softcover/commands/deployment.rb

@@ -30,13 +30,6 @@ module Softcover
       def deploy_config
         '.softcover-deploy'
       end
-
-      # Returns the commands from the given lines.
-      # We skip comments and blank lines.
-      def commands(lines)
-        skip = /(^\s*#|^\s*$)/
-        lines.reject { |line| line =~ skip }.join("\n")
-      end
     end
   end
 end

data/lib/softcover/commands/epub_validator.rb

@@ -14,17 +14,11 @@ module Softcover
       private
 
         def java
-          filename = `which java`.chomp
-          url = 'http://www.java.com/en/download/help/index_installing.xml'
-          message = "Install Java (#{url})"
-          @java ||= executable(filename, message)
+          @java ||= executable(dependency_filename(:java))
         end
 
         def epubcheck
-          filename = File.join(Dir.home, 'epubcheck-3.0', 'epubcheck-3.0.jar')
-          url = 'https://github.com/IDPF/epubcheck/releases/download/v3.0/epubcheck-3.0.zip'
-          message = "Download EpubCheck 3.0 (#{url}) and unzip it in your home directory"
-          @epubcheck ||= executable(filename, message).inspect
+          @epubcheck ||= executable(dependency_filename(:epubcheck)).inspect
         end
     end
   end

data/lib/softcover/sanitizer.rb

@@ -29,7 +29,11 @@ module Softcover
           'img'  => %w{id class src alt},
           'em'   => %w{id class},
           'code' => %w{id class},
-          'strong' => %w{id class}
+          'strong' => %w{id class},
+          'table'   => %w{id class},
+          'tbody'   => %w{id class},
+          'tr'   => %w{id class},
+          'td'   => %w{id class}
         },
         protocols: {
           'a'   => {'href' => [:relative, 'http', 'https', 'mailto']},

data/lib/softcover/template/.softcover-build

@@ -0,0 +1,6 @@
+# Edit this file to customize your build steps with custom command options
+# or additional commands.
+#
+# softcover build:pdf
+# softcover build:mobi
+# softcover build:preview

data/lib/softcover/template/chapters/a_chapter.md

@@ -75,6 +75,12 @@ Softcover supports the inclusion of images, like this:
 
 ![Some dude.](images/2011_michael_hartl.png)
 
+Using \LaTeX\ labels, you can also include a caption (as in Figure~\ref{fig:captioned_image}) or just a figure number (as in Figure~\ref{fig:figure_number}).
+
+![Some dude.\label{fig:captioned_image}](images/2011_michael_hartl.png)
+
+![\label{fig:figure_number}](images/2011_michael_hartl.png)
+
 ### Tables
 
 Softcover supports raw tables via a simple table syntax:
@@ -88,6 +94,7 @@ Softcover supports raw tables via a simple table syntax:
 | `PATCH` | /users/1 | `update` | update user with id `1` |
 | `DELETE` | /users/1 | `destroy` | delete user with id `1` |
 
+See [*The Softcover Book*](http://manual.softcover.io/book/softcover_markdown#sec-embedded_tabular_and_tables) to learn how to make more complicated tables.
 
 ## Command-line interface
 
@@ -102,17 +109,9 @@ Commands:
   softcover build:mobi                 # Build MOBI
   softcover build:pdf                  # Build PDF
   softcover build:preview              # Build book preview in all formats
-  softcover config                     # View local config
-  softcover config:add key=value       # Add to your local config vars
-  softcover epub:validate, epub:check  # Validate EPUB with epubcheck
-  softcover help [COMMAND]             # Describe available commands...
-  softcover login                      # Log into Softcover account
-  softcover logout                     # Log out of Softcover account
-  softcover new <name>                 # Generate new book directory structure.
-  softcover open                       # Open book on Softcover website (OS X)
-  softcover publish                    # Publish your book on Softcover
-  softcover publish:screencasts        # Publish screencasts
-  softcover server                     # Run local server
+  .
+  .
+  .
 ```
 
 \noindent You can run `softcover help <command>` to get additional help on a given command: