bookshop 0.0.13 → 0.0.14

data/CHANGELOG

@@ -1,3 +1,11 @@
+0.0.14:
+		Moved repository to blueheadpublishing and modified gem source
+			to update all links
+			
+		Features
+				Added CHANGELOG into project template to provide users with a
+					best-practices in documenting version changes.
+
 0.0.13:
 		Bug fixes
 				Fixed build pdf command so it doesn't try to build epub

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2010, 2011 by World Uniting (http://worlduniting.org)
+Copyright (C) 2010, 2011 by BlueHead Publishing (http://blueheadpublishing.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

data/README.rdoc

@@ -22,17 +22,17 @@ bookshop hopes to simplify the process by:
 
 === Install bookshop
 
-    $ sudo gem install bookshop
+    $ gem install bookshop
 
 === Install wkhtmltopdf
 
 1. Install by hand (recommended):
 
-    https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF
+    https://github.com/blueheadpublishing/bookshop/wiki/Installing-wkhtmltopdf
 
 2. Try using the wkhtmltopdf-binary gem (mac + linux i386)
 
-    gem install wkhtmltopdf-binary
+    $ gem install wkhtmltopdf-binary
 
 3. The wkhtmltopdf site has more info
 
@@ -55,7 +55,7 @@ bookshop hopes to simplify the process by:
 
 To build a pdf format of your book from the html source:
 
-    bookshop build pdf
+    $ bookshop build pdf
 
 == Getting Help
 
@@ -95,7 +95,7 @@ The default directory structure of a generated bookshop project:
     mobi
     pdf
 
-  |-- stylesheets
+  |-- config
   |-- tools
 
 book
@@ -112,13 +112,25 @@ build/mobi
 
 build/pdf
   When building the pdf book, the generated output will reside here as "book.pdf"
+
+config
+  application-wide variables and configurations will go here
 	
 tools
-  Holds the epubcheck and kindlegen tools
+  Holds all third-party tools: epubcheck, kindlegen
+
+== Get Involved
+1. Fork the repository.
+2. Pick an issue (or feature you want to add).
+3. Make changes to your forked code.
+4. Add tests so that we don't accidentally break your addition with our future commits.
+5. Commit to your git (forked) repository.
+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 (C) 2010, 2011 by BlueHead, Inc (http://blueheadinc.com)
+Copyright (C) 2010, 2011 by BlueHead Publishing, Inc (http://blueheadpublishing.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

data/bookshop.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Bookshop::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['D.a. Thompson']
-  s.email       = ['git@worlduniting.org']
+  s.email       = ['da@blueheadpublishing.com']
   s.homepage    = "http://rubygems.org/gems/bookshop"
   s.summary     = "A publishing framework for html-to-(e)book toolchain happiness and sustainable productivity."
   s.description = "bookShop is a publishing framework for html-to-(e)book toolchain happiness and sustainable productivity. 
@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
 
   
   s.add_dependency "thor", ">= 0.14.6"
+  s.add_dependency "nokogiri"
   s.add_development_dependency "bundler", ">= 1.0.0"
   s.add_development_dependency "rspec"
 

data/lib/bookshop/generators/bookshop/app/templates/CHANGELOG

@@ -0,0 +1,15 @@
+This is where you record the version specific changes.
+
+For example:
+
+0.0.2:
+		Errata fixes
+				Fixed a few mis-spellings
+
+0.0.1:
+		Errata fixes
+		
+		Images
+				Added new picture of the author
+				
+(BTW - you should delete this example text and make your own.)

data/lib/bookshop/generators/bookshop/app/templates/README.rdoc

@@ -1,78 +1,63 @@
 == 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 a publishing 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 (print-pdf, epub, mobi, etc.) 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:
-* 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
+    $ 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/blueheadpublishing/bookshop/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.
-
-* 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
+    $ gem install wkhtmltopdf-binary
 
-* 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:
+3. The wkhtmltopdf site has more info
 
-		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
+    http://code.google.com/p/wkhtmltopdf/
 
-* For Windows systems you can either use Cygwin and follow the directions for *nix systems above, or edit your Classpath via the Control Panel
+== Using bookshop
 
-=== Building Your First Book
+=== Create a bookshop application
 
-To build a pdf format of your book from the docbook source:
+    $ bookshop new name_of_book
 
-    bookshop build pdf
+	This will create a new bookshop app in /path/to/name_of_book
 	
-To build an epub format of your book from the docbook source:
+* 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):
 
-    bookshop build epub
+  PATH="$PATH:/var/lib/gems/1.8/bin"
+  export PATH
 
-== Getting Help
+=== Building Your First Book
+
+To build a pdf format of your book from the html source:
 
-* Checkout the wiki page which is in development currently for installation help and links to other articles and help content. https://github.com/blueheadpublishing/bookshop/wiki
+    $ bookshop build pdf
+
+== Getting Help
 
 * 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
 
@@ -80,9 +65,11 @@ To build an epub format of your book from the docbook source:
 
 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,58 @@ 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
 
-	|-- book
-	|-- builds
-	|   |-- epub
-	|   |-- html
-	|   |-- mobi
-	|	  `-- pdf
-	|-- stylesheets
-	|-- tools
-	|   |-- dtd
-	|   |-- xsl
-	|   `-- java
+  |-- config
+  |-- 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".
+  When building the pdf book, the generated output will reside here as "book.pdf"
 
-stylesheets
-	Holds the XSL stylesheets for customizing your book output.
+config
+  application-wide variables and configurations will go here
 	
 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 all third-party tools: epubcheck, kindlegen
+
+== Get Involved
+1. Fork the repository.
+2. Pick an issue (or feature you want to add).
+3. Make changes to your forked code.
+4. Add tests so that we don't accidentally break your addition with our future commits.
+5. Commit to your git (forked) repository.
+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 (C) 2010, 2011 by BlueHead Publishing LLC (http://blueheadpublishing.com)
+Copyright (C) 2010, 2011 by BlueHead Publishing, Inc (http://blueheadpublishing.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 +148,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/lib/bookshop/post_install.rb

@@ -1,16 +1,19 @@
 module Bookshop
   POST_INSTALL = "
   ******************************************************************
+  
+  Make sure to have Java 1.5 or above installed
+  
 
   Install wkhtmltopdf:
 
   1. Install by hand (recomended):
 
-          https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF
+      https://github.com/blueheadpublishing/bookshop/wiki/Installing-wkhtmltopdf
 
   2. Try using the wkhtmltopdf-binary gem (mac + linux i386)
 
-          gem install wkhtmltopdf-binary
+      gem install wkhtmltopdf-binary
 
 
   ******************************************************************

data/lib/bookshop/version.rb

@@ -1,3 +1,3 @@
 module Bookshop
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

metadata

@@ -2,7 +2,7 @@
 name: bookshop
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors: 
 - D.a. Thompson
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-17 00:00:00 Z
+date: 2011-11-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: thor
@@ -24,34 +24,45 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: nokogiri
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: 1.0.0
   type: :development
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: |-
   bookShop is a publishing 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 (print-pdf, epub, mobi, etc.) flows, by favoring convention over 
                       configuration, setting them up with best practices, standards and tools from the start.
 email: 
-- git@worlduniting.org
+- da@blueheadpublishing.com
 executables: 
 - bookshop
 extensions: []
@@ -73,6 +84,7 @@ files:
 - lib/bookshop/commands/build.rb
 - lib/bookshop/generators/bookshop/app/USAGE
 - lib/bookshop/generators/bookshop/app/app_generator.rb
+- lib/bookshop/generators/bookshop/app/templates/CHANGELOG
 - lib/bookshop/generators/bookshop/app/templates/README.rdoc
 - lib/bookshop/generators/bookshop/app/templates/book/META_INF/container.xml
 - lib/bookshop/generators/bookshop/app/templates/book/book.html
@@ -106,7 +118,7 @@ files:
 homepage: http://rubygems.org/gems/bookshop
 licenses: 
 - MIT
-post_install_message: "\n  ******************************************************************\n\n  Install wkhtmltopdf:\n\n  1. Install by hand (recomended):\n\n          https://github.com/jdpace/PDFKit/wiki/Installing-WKHTMLTOPDF\n\n  2. Try using the wkhtmltopdf-binary gem (mac + linux i386)\n\n          gem install wkhtmltopdf-binary\n\n\n  ******************************************************************\n  "
+post_install_message: "\n  ******************************************************************\n  \n  Make sure to have Java 1.5 or above installed\n  \n\n  Install wkhtmltopdf:\n\n  1. Install by hand (recomended):\n\n      https://github.com/blueheadpublishing/bookshop/wiki/Installing-wkhtmltopdf\n\n  2. Try using the wkhtmltopdf-binary gem (mac + linux i386)\n\n      gem install wkhtmltopdf-binary\n\n\n  ******************************************************************\n  "
 rdoc_options: []
 
 require_paths: