bookshop 0.0.19 → 0.0.21

data/README.rdoc

@@ -1,12 +1,18 @@
-== Welcome to bookshop
+=== http://blueheadpublishing.github.com/bookshop/assets/logo.png
 
-bookShop is a publishing framework for html-to-pdf/(e)book toolchain happiness and sustainable productivity. The framework is optimized to help developers quickly ramp-up, allowing them to more rapidly jump in and develop their html-to-pdf/(e)book (print-pdf, epub, mobi, etc.) flows, by favoring convention over configuration, setting them up with best practices, standards and tools from the start.
+    "a book publishing framework for today's publishing world"
+	
+bookshop is a book publishing framework for publishers, editors, and coders in today's publishing industry. bookshop provides a framework for developing books using well-known/standard web languages like HTML/CSS, which are then converted into pdf and other (e)book formats. The framework is optimized to help developers quickly ramp-up, allowing them to jump in and develop their html-to-pdf/(e)book flows, by favoring convention over configuration, setting them up with best-practices, standards and tools from the start.
 
 bookshop hopes to simplify the process by:
-* using common tools like HTML, CSS, etc. to make the creation of your book comfortable and familiar, greatly reducing the learning curve for your developers, authors, agents, and other team members
-* providing a Ruby Gem to make building a book from HTML as easy as 'gem install bookshop'
+* separating the book into layers
+  * *Content*: the book's source - <i>writings, images, videos, copy</i>
+  * *Structure*: using div/css microformat to describe the book's structure - <i>chapter, section, etc.</i>
+  * *Style*: stylesheets to create the book's layout - <i>fonts, margins, color, etc.</i>
+* using common tools like HTML/CSS to make the creation of your book comfortable and familiar, greatly reducing the learning curve for your developers, authors, agents, and other team members
+* providing a Ruby Gem to make building a book in HTML as easy as 'gem install bookshop'
 * pulling all the html-to-pdf/(e)book tools together into one place (wkhtmltopdf, kindlegen, epubcheck)
-* sticking with open-source tools
+* sticking with open-source tools to encourage community development
 * giving the developer a set of scripts to automate the redundant stuff
 * providing an architecture/structure that follows best-practices and simplification (DRY... Don't Repeat Yourself)
 
@@ -14,8 +20,7 @@ bookshop hopes to simplify the process by:
 
 === System Requirements
 
-* Ruby v1.8.7 or v1.9.2 http://www.ruby-lang.org/en/downloads/
-* Rubygems v1.3.6 http://docs.rubygems.org/read/chapter/3
+* Ruby v1.8.7 or higher http://www.ruby-lang.org/en/downloads/
 
 == Installation
 
@@ -25,13 +30,13 @@ bookshop hopes to simplify the process by:
 
 === Install wkhtmltopdf
 
-1. Install by hand (recommended):
+1. Try using the wkhtmltopdf-binary gem (mac + linux i386)
 
-https://github.com/blueheadpublishing/bookshop/wiki/Installing-wkhtmltopdf
+    $ gem install wkhtmltopdf-binary
 
-2. Try using the wkhtmltopdf-binary gem (mac + linux i386)
+2. Install by hand (for windows or users who want to install newer builds):
 
-    $ gem install wkhtmltopdf-binary
+https://github.com/blueheadpublishing/bookshop/wiki/Installing-wkhtmltopdf
 
 3. The wkhtmltopdf site has more info
 
@@ -39,18 +44,30 @@ https://github.com/blueheadpublishing/bookshop/wiki/Installing-wkhtmltopdf
 
 == Using bookshop
 
-=== Create a bookshop application
+=== Create a bookshop book
 
-    $ bookshop new name_of_book
+    $ bookshop new my_new_book
 
-	This will create a new bookshop app in /path/to/name_of_book
-	
-* If you can't issue bookshop from your command line, make sure you have included your gems folder in your system $PATH. In unix you can add the following to your .bashrc file in your home folder (this example is for Ubuntu 10.10):
+	This will create a new bookshop book in /path/to/my_new_book with the following structure:
+
+    |-- book/                 # Source files for your book
+        |--book.html.erb      # The master file
+        |--css/
+            |--stylesheet.css
+        |--images/
+
+    |-- builds/               # All the builds are created here
+        |--epub/
+        |--html/
+        |--mobi/
+        |--pdf/
+
+    |-- config/               # Your config and data settings
+        |--book.yml           # Settings/Data for your book
 
-  PATH="$PATH:/var/lib/gems/1.8/bin"
-  export PATH
 
 === Editing Your New Book
+
 ==== Where does my Book really live?
 
 All of the source documents and assets for your book are stored in the +book/+ folder. So your stylesheets, images, text - everything used for building your book - lives here. Ideally, you should only every edit files in your +book/+ folder (with the exception of your config/book.yml file).
@@ -59,23 +76,15 @@ All of the source documents and assets for your book are stored in the +book/+ f
 
 The source files are all in ERB. ERB is a templating language for the Ruby programming language. Why is this cool? Because it means that you can use HTML _and_ you can embed Ruby code in your source files. In other words, you can do all kinds of cool programmy things. Like embed ruby functions and calls:
 
-    <p>Today is <%= Time.now.strftime('%A') %>.</p>
-
-  or
+    <p>Today is <%= Time.now.strftime('%A') %>.</p>  # creates -> <p>Today is Thursday.</p>
 
-    items = [ "ball", "stick", "corgi" ]
-
-    <ul>
-      <% items.each do |item| %>
-        <li><%= item %></li>
-      <% end %>
-    </ul>
+More information on ERB - http://www.ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html
 
 ==== One File to Rule Them All!
 
 Your master file (which is used to build everything) is the +book.html.erb+ file (remember that we are in the +book/+ folder). You could of course just use this file and put all of your book contents here, making one enormous file, but we don't recommend it... 
 
-==== The Magic of include()
+==== The Magic of import()
 
 Are you writing another "War and Peace"? We've created a nice way to make your epic book easier to manage. Rather than putting everything in the +book.html.erb+ file, you can +import+ files. This allows you to break your book up into smaller, more manageable pieces. This makes it soooooo much easier to manage your book. And others will thank you for it..
 
@@ -147,9 +156,9 @@ Here's an example +config/book.yml+ file with some Book Variables:
 
 You can then use these Book Variables in your book source file:
     
-    <p>The book isbn is <%= book.isbn %></p>
-    <p>The html title is <%= book.html.title %></p>
-    <p>The epub pub_date is <%= book.epub.pub_date %></p>
+    <p>The book isbn is <%= @book.isbn %></p>
+    <p>The html title is <%= @book.html.title %></p>
+    <p>The epub pub_date is <%= @book.epub.pub_date %></p>
 
 Note that you can construct and/or nest variables however you want to:
 
@@ -162,7 +171,7 @@ Note that you can construct and/or nest variables however you want to:
 
 Then call it in your source file with the variable:
 
-    <p>My made up friend's name is <%= book.my.madeup.friend.name %>
+    <p>My made up friend's name is <%= @book.my.madeup.friend.name %>
 
 More info about YAML:
 
@@ -172,30 +181,68 @@ http://en.wikipedia.org/wiki/YAML
 
 So, do you want to see something cool? Now that we have the Output Variable and Book Variables, we can combine them to do nifty things, like:
 
-    <p>The ISBN is <%= book.isbn %></p>
+    <p>The ISBN is <%= @book.isbn %></p>
     <p>Title: 
       <% if @output == :html %>
-        <%= book.html.title %>
+        <%= @book.html.title %>
       <% elsif @output == :pdf %>
-        <%= book.pdf.title %>
+        <%= @book.pdf.title %>
       <% elsif @output == :epub %>
-        <%= book.epub.title %>
+        <%= @book.epub.title %>
       <% end %>
     </p>
 
 Please explore other creative ways to structure and enhance your book (we'd love to see how you are doing it).
 
-http://www.ruby-doc.org/stdlib-1.9.3/libdoc/erb/rdoc/ERB.html
-
 === Building Your First Book
 
+To build an HTML format of your book from the ERB source:
+
+    $ bookshop build html   # -> find the output in builds/html/book_(date).html
+
 To build a pdf format of your book from the ERB source:
 
     $ bookshop build pdf    # -> find the output in builds/pdf/book_(date).pdf
 
-To build an HTML format of your book from the ERB source:
+==== Editing your pdf document options
 
-    $ bookshop build html   # -> find the output in builds/html/book_(date).html
+What if you want your pdf to print as Lanscape, or a different page-size, or in grayscale? Because bookshop uses PDFKit, you can pass wkhtmltopdf (the pdf rendering engine) options by way of <meta> tags in your html source code.
+
+For example, to print in Landscape mode, in your master +book/book.html.erb+ file we can add <meta name="pdfkit-orientation" content="Landscape" />:
+
+so you html would be:
+
+    <html>
+      <head>
+        <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
+        <meta name="pdfkit-orientation" content="Landscape" />
+        <title>how-to bookshop</title>
+        <link rel="stylesheet" type="text/css" href="css/stylesheet.css" />
+      </head>
+    <body>
+    <p>The ISBN is <%= @book.isbn %></p>
+
+Here's a list of other options https://github.com/blueheadpublishing/bookshop/wiki/wkhtmltopdf-options
+
+Or you can look at all of the possible wkhtmltopdf options by using the command:
+
+    $ wkhtmltopdf --extended-help
+
+Your meta tags should use the following naming conventions. 
+
+* For each option, replace the double-dashes '--' before the option with +pdfkit-+ and change single-dashes '-' to an underscore +_+.
+    --page-size
+
+    becomes
+
+    <meta name="pdfkit-page_size" content="Letter" />
+
+* For options that do not require an additional parameter/value, you still need to include the content attribute, but keep it blank.
+    --grayscale
+
+    becomes
+
+    <meta name="pdfkit-grayscale" content="" />
 
 == Example Book
 
@@ -213,14 +260,20 @@ You can then build the book into whatever format you like.
 
 The default directory structure of a generated bookshop project:
 
-  |-- book
-  |-- builds
-    epub
-    html
-    mobi
-    pdf
+    |-- book/                 # Source files for your book
+        |--book.html.erb      # The master file
+        |--css/
+            |--stylesheet.css
+        |--images/
+
+    |-- builds/               # All the builds are created here
+        |--epub/
+        |--html/
+        |--mobi/
+        |--pdf/
 
-  |-- config
+    |-- config/               # Your config and data settings
+        |--book.yml           # Settings/Data for your book
 
 book
   Holds all the manuscript html code/files. This is where your master manuscript lives from which everything is built.
@@ -249,9 +302,45 @@ config
 6. Let us know about your code and we'll review/merge it into the master.
 7. And pat yourself on the back for contributing to an open source project!!
 	
-== Copyright (MIT-LICENSE)
+== Copyright (LICENSE)
+
+BookShop is available under *either* the terms of the modified BSD license *or* the
+MIT License (2008). As a recipient of BookShop, you may choose which
+license to receive this code under (except as noted in per-module LICENSE
+files). Some modules may not be the copyright of BlueHead Publishing. These
+modules contain explicit declarations of copyright in both the LICENSE files in
+the directories in which they reside and in the code itself. No external
+contributions are allowed under licenses which are fundamentally incompatible
+with the MIT or BSD licenses that BookShop is distributed under.
+
+The text of the MIT and BSD licenses is reproduced below.
+
+=== The "New" BSD License
+
+Copyright (c) 2010-2011, BlueHead Publishing
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Bookshop/BlueHead/BlueHead Publishing nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+=== The MIT License
 
-Copyright (C) 2010, 2011 by BlueHead Publishing, Inc (http://blueheadpublishing.com)
+Copyright (c) 2010, 2011 BlueHead Publishing, et. al.,
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -273,9 +362,9 @@ THE SOFTWARE.
 
 == The Boom Microformat License (as listed in the boom.css)
 
-  Sample style sheet for boom!, the book microformat
-  written  by Hakon Wium Lie and Bert Bos, November 2005
-  You may reuse this style sheet for any purpose without any fees
+Sample style sheet for boom!, the book microformat
+written  by Hakon Wium Lie and Bert Bos, November 2005
+You may reuse this style sheet for any purpose without any fees
 
 == Thanks
 

data/lib/bookshop/commands/build.rb

@@ -2,9 +2,13 @@ require 'thor/group'
 require 'erb'
 require 'fileutils'
 require 'yaml'
+require 'PDFKit'
 
 require 'bookshop/commands/yaml/book'
 
+# require 'bookshop/commands/yaml/toc'
+# require 'bookshop/commands/epub/epub_build'
+
 module Bookshop
   module Commands
 
@@ -12,6 +16,12 @@ module Bookshop
     class Build < Thor::Group
       include Thor::Actions
       
+      BOOK_SOURCE = 'book.html.erb'
+      
+      def initialize
+        @book = []
+      end
+      
       ARGV << '--help' if ARGV.empty?
 
       aliases = {
@@ -31,19 +41,23 @@ module Bookshop
         File.dirname(__FILE__)
       end
 
+      # Load YAML files
+      def self.load_yaml_files
+        # Load the book.yml into the Book object
+        @book = Book.new(YAML.load_file('config/book.yml'))
+        # @toc = Toc.new(YAML.load_file('config/toc.yml'))
+      end
+
       # Renders <%= import(source.html.erb) %> files with ERB
       # 
       # When a new import() is encountered within source files it is
       #    processed with this method and the result is added to 'erb'
       def self.import(file)
-        
-        # Load the book.yml into the Book object
-        book = Book.new(YAML.load_file('config/book.yml'))
-        
+        load_yaml_files
         # Parse the source erb file
         ERB.new(File.read('book/'+file)).result(binding).gsub(/\n$/,'')
       end
-      
+
       case build
       
       # 'build html' generates a html version of the book from the
@@ -56,7 +70,7 @@ module Bookshop
         FileUtils.rm_r Dir.glob('builds/html/*')
         
         @output = :html
-        erb = import('book.html.erb')
+        erb = import(BOOK_SOURCE)
         puts "Generating new html from erb"
         File.open("builds/html/book.html", 'a') do |f|
           f << erb
@@ -68,13 +82,14 @@ module Bookshop
       # 'build pdf' generates a pdf version of the book from the builds/html/book.html
       #    which is generated from the book/book.html.erb source file
       when 'pdf'
+        
         # Clean up any old builds
         puts "Deleting any old builds"
         FileUtils.rm_r Dir.glob('builds/pdf/*')
         FileUtils.rm_r Dir.glob('builds/html/*')
         
         @output = :pdf
-        erb = import('book.html.erb')
+        erb = import(BOOK_SOURCE)
         # Generate the html from ERB
         puts "Generating new html from erb"
         File.open('builds/html/book.html', 'a') do |f|
@@ -85,9 +100,20 @@ module Bookshop
         FileUtils.cp_r('book/css/', 'builds/html/', :verbose => true)
         FileUtils.cp_r('book/images/', 'builds/html/', :verbose => true)
 
-        # Builds the pdf from builds/html/book.html
-        puts "Building new pdf at builds/pdf/book.pdf from new html build"
-        cmd = %x[wkhtmltopdf builds/html/book.html builds/pdf/book.pdf]
+
+        # PDFKit.new takes the HTML and any options for wkhtmltopdf
+        # run `wkhtmltopdf --extended-help` for a full list of options
+        kit = PDFKit.new(File.new('builds/html/book.html'))
+
+        # Git an inline PDF
+        pdf = kit.to_pdf
+
+        # Save the PDF to a file
+        file = kit.to_file('builds/pdf/book.pdf')
+        
+      #when 'epub'
+       # require 'bookshop/commands/epub/epub_build'
+        #EpubBuild.new
         
       else
         puts "Error: Command not recognized" unless %w(-h --help).include?(build)

data/lib/bookshop/commands/epub/epub_build.rb

@@ -0,0 +1,67 @@
+require 'thor/group'
+require 'erb'
+require 'yaml'
+
+
+require 'bookshop/commands/yaml/book'
+
+module Bookshop
+  module Commands
+
+    # Builds the EPUB version of the book
+    class EpubBuild < Thor::Group
+      include Thor::Actions
+      
+      # Define source root of application
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+        
+
+      
+      def clean_up
+        puts "Deleting any old builds"
+        FileUtils.rm_r Dir.glob('builds/epub/*')
+        FileUtils.rm_r Dir.glob('builds/html/*')
+      end
+      
+      def compile_erb_source
+        @output = :epub
+        
+        erb = import(BOOK_SOURCE)
+
+        # Generate the html from ERB
+        puts "Building new epub at builds/epub/book.epub"
+        File.open('builds/epub/OEBPS/book.html', 'a') do |f|
+          f << erb
+        end
+        FileUtils.cp_r('book/css/', 'builds/epub/OEBPS/', :verbose => true)
+        FileUtils.cp_r('book/images/', 'builds/epub/OEBPS/', :verbose => true)
+      end
+      
+      # Load the book.yml into the Book object
+      @book = Book.new(YAML.load_file('config/book.yml'))
+      @toc = Toc.new(TAML.load_file('config/table_of_contents.yml'))
+      
+      def create_epub_structure
+        directory "templates/epub", "builds/epub"
+      end
+      
+      def generate_content_opf_file
+        template "templates/content.opf.tt" "builds/epub/OEBPS"
+      end
+
+      def generate_toc
+        template "templates/toc.ncs.tt" "builds/epub/OEBPS"
+      end
+      
+      def zip_epub
+        # zip the contents into book.epub
+      end
+      
+      def validate_epub
+        # cmd = %x[tools/epubcheck book_#{Time.now.strftime('%m-%e-%y').epub]
+      end
+    end
+  end
+end