bookshop 0.0.4 → 0.0.9

data/DISTRIBUTION

@@ -0,0 +1,21 @@
+db
+	mobi
+		kindle
+	epub
+		nook
+		iBookstore
+		google ebook
+	html
+    web
+    phonegap
+			iOS
+			Android
+			webOS
+			Symbian
+			Blackberry
+	pdf
+		lightningsource
+			amazon
+			b&n
+			intl
+

data/POST_INSTALL

@@ -0,0 +1,19 @@
+******************************************************************
+
+Install wkhtmltopdf:
+
+1. Install by hand (recomended):
+
+        https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF
+
+2. Try using the wkhtmltopdf-binary gem (mac + linux i386)
+
+        gem install wkhtmltopdf-binary
+
+3. The wkhtmltopdf site has more info
+
+				http://code.google.com/p/wkhtmltopdf/
+
+
+
+******************************************************************

data/README.rdoc

@@ -1,88 +1,75 @@
 == Welcome to bookshop
 
-bookShop is an OSS ruby-based framework for docbook 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 DocBook-to-Output flows, by favoring convention over configuration, setting them up with best practices from the get-go.
+bookShop is an OSS ruby-based framework for html-to-(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-(e)book flows, by favoring convention over configuration, setting them up with best practices from the get-go.
 
 bookshop hopes to simplify the process by:
-* providing a Ruby Gem to make working with DocBook as easy as 'sudo gem install bookshop'
-* pulling all the DocBook tools together into one place (DocBook DTD, XSL Stylesheets, XSLT Processor, XSL-FO Processor)
+* providing a Ruby Gem to make building a book from HTML as easy as 'sudo gem install bookshop'
+* pulling all the html-to-(e)book tools together into one place (wkhtmltopdf, kindlegen, epubcheck)
+* sticking with open-source tools
 * 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)
 * providing an extendable framework for other developers to add their own custom templates (and hopefully provide them for the community)
 
 == Getting Started
 
-Some Useful Links For Docs, Info, Resources to help use use bookshop, or contribute as a developer to this gem.
-
-http://www.delicious.com/blueheadpublishing/bookshop
-
 === 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
 * Java v1.6 http://www.java.com/
 
+== Installation
+
 === Install bookshop
 
     $ sudo gem install bookshop
 
-=== Create a bookshop application
+=== Install wkhtmltopdf
 
-    $ bookshop new name_of_application
+1. Install by hand (recommended):
 
-	This will create a new bookshop app in /path/to/name_of_application
-	
-* 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):
+    https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF
 
-		PATH="$PATH:/var/lib/gems/1.8/bin"
-		export PATH
+2. Try using the wkhtmltopdf-binary gem (mac + linux i386)
 
-	
-=== Install the java tools. All of the java tools (.jars, etc) can be found in /tools/java/ in the new application.
+    gem install wkhtmltopdf-binary
+
+3. The wkhtmltopdf site has more info
+
+    http://code.google.com/p/wkhtmltopdf/
 
-* For Mac you should copy the contents of /tools/java/ into your system /Library/Java/Extensions or your user ~/Library/Java/Extensions folder. This is the default location for the Java Classpath
+== Using bookshop
 
-* For *nix systems, you can define your classpath by creating a CLASSPATH variable in your .bashrc (or whatever shell/profile you are using). This example is for Ubuntu 10.10. Make sure to substitute:
+=== Create a bookshop application
 
-		CLASSPATH="/path/to/name_of_application/tools/java/fop.jar:\
-		/path/to/name_of_application/tools/java/avalon-framework-4.2.0.jar:\
-		/path/to/name_of_application/tools/java/xalan.jar:\
-		/path/to/name_of_application/tools/java/batik-all-1.7.jar:\
-		/path/to/name_of_application/tools/java/commons-io-1.3.1.jar:\
-		/path/to/name_of_application/tools/java/commons-logging-1.0.4.jar:\
-		/path/to/name_of_application/tools/java/fop-hyph.jar:\
-		/path/to/name_of_application/tools/java/jai-codec.jar:\
-		/path/to/name_of_application/tools/java/jai_core.jar:\
-		/path/to/name_of_application/tools/java/serializer.jar:\
-		/path/to/name_of_application/tools/java/xercesImpl.jar:\
-		/path/to/name_of_application/tools/java/xml-apis.jar:\
-		/path/to/name_of_application/tools/java/xmlgraphics-commons-1.4.jar"
-		export CLASSPATH
+    $ bookshop new name_of_book
 
-* For Windows systems you can either use Cygwin and follow the directions for *nix systems above, or edit your Classpath via the Control Panel
+	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):
+
+  PATH="$PATH:/var/lib/gems/1.8/bin"
+  export PATH
 
 === Building Your First Book
 
-To build a pdf format of your book from the docbook source:
+To build a pdf format of your book from the html source:
 
     bookshop build pdf
-	
-To build an epub format of your book from the docbook source:
-
-    bookshop build epub
 
 == Getting Help
 
-* Checkout the wiki page which is in development currently for installation help and links to other articles and help content. https://github.com/worlduniting/bookshop/wiki
-
 * bookshop comes with a built in help feature. Simply run 'bookshop --help' from the command line to get list of possible commands to issue including possible options. You can also run 'bookshop COMMAND --help' (where COMMAND is the command you want) to get a list of possible options for that particular command
 
 == Thanks
 
 We would like to thank:
 
-* The Xerces Team
-* The DocBook Team
-* The Ruby/Rubygems Team
+* The Ruby/Rubygems Team www.ruby-lang.org/
+* The Thor Team - https://github.com/wycats/thor
+* Hakon Wium Lie and Bert Bos for developing the book microformat http://www.alistapart.com/articles/boom
+* The WKHTMLTOPDF team http://code.google.com/p/wkhtmltopdf/
+* The EPUBCHECK team http://code.google.com/p/epubcheck/
 
 == Description of Gem Contents
 
@@ -92,54 +79,46 @@ The basic bookshop gem architecture:
   |-- lib
 
 bin
-	command file copied to /usr/bin upon installation (which is then called from the command line)
-	
+  command file copied to /usr/bin upon installation (which is then called from the command line)
+
 lib
-	bookshop gem library files
+  bookshop gem library files
 
 == Description of bookshop app contents
 
-The default directory structure of a generated bookshop app:
+The default directory structure of a generated bookshop project:
 
-	|-- book
-	|-- builds
-	|   |-- epub
-	|   |-- html
-	|   |-- mobi
-	|	  `-- pdf
-	|-- stylesheets
-	|-- tools
-	|   |-- dtd
-	|   |-- xsl
-	|   `-- java
+  |-- book
+  |-- builds
+    epub
+    html
+    mobi
+    pdf
+
+  |-- stylesheets
+  |-- tools
 
 book
-  Holds all the manuscript DocBook code/files. This is where your master manuscript lives from which everything is built.
+  Holds all the manuscript html code/files. This is where your master manuscript lives from which everything is built.
 
 builds
-  Holds all the output files built from the DocBook using their specific Stylesheets
+  Holds all the output files built from the html
 
 builds/epub
-	When building the epub, the generated output will reside here in an .epub file. You can rename the .epub extension to .zip then unzip the file to view the contents.
+  When building the epub, the generated output will reside here in an .epub file. You can rename the .epub extension to .zip then unzip the file to view the contents.
 
-builds/html
-	When building the html asset, the generated output will reside here.
-	
 build/mobi
-	When building the mobi asset, the generated output will reside here as "book.mobi".
+  When building the mobi asset, the generated output will reside here as "book.mobi"
 
 build/pdf
-	When building the pdf book, the generated output will reside here as "book.pdf".
-
-stylesheets
-	Holds the XSL stylesheets for customizing your book output.
+  When building the pdf book, the generated output will reside here as "book.pdf"
 	
 tools
-	Holds the DocBook DTD, DocBook-XSL specs and Java tools which serve as the base for building formats. Customization should not happen here, but rather with the stylesheets in the "stylesheets" folder. Files here should remain largely unchanged unless you know what you are doing.
+  Holds the epubcheck and kindlegen tools
 	
 == Copyright (MIT-LICENSE)
 
-Copyright (C) 2010, 2011 by World Uniting (http://worlduniting.org)
+Copyright (C) 2010, 2011 by BlueHead, Inc (http://blueheadinc.com)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -157,4 +136,10 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+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

data/bookshop.gemspec

@@ -8,12 +8,12 @@ Gem::Specification.new do |s|
   s.authors     = ['D.a. Thompson']
   s.email       = ['git@worlduniting.org']
   s.homepage    = "http://rubygems.org/gems/bookshop"
-  s.summary     = "An OSS Ruby-Based Framework for DocBook Toolchain Happiness and Sustainable Productivity."
+  s.summary     = "An OSS Ruby-Based Framework for HTML-TO-(e)BOOK Toolchain Happiness and Sustainable Productivity for Publishing Houses."
   s.description = "bookShop is an OSS ruby-based framework for docbook 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 DocBook-to-Output flows, by favoring convention over 
+                    jump in and develop their HTML-TO_(e)BOOK flows, by favoring convention over 
                     configuration, setting them up with best practices, standards and
-                    tools from the get-go. This gem is brought to you by World Uniting Press, a division of World Uniting."
+                    tools from the get-go. This gem is brought to you by D.a. Thompson."
 
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "bookshop"

data/lib/bookshop/commands/build.rb

@@ -2,6 +2,7 @@ require 'thor/group'
 
 module Bookshop
   module Commands
+    # Define build commands for bookshop command line
     class Build < Thor::Group
       include Thor::Actions
       
@@ -28,22 +29,28 @@ module Bookshop
         File.delete("builds/pdf/book.pdf") if File::exists?( "builds/pdf/book.pdf" )
         puts "File Deleted"
         puts "Building new pdf at builds/pdf/book.pdf"
-        cmd = %x[java -jar tools/java/fop.jar -xml book/book.xml -xsl stylesheets/fo-stylesheet.xsl builds/pdf/book.pdf]
+        cmd = %x[wkhtmltopdf book/book.html builds/pdf/book.pdf]
+        # cmd = %x[wkhtmltopdf #{SRC_FILE} #{OUT_FILE}]
       
-      when 'epub'
+      # when 'epub'
         puts "Deleting any old builds"
         File.delete("builds/epub/book.epub") if File::exists?( "builds/epub/book.epub" )
         puts "File Deleted"
         
         puts "Building new epub at builds/epub/book.epub"
-        cmd = %x[tools/xsl/epub/bin/dbtoepub -v book/book.xml -o builds/epub/book.epub]
+        
+        # create temp epub folder
+        # create folder META_INF with container...
+        # create folder OEBPS, copy html over
+        # create mimetype
+        
+        cmd = %x[cd book/ && zip -X0 "../builds/epub/book.epub" mimetype && zip -rDX9 "../builds/epub/book.epub" * -x "*.DS_Store" -x mimetype]
         
         puts "Validating epub"
-        cmd = %x[java -jar tools/java/epubcheck-1.2.jar builds/epub/book.epub]
+        cmd = %x[java -jar tools/epubcheck-1.2.jar builds/epub/book.epub]
 
       
-      # fix this
-      when 'mobi'
+      # when 'mobi'
         puts "Deleting any old builds"
         File.delete("builds/mobi/book.*") if File::exists?( "builds/mobi/book.*" )
         puts "File Deleted"
@@ -55,7 +62,7 @@ module Bookshop
         cmd = %x[java -jar tools/java/epubcheck-1.2.jar builds/mobi/book.epub]
         
         puts "Generating mobi file at builds/mobi/book.mobi"
-        cmd = %x[tools/kindle/kindlegen builds/mobi/book.epub]
+        cmd = %x[rm ../book.* && epubmake && epubcheck && /Applications/Kindle/KindleGen/kindlegen ../book.epub]
         
         puts "Cleaning up..."
         File.delete("builds/mobi/book.epub") if File::exists?( "builds/mobi/book.epub" )

data/lib/bookshop/commands.rb

@@ -21,9 +21,9 @@ else
 Usage: bookshop COMMAND [ARGS]
 
 The most common bookshop commands are:
- build       Builds a new book from your docbook based upon arguments passed (short-cut alias: "b")
- new         Create a new bookshop project. "bookshop new my_app" creates a
-             new project called MyProject in "./my_project"
+ build       Builds a new book from your html based upon arguments passed (short-cut alias: "b")
+ new         Create a new bookshop project. "bookshop new name_of_book" creates a
+             new book project called NameOfBook in "./name_of_book"
 
 All commands can be run with -h for more information.
   EOT

data/lib/bookshop/generators/bookshop/app/app_generator.rb

@@ -8,14 +8,7 @@ module Bookshop
       include Thor::Actions
 
       # Define arguments and options
-      argument :app_path,                   :type => :string
-                                        
-
-      class_option :dtd,                :type => :string, :aliases => "-dtd",
-                                        :desc => "DTD version [ 4.5, 5.0 ]", :default => "4.5"
-
-      class_option :xsl,                :type => :string, :aliases => "-xsl",
-                                        :desc => "DocBook-XSL version [ 1.75.2, 1.76.1 ]", :default => "1.76.1"
+      argument :app_path,               :type => :string
       
       # Define source root of application
       def self.source_root
@@ -28,37 +21,17 @@ module Bookshop
         directory "templates", "#{app_path}"
       end
 
-      # Adds the dtd specified by user
-      def add_dtd
-        puts "creating dtd"
-        dtd = "#{options[:dtd]}"
-        directory "tools/dtd/#{options[:dtd]}", "#{app_path}/tools/dtd"
-      end
-
-      # Adds the XSL/version specified by user
-      def add_xsl
-        directory "tools/xsl/#{options[:xsl]}", "#{app_path}/tools/xsl"
+      # Adds the Java jars and dependencies
+      def add_tools
+        directory "tools/", "#{app_path}/tools/"
       end
 
       # Change the permissions so dbtoepub is executable 
-      def chmod_dbtoepub
-        chmod "#{app_path}/tools/xsl/epub/bin/dbtoepub", 0755
-      end
-      
-      # Adds the Java jars and dependencies
-      def add_java
-        directory "tools/java/", "#{app_path}/tools/java"
-      end
-      
-      # Add the Kindlegen dependencies
-      def add_kindle
-        directory "tools/kindle/", "#{app_path}/tools/kindle"
-      end
-      
-      # Change the permissions so kindlegen is executable 
-      def chmod_kindlegen
-        chmod "#{app_path}/tools/kindle/kindlegen", 0755
+      def chmod_tools
+        chmod "#{app_path}/tools/epubcheck-1.2.jar", 0755
+        chmod "#{app_path}/tools/kindlegen", 0755
       end
+
     protected
 
       def self.banner

data/lib/bookshop/generators/bookshop/app/templates/book/META_INF/container.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+   <rootfiles>
+      <rootfile full-path="OEBPS/content.opf" media-type="application/oebps-package+xml"/>
+   </rootfiles>
+</container>