bookshop 0.1.0 → 0.1.1

data/README.rdoc

@@ -191,11 +191,15 @@ Please explore other creative ways to structure and enhance your book (we'd love
 
 To build an HTML format of your book from the ERB source:
 
-    $ bookshop build html   # -> find the output in builds/html/book_(date).html
+    $ bookshop build html   # -> find the output in builds/html/book.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
+    $ bookshop build pdf    # -> find the output in builds/pdf/book.pdf
+
+To build an epub format of your book from the ERB source:
+
+    $ bookshop build epub    # -> find the output in builds/epub/book.pdf
 
 ==== Editing your pdf document options
 
@@ -203,6 +207,24 @@ We recommend consulting PrinceXML's documentation concerning PDF options.
 
 http://www.princexml.com/doc/8.0/
 
+==== Editing you epub document and options
+
+http://idpf.org/epub/30 - For an overview of EPUB
+http://idpf.org/epub/30/spec/epub30-ocf.html - For the specs on the epub file structures and contents
+
+
+We recommend consulting the EPUB documentation for specifics.
+
+There are two main files (besides your actual book source) you will need to edit for the epub build are located in the +book/epub/OEBPS+ folder: content.opf (the Open Packaging Format) and the toc.ncx (the Navigation file).
+
+===== The *content.opf* file is the file which contains all of the primary information about your epub ebook (publisher, files included, date, etc.). 
+
+http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm - Specs on the .opf file
+
+===== The toc.ncx file is the file which contains the structural tree of your book's navigation.
+
+http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1.2 - Specs on the .ncx file.
+
 == Example Book
 
 We've provided an example book for you already in the +book/+ folder. You can use this as an example of how to structure your book and to use ERB, Book Variables, and Output Variables.

data/lib/bookshop/commands/build.rb

@@ -4,7 +4,6 @@ require 'fileutils'
 require 'yaml'
 
 require 'bookshop/commands/yaml/book'
-# require 'bookshop/commands/epub/epub_build'
 
 module Bookshop
   module Commands
@@ -75,6 +74,59 @@ module Bookshop
         
         FileUtils.cp_r('book/assets/', 'builds/html/', :verbose => true)
         
+      when 'epub'
+        # Clean up any old builds
+        puts "Deleting any old builds"
+        FileUtils.rm_r Dir.glob('builds/epub/*')
+
+        @output = :epub
+
+        FileUtils.cp_r('book/epub/META-INF', 'builds/epub/', :verbose => true)
+        FileUtils.mkdir 'builds/epub/OEBPS'
+        FileUtils.cp_r('book/epub/mimetype', 'builds/epub/', :verbose => true)
+        
+        erb = import(BOOK_SOURCE)
+        puts "Generating new html from erb"
+        File.open("builds/epub/OEBPS/book.html", 'a') do |f|
+          f << erb
+        end
+        
+        # Generate the cover.html file
+        opf = import("frontmatter/cover.html.erb")
+        puts "Generating new cover.html from erb"
+        File.open("builds/epub/OEBPS/cover.html", 'a') do |f|
+          f << opf
+        end
+        
+        # Generate the nav.html file
+        opf = import("frontmatter/toc.html.erb")
+        puts "Generating new toc.html from erb"
+        File.open("builds/epub/OEBPS/toc.html", 'a') do |f|
+          f << opf
+        end
+
+        # Generate the OPF file
+        opf = import("epub/OEBPS/content.opf.erb")
+        puts "Generating new content.opf from erb"
+        File.open("builds/epub/OEBPS/content.opf", 'a') do |f|
+          f << opf
+        end
+        
+        # Generate the NCX file
+        ncx = import("epub/OEBPS/toc.ncx.erb")
+        puts "Generating new toc.ncx from erb"
+        File.open("builds/epub/OEBPS/toc.ncx", 'a') do |f|
+          f << ncx
+        end
+        
+        FileUtils.cp_r 'book/assets', 'builds/epub/OEBPS/assets/', :verbose => true
+        FileUtils.rm %w( builds/epub/OEBPS/assets/css/stylesheet.pdf.css
+                         builds/epub/OEBPS/assets/css/stylesheet.html.css
+                         builds/epub/OEBPS/assets/css/stylesheet.mobi.css )
+        
+        puts "Zipping up into epub"
+        cmd = %x[cd builds/epub/ && zip -X0 "book.epub" mimetype && zip -rDX9 "book.epub" * -x "*.DS_Store" -x mimetype]
+        
       # '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'

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

@@ -191,11 +191,15 @@ Please explore other creative ways to structure and enhance your book (we'd love
 
 To build an HTML format of your book from the ERB source:
 
-    $ bookshop build html   # -> find the output in builds/html/book_(date).html
+    $ bookshop build html   # -> find the output in builds/html/book.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
+    $ bookshop build pdf    # -> find the output in builds/pdf/book.pdf
+
+To build an epub format of your book from the ERB source:
+
+    $ bookshop build epub    # -> find the output in builds/epub/book.pdf
 
 ==== Editing your pdf document options
 
@@ -203,6 +207,24 @@ We recommend consulting PrinceXML's documentation concerning PDF options.
 
 http://www.princexml.com/doc/8.0/
 
+==== Editing you epub document and options
+
+http://idpf.org/epub/30 - For an overview of EPUB
+http://idpf.org/epub/30/spec/epub30-ocf.html - For the specs on the epub file structures and contents
+
+
+We recommend consulting the EPUB documentation for specifics.
+
+There are two main files (besides your actual book source) you will need to edit for the epub build are located in the +book/epub/OEBPS+ folder: content.opf (the Open Packaging Format) and the toc.ncx (the Navigation file).
+
+===== The *content.opf* file is the file which contains all of the primary information about your epub ebook (publisher, files included, date, etc.). 
+
+http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm - Specs on the .opf file
+
+===== The toc.ncx file is the file which contains the structural tree of your book's navigation.
+
+http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.4.1.2 - Specs on the .ncx file.
+
 == Example Book
 
 We've provided an example book for you already in the +book/+ folder. You can use this as an example of how to structure your book and to use ERB, Book Variables, and Output Variables.

data/lib/bookshop/generators/bookshop/app/templates/book/assets/css/stylesheet.epub.css

@@ -364,34 +364,42 @@ div.titlepage p, div.halftitlepage p {
   margin: 0; padding: 0;
 }
 
+/* imprint */
+div.imprint p {
+	text-indent: 0;
+	margin-bottom: 1em;
+}
+div.imprint img {
+	width: 200px; height: 157px;
+}
 
 /* TOC */
 
-ul.toc, ul.toc ul { 
+ol.toc, ol.toc ol { 
   list-style-type: none;
   margin: 0; padding: 0;
 }
-ul.toc ul {
+ol.toc ol {
   margin-left: 1em;
   font-weight: normal;
 }
-ul.toc > li { 
+ol.toc > li { 
   font-weight: bold;
   margin-bottom: 0.5em;
 }
-ul.toc a::after {
+ol.toc a::after {
   content: leader('.') target-counter(attr(href), page);
   font-style: normal;
 }
-ul.toc > li.frontmatter a::after {
+ol.toc > li.frontmatter a::after {
   content: leader('.') target-counter(attr(href), page, lower-roman);
   font-style: normal;
 }
-ul.toc > li.endmatter a::after {
+ol.toc > li.backmatter a::after {
   content: leader('.') target-counter(attr(href), page);
   font-style: normal;
 }
-ul.toc > li.chapter::before {
+ol.toc > li.chapter::before {
   content: "Chapter " counter(toc-chapter, decimal);
   display: block;
   margin: 1em 0 0.1em -2.5cm;
@@ -422,7 +430,7 @@ div.chapter h1 { string-set: header "Chapter " counter(chapter) ": " content();
 
 /* index */
 
-ul.index { 
+ol.index { 
   list-style-type: none;
   margin: 0; padding: 0;
   column-count: 2;
@@ -446,6 +454,6 @@ code, span.css, span.value, span.declaration {
 @media screen, handheld {
   html { margin: 1em; font: 14px "Gill Sans", sans-serif; }
   h1 { margin-bottom: 0.5em }
-  div.frontcover, div.halftitlepage, div.titlepage, div.imprint, 
+  div.frontcover, div.halftitlepage, 
   div.dedication, div.foreword, div.toc, div.index { display: none }
 }

data/lib/bookshop/generators/bookshop/app/templates/book/assets/css/stylesheet.html.css

@@ -364,34 +364,42 @@ div.titlepage p, div.halftitlepage p {
   margin: 0; padding: 0;
 }
 
+/* imprint */
+div.imprint p {
+	text-indent: 0;
+	margin-bottom: 1em;
+}
+div.imprint img {
+	width: 200px; height: 157px;
+}
 
 /* TOC */
 
-ul.toc, ul.toc ul { 
+ol.toc, ol.toc ol { 
   list-style-type: none;
   margin: 0; padding: 0;
 }
-ul.toc ul {
+ol.toc ol {
   margin-left: 1em;
   font-weight: normal;
 }
-ul.toc > li { 
+ol.toc > li { 
   font-weight: bold;
   margin-bottom: 0.5em;
 }
-ul.toc a::after {
+ol.toc a::after {
   content: leader('.') target-counter(attr(href), page);
   font-style: normal;
 }
-ul.toc > li.frontmatter a::after {
+ol.toc > li.frontmatter a::after {
   content: leader('.') target-counter(attr(href), page, lower-roman);
   font-style: normal;
 }
-ul.toc > li.endmatter a::after {
+ol.toc > li.backmatter a::after {
   content: leader('.') target-counter(attr(href), page);
   font-style: normal;
 }
-ul.toc > li.chapter::before {
+ol.toc > li.chapter::before {
   content: "Chapter " counter(toc-chapter, decimal);
   display: block;
   margin: 1em 0 0.1em -2.5cm;
@@ -422,7 +430,7 @@ div.chapter h1 { string-set: header "Chapter " counter(chapter) ": " content();
 
 /* index */
 
-ul.index { 
+ol.index { 
   list-style-type: none;
   margin: 0; padding: 0;
   column-count: 2;

data/lib/bookshop/generators/bookshop/app/templates/book/assets/css/stylesheet.mobi.css

@@ -364,34 +364,42 @@ div.titlepage p, div.halftitlepage p {
   margin: 0; padding: 0;
 }
 
+/* imprint */
+div.imprint p {
+	text-indent: 0;
+	margin-bottom: 1em;
+}
+div.imprint img {
+	width: 200px; height: 157px;
+}
 
 /* TOC */
 
-ul.toc, ul.toc ul { 
+ol.toc, ol.toc ol { 
   list-style-type: none;
   margin: 0; padding: 0;
 }
-ul.toc ul {
+ol.toc ol {
   margin-left: 1em;
   font-weight: normal;
 }
-ul.toc > li { 
+ol.toc > li { 
   font-weight: bold;
   margin-bottom: 0.5em;
 }
-ul.toc a::after {
+ol.toc a::after {
   content: leader('.') target-counter(attr(href), page);
   font-style: normal;
 }
-ul.toc > li.frontmatter a::after {
+ol.toc > li.frontmatter a::after {
   content: leader('.') target-counter(attr(href), page, lower-roman);
   font-style: normal;
 }
-ul.toc > li.endmatter a::after {
+ol.toc > li.backmatter a::after {
   content: leader('.') target-counter(attr(href), page);
   font-style: normal;
 }
-ul.toc > li.chapter::before {
+ol.toc > li.chapter::before {
   content: "Chapter " counter(toc-chapter, decimal);
   display: block;
   margin: 1em 0 0.1em -2.5cm;
@@ -422,7 +430,7 @@ div.chapter h1 { string-set: header "Chapter " counter(chapter) ": " content();
 
 /* index */
 
-ul.index { 
+ol.index { 
   list-style-type: none;
   margin: 0; padding: 0;
   column-count: 2;
@@ -446,6 +454,6 @@ code, span.css, span.value, span.declaration {
 @media screen, handheld {
   html { margin: 1em; font: 14px "Gill Sans", sans-serif; }
   h1 { margin-bottom: 0.5em }
-  div.frontcover, div.halftitlepage, div.titlepage, div.imprint, 
+  div.frontcover, div.halftitlepage, 
   div.dedication, div.foreword, div.toc, div.index { display: none }
 }

data/lib/bookshop/generators/bookshop/app/templates/book/assets/css/stylesheet.pdf.css

@@ -364,34 +364,42 @@ div.titlepage p, div.halftitlepage p {
   margin: 0; padding: 0;
 }
 
+/* imprint */
+div.imprint p {
+	text-indent: 0;
+	margin-bottom: 1em;
+}
+div.imprint img {
+	width: 200px; height: 157px;
+}
 
 /* TOC */
 
-ul.toc, ul.toc ul { 
+ol.toc, ol.toc ol { 
   list-style-type: none;
   margin: 0; padding: 0;
 }
-ul.toc ul {
+ol.toc ol {
   margin-left: 1em;
   font-weight: normal;
 }
-ul.toc > li { 
+ol.toc > li { 
   font-weight: bold;
   margin-bottom: 0.5em;
 }
-ul.toc a::after {
+ol.toc a::after {
   content: leader('.') target-counter(attr(href), page);
   font-style: normal;
 }
-ul.toc > li.frontmatter a::after {
+ol.toc > li.frontmatter a::after {
   content: leader('.') target-counter(attr(href), page, lower-roman);
   font-style: normal;
 }
-ul.toc > li.endmatter a::after {
+ol.toc > li.backmatter a::after {
   content: leader('.') target-counter(attr(href), page);
   font-style: normal;
 }
-ul.toc > li.chapter::before {
+ol.toc > li.chapter::before {
   content: "Chapter " counter(toc-chapter, decimal);
   display: block;
   margin: 1em 0 0.1em -2.5cm;
@@ -422,7 +430,7 @@ div.chapter h1 { string-set: header "Chapter " counter(chapter) ": " content();
 
 /* index */
 
-ul.index { 
+ol.index { 
   list-style-type: none;
   margin: 0; padding: 0;
   column-count: 2;

data/lib/bookshop/generators/bookshop/app/templates/book/backmatter/index.html.erb

@@ -1,7 +1,7 @@
 <div class="index" id="index-h-1">
 <h1>Index</h1>
 
-<ul class="index">
+<ol class="index">
 <li><a href="#dfn-cern">CERN</a></li>
 <li><a href="#dfn-internet">Internet</a></li>
 <li><a href="#dfn-hyperlink">hyperlink</a></li>
@@ -10,6 +10,6 @@
 <li><a href="#dfn-w3c">W3C</a></li>
 <li><a href="#dfn-web-server">Web server</a></li>
 <li><a href="#dfn-w3c">World Wide Web Consortium</a></li>
-</ul>
+</ol>
 
 </div>

data/lib/bookshop/generators/bookshop/app/templates/book/bodymatter/ch02/ch02.html.erb

@@ -4,7 +4,7 @@
 <p class="sidenote">HTML is the most popular document format on the
 Web, and it is used in most of the examples in this book.</p>
 
-<p>As we explained in <a class="chapref" href="http://people.opera.com/howcome/2005/ala/html-h-1"><q>The Web and HTML,</q></a>
+<p>As we explained in <a class="chapref" href="#html-h-1"><q>The Web and HTML,</q></a>
  HTML elements enable Web-page designers to
 mark up a document's structure. The HTML specification lists
 guidelines on how browsers should display these elements. For example,

data/lib/bookshop/generators/bookshop/app/templates/book/book.html.erb

@@ -1,18 +1,25 @@
-<!--?xml version="1.0" encoding="iso-8859-1"?-->
+<!--?xml version="1.0" encoding="UTF-8"?-->
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html>
 <head>
 	<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
-	<title>how-to bookshop</title>
+	<title>Cascading Style Sheets</title>
 	<link rel="stylesheet" type="text/css" href="assets/css/stylesheet.<%= @output %>.css" />
 		<link rel="stylesheet" type="application/vnd.adobe-page-template+xml" href="assets/css/page-template.xpgt"/>
 </head>
 <body>
 
 
-<%= import('frontmatter/cover.html.erb')%>
+<% if @output == (:pdf or :html) %>
+  <%= import('frontmatter/cover.html.erb')%>
+<% end %>
+
 <%= import('frontmatter/title.html.erb')%>
-<%= import('frontmatter/toc.html.erb')%>
+
+<% if @output == (:pdf or :html) %>
+  <%= import('frontmatter/toc.html.erb')%>
+<% end %>
+
 <%= import('frontmatter/preface.html.erb')%>
 
 <!-- Chapter 01 has additional imports included inside of it -->