bookshop 0.0.19 → 0.0.21

Sign up to get free protection for your applications and to get access to all the features.
Files changed (20) hide show
  1. data/README.rdoc +142 -53
  2. data/lib/bookshop/commands/build.rb +36 -10
  3. data/lib/bookshop/commands/epub/epub_build.rb +67 -0
  4. data/lib/bookshop/commands/epub/templates/META-INF/container.xml +6 -0
  5. data/lib/bookshop/commands/epub/templates/OEBPS/content.opf.erb +106 -0
  6. data/lib/bookshop/commands/epub/templates/OEBPS/page-template.xpgt +48 -0
  7. data/lib/bookshop/commands/epub/templates/OEBPS/toc.opf.erb +107 -0
  8. data/lib/bookshop/commands/epub/templates/mimetype +1 -0
  9. data/lib/bookshop/commands/yaml/book.rb +31 -27
  10. data/lib/bookshop/commands/yaml/toc.rb +46 -0
  11. data/lib/bookshop/generators/bookshop/app/templates/README.rdoc +142 -53
  12. data/lib/bookshop/generators/bookshop/app/templates/book/book.html.erb +10 -8
  13. data/lib/bookshop/generators/bookshop/app/templates/book/ch01/ch01.html.erb +0 -2
  14. data/lib/bookshop/generators/bookshop/app/templates/book/css/stylesheet.css +3 -3
  15. data/lib/bookshop/generators/bookshop/app/templates/book/preface.html.erb +0 -4
  16. data/lib/bookshop/generators/bookshop/app/templates/book/toc.html.erb +14 -20
  17. data/lib/bookshop/generators/bookshop/app/templates/config/toc.yml +7 -0
  18. data/lib/bookshop/version.rb +1 -1
  19. metadata +63 -20
  20. data/CHANGELOG +0 -113
data/lib/bookshop/generators/bookshop/app/templates/book/book.html.erb CHANGED
@@ -1,19 +1,21 @@
1
1
  <!--?xml version="1.0" encoding="iso-8859-1"?-->
2
2
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
3
  <html><head>
4
- <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
5
- <title>Cascading Style Sheets - Designing for the Web</title>
6
- <link rel="stylesheet" type="text/css" href="css/stylesheet.css">
4
+ <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
5
+ <meta name="pdfkit-orientation" content="Portrait" />
6
+ <meta name="pdfkit-page_size" content="Letter" />
7
+ <title>how-to bookshop</title>
8
+ <link rel="stylesheet" type="text/css" href="css/stylesheet.css" />
7
9
  </head>
8
10
  <body>
9
- <p>Title:
11
+ <p><a name="title">New Title:</a>
10
12
  <% if @output == :html %>
11
- <%= book.html.title %>
13
+ <%= @book.html.title %>
12
14
  <% elsif @output == :pdf %>
13
- <%= book.pdf.title %>
15
+ <%= @book.pdf.title %>
14
16
  <% end %></p>
15
- <p>Subtitle: <%= book.subtitle %></p>
16
- <p>ISBN: <%= book.isbn %></p>
17
+ <p>Subtitle: <%= @book.subtitle %></p>
18
+ <p>ISBN: <%= @book.isbn %></p>
17
19
 
18
20
 
19
21
  <%= import('cover.html.erb')%>
data/lib/bookshop/generators/bookshop/app/templates/book/ch01/ch01.html.erb CHANGED
@@ -2,12 +2,10 @@
2
2
  <h1 style="counter-reset: page 1">The Web and HTML</h1>
3
3
 
4
4
  <p class="sidenote">The box <a class="pageref" href="#specs">&#8220;CSS Specifications&#8221;</a> lists the different CSS specifications.</p>
5
-
6
5
  <p>Cascading Style Sheets (CSS) represent a major breakthrough in
7
6
  how Web-page designers work by expanding their ability to
8
7
  control the appearance of Web pages, which are the documents
9
8
  that people publish on the Web.</p>
10
-
11
9
  <p>For the first few years after the World Wide Web (the Web) was
12
10
  created in 1990, people who wanted to put pages on the Web had
13
11
  little control over what those pages looked like. In the
data/lib/bookshop/generators/bookshop/app/templates/book/css/stylesheet.css CHANGED
@@ -44,9 +44,9 @@ q::after {
44
44
  content: "\201D";
45
45
  }
46
46
 
47
- p { margin: 0 }
47
+ p { margin: 0 0 .5em 0 }
48
48
  p + p { text-indent: 1.3em }
49
- p.sidenote + p, p.caption, p.art { text-indent: 0 }
49
+ p.sidenote + p, p.caption, p.art { text-indent: 0; }
50
50
 
51
51
  p.author {
52
52
  margin-top: 2em;
@@ -56,7 +56,7 @@ p.author {
56
56
 
57
57
  pre { margin: 1em 1.3em; }
58
58
 
59
- a { text-decoration: none; color: black }
59
+ a { text-decoration: underline; color: blue }
60
60
 
61
61
  /* cross-references */
62
62
 
data/lib/bookshop/generators/bookshop/app/templates/book/preface.html.erb CHANGED
@@ -1,6 +1,5 @@
1
1
  <div class="preface" id="preface-h-1">
2
2
  <h1>Preface</h1>
3
-
4
3
  <p>This is a sample document whose purpose is to show how CSS can be
5
4
  used to print a book. To make the document more lively, excerpts from
6
5
  the third edition of &#8220;Cascading Style Sheets &#8212; designing
@@ -12,12 +11,9 @@ in this document, out of order.</p>
12
11
 
13
12
  <p>The PDF version of this document is produced directly from the HTML
14
13
  and CSS sources by the Prince formatter.</p>
15
-
16
14
  <p>We encourage you to reuse the structure, markup and style sheet of
17
15
  this sample document. In your own book, however, you need to provide
18
16
  the content yourself.</p>
19
-
20
17
  <p class="author">H&#229;kon Wium Lie &amp; Bert Bos<br>
21
18
  Oslo/Antibes<br>November 2005</p>
22
-
23
19
  </div>
data/lib/bookshop/generators/bookshop/app/templates/book/toc.html.erb CHANGED
@@ -1,25 +1,19 @@
1
1
  <div class="toc" id="toc-h-1">
2
2
  <h1>Table of Contents</h1>
3
3
 
4
- <ul class="toc">
5
- <li class="frontmatter"><a href="#toc-h-1">Table of Contents</a></li>
6
- <li class="frontmatter"><a href="#preface-h-1">Preface</a></li>
7
- <li class="chapter"><a href="#html-h-1">The Web and HTML</a>
8
- <ul>
9
- <li class="section"><a href="#the-web">The Web</a>
10
- <ul>
11
- <li class="section"><a href="#development">Development of the Web</a></li>
12
- <li class="section"><a href="#images">Adding images</a></li>
13
- </ul>
14
- </li>
15
- </ul>
16
- </li>
17
- <li class="chapter"><a href="#css-h-1">CSS</a>
18
- <ul>
19
- <li class="section"><a href="#rules">Rules and Style Sheets</a></li>
20
- </ul>
21
- </li>
22
- <li class="endmatter"><a href="#index-h-1">Index</a></li>
23
- </ul>
4
+ <nav class="frontmatter"><a href="#toc-h-1">Table of Contents</a></nav>
5
+ <nav class="frontmatter"><a href="#preface-h-1">Preface</a></nav>
6
+ <nav class="chapter"><a href="#html-h-1">The Web and HTML</a>
7
+ <nav class="section"><a href="#the-web">The Web</a>
8
+ <nav class="section"><a href="#development">Development of the Web</a></nav>
9
+ <nav class="section"><a href="#images">Adding images</a></nav>
10
+ </nav>
11
+ </nav>
12
+
13
+ <nav class="chapter"><a href="#css-h-1">CSS</a>
14
+ <nav class="section"><a href="#rules">Rules and Style Sheets</a></nav>
15
+ </nav>
16
+
17
+ <nav class="endmatter"><a href="#index-h-1">Index</a></nav>
24
18
 
25
19
  </div>
data/lib/bookshop/generators/bookshop/app/templates/config/toc.yml ADDED
@@ -0,0 +1,7 @@
1
+ foreword:
2
+ id: Title
3
+ text: title
4
+
5
+ ch01:
6
+ id: ch01
7
+ text: This is the First Chapter
data/lib/bookshop/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module Bookshop
2
- VERSION = "0.0.19"
2
+ VERSION = "0.0.21"
3
3
  end
metadata CHANGED
@@ -2,15 +2,15 @@
2
2
  name: bookshop
3
3
  version: !ruby/object:Gem::Version
4
4
  prerelease:
5
- version: 0.0.19
5
+ version: 0.0.21
6
6
  platform: ruby
7
7
  authors:
8
- - D.a. Thompson
8
+ - Dave Thompson
9
9
  autorequire:
10
10
  bindir: bin
11
11
  cert_chain: []
12
12
 
13
- date: 2011-12-27 00:00:00 Z
13
+ date: 2012-01-23 00:00:00 Z
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
16
16
  name: thor
@@ -24,18 +24,18 @@ dependencies:
24
24
  type: :runtime
25
25
  version_requirements: *id001
26
26
  - !ruby/object:Gem::Dependency
27
- name: bundler
27
+ name: rubyzip
28
28
  prerelease: false
29
29
  requirement: &id002 !ruby/object:Gem::Requirement
30
30
  none: false
31
31
  requirements:
32
32
  - - ">="
33
33
  - !ruby/object:Gem::Version
34
- version: 1.0.0
35
- type: :development
34
+ version: "0"
35
+ type: :runtime
36
36
  version_requirements: *id002
37
37
  - !ruby/object:Gem::Dependency
38
- name: rake
38
+ name: pdfkit
39
39
  prerelease: false
40
40
  requirement: &id003 !ruby/object:Gem::Requirement
41
41
  none: false
@@ -43,10 +43,10 @@ dependencies:
43
43
  - - ">="
44
44
  - !ruby/object:Gem::Version
45
45
  version: "0"
46
- type: :development
46
+ type: :runtime
47
47
  version_requirements: *id003
48
48
  - !ruby/object:Gem::Dependency
49
- name: minitest
49
+ name: bundler
50
50
  prerelease: false
51
51
  requirement: &id004 !ruby/object:Gem::Requirement
52
52
  none: false
@@ -57,7 +57,7 @@ dependencies:
57
57
  type: :development
58
58
  version_requirements: *id004
59
59
  - !ruby/object:Gem::Dependency
60
- name: aruba
60
+ name: rake
61
61
  prerelease: false
62
62
  requirement: &id005 !ruby/object:Gem::Requirement
63
63
  none: false
@@ -68,7 +68,7 @@ dependencies:
68
68
  type: :development
69
69
  version_requirements: *id005
70
70
  - !ruby/object:Gem::Dependency
71
- name: rdoc
71
+ name: minitest
72
72
  prerelease: false
73
73
  requirement: &id006 !ruby/object:Gem::Requirement
74
74
  none: false
@@ -79,7 +79,7 @@ dependencies:
79
79
  type: :development
80
80
  version_requirements: *id006
81
81
  - !ruby/object:Gem::Dependency
82
- name: wkhtmltopdf-binary
82
+ name: aruba
83
83
  prerelease: false
84
84
  requirement: &id007 !ruby/object:Gem::Requirement
85
85
  none: false
@@ -89,11 +89,47 @@ dependencies:
89
89
  version: "0"
90
90
  type: :development
91
91
  version_requirements: *id007
92
+ - !ruby/object:Gem::Dependency
93
+ name: rdoc
94
+ prerelease: false
95
+ requirement: &id008 !ruby/object:Gem::Requirement
96
+ none: false
97
+ requirements:
98
+ - - ">="
99
+ - !ruby/object:Gem::Version
100
+ version: "0"
101
+ type: :development
102
+ version_requirements: *id008
103
+ - !ruby/object:Gem::Dependency
104
+ name: wkhtmltopdf-binary
105
+ prerelease: false
106
+ requirement: &id009 !ruby/object:Gem::Requirement
107
+ none: false
108
+ requirements:
109
+ - - ">="
110
+ - !ruby/object:Gem::Version
111
+ version: "0"
112
+ type: :development
113
+ version_requirements: *id009
114
+ - !ruby/object:Gem::Dependency
115
+ name: mocha
116
+ prerelease: false
117
+ requirement: &id010 !ruby/object:Gem::Requirement
118
+ none: false
119
+ requirements:
120
+ - - ">="
121
+ - !ruby/object:Gem::Version
122
+ version: "0"
123
+ type: :development
124
+ version_requirements: *id010
92
125
  description: |-
93
- bookShop is a publishing framework for html-to-pdf/(e)book toolchain happiness and sustainable productivity.
94
- The framework is optimized to help developers quickly ramp-up, allowing them to more rapidly
95
- jump in and develop their html-to-pdf/(e)book (print-pdf, epub, mobi, etc.) flows, by favoring convention over
96
- configuration, setting them up with best practices, standards and tools from the start.
126
+ bookshop is a book publishing framework for publishers, editors, and coders in today's
127
+ publishing industry. bookshop provides a framework for developing books using
128
+ well-known/standard web languages like HTML/CSS, which are then converted into pdf
129
+ and other (e)book formats. The framework is optimized to help developers quickly ramp-up,
130
+ allowing them to jump in and develop their html-to-pdf/(e)book flows, by favoring
131
+ convention over configuration, setting them up with best-practices, standards and tools
132
+ from the start.
97
133
  email: da@blueheadpublishing.com
98
134
  executables:
99
135
  - bookshop
@@ -102,12 +138,18 @@ extensions: []
102
138
  extra_rdoc_files: []
103
139
 
104
140
  files:
105
- - CHANGELOG
106
141
  - README.rdoc
107
142
  - bin/bookshop
108
143
  - lib/bookshop/commands/application.rb
109
144
  - lib/bookshop/commands/build.rb
145
+ - lib/bookshop/commands/epub/epub_build.rb
146
+ - lib/bookshop/commands/epub/templates/META-INF/container.xml
147
+ - lib/bookshop/commands/epub/templates/mimetype
148
+ - lib/bookshop/commands/epub/templates/OEBPS/content.opf.erb
149
+ - lib/bookshop/commands/epub/templates/OEBPS/page-template.xpgt
150
+ - lib/bookshop/commands/epub/templates/OEBPS/toc.opf.erb
110
151
  - lib/bookshop/commands/yaml/book.rb
152
+ - lib/bookshop/commands/yaml/toc.rb
111
153
  - lib/bookshop/commands.rb
112
154
  - lib/bookshop/generators/bookshop/app/app_generator.rb
113
155
  - lib/bookshop/generators/bookshop/app/templates/book/book.html.erb
@@ -126,6 +168,7 @@ files:
126
168
  - lib/bookshop/generators/bookshop/app/templates/book/toc.html.erb
127
169
  - lib/bookshop/generators/bookshop/app/templates/CHANGELOG
128
170
  - lib/bookshop/generators/bookshop/app/templates/config/book.yml
171
+ - lib/bookshop/generators/bookshop/app/templates/config/toc.yml
129
172
  - lib/bookshop/generators/bookshop/app/templates/README.rdoc
130
173
  - lib/bookshop/generators/bookshop/app/templates/script/bookshop
131
174
  - lib/bookshop/generators/bookshop/app/USAGE
@@ -138,7 +181,7 @@ files:
138
181
  - lib/bookshop/generators/bookshop/app/templates/builds/html/.empty_directory
139
182
  - lib/bookshop/generators/bookshop/app/templates/builds/mobi/.empty_directory
140
183
  - lib/bookshop/generators/bookshop/app/templates/builds/pdf/.empty_directory
141
- homepage: http://rubygems.org/gems/bookshop
184
+ homepage: http://blueheadpublishing.github.com/bookshop/
142
185
  licenses:
143
186
  - MIT
144
187
  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 "
@@ -161,9 +204,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
161
204
  requirements: []
162
205
 
163
206
  rubyforge_project: bookshop
164
- rubygems_version: 1.8.13
207
+ rubygems_version: 1.8.15
165
208
  signing_key:
166
209
  specification_version: 3
167
- summary: A publishing framework for html-to-pdf/(e)book toolchain happiness and sustainable productivity.
210
+ summary: A book publishing framework for html-to-pdf/(e)book toolchain happiness and sustainable productivity.
168
211
  test_files: []
169
212
 
data/CHANGELOG DELETED
@@ -1,113 +0,0 @@
1
- 0.0.19:
2
- Testing
3
- This release incorporates a new testing suite.
4
- I've added Aruba and Cucumber to create acceptance tests for the basic features
5
- of bookshop. This does not currently include any unit testing. I will be adding
6
- unit tests in a future release. Hopefully these basic acceptance tests will provide
7
- some essence of stability considering my recent cowboy coding. :-)
8
-
9
- 0.0.18:
10
- Features
11
- Added @output variable for use in ERB source files so conditionals can be used to
12
- define custom layouts based upon the type of output being built
13
- (e.g. html, pdf, etc)
14
-
15
- Abstracted the book-to-yaml class into it's own class under */commands/yaml/book.rb
16
-
17
- Documentation
18
- Edited the example book to demonstrate use of "output" conditionals in ERB source
19
- files.
20
- Added documentation in README's to show use of "output" conditionals in ERB source
21
-
22
- 0.0.17:
23
- Features
24
- Added config/book.yml, providing a data structure for elements accessible within the
25
- book/ source files.
26
-
27
- Added 'current date' to the end of the generated filename of builds.
28
-
29
- Clean-up
30
- Removed Template Generator for now, this has become part of the 0.2.0 milestone
31
-
32
- 0.0.16:
33
- Features
34
- Added importing <%= import(your_source_file.html.erb) %> functionality for ERB source
35
- files, providing subtemplating, allowing for cleaner code layouts.
36
-
37
- Documentation
38
- Edited the example book which is generated with 'bookshop new'. The new layout
39
- demonstrates how to utilize the <%= import(your_source_file.html.erb) %> for
40
- including sub-files.
41
-
42
- Removed 'Tools' subfolder including Kindlegen and Epubcheck - I will include them
43
- in a future release. But removed for now to save bandwidth and reduce gem size.
44
-
45
- Made 'book/' the assumed directory for source in 'bookshop build' command and
46
- removed 'book/' prefix in all of the layout imports
47
-
48
- 0.0.15:
49
- Features
50
- Added ERB functionality to the book source
51
-
52
- 0.0.14:
53
- Moved repository to blueheadpublishing and modified gem source
54
- to update all links
55
-
56
- Features
57
- Added CHANGELOG into project template to provide users with a
58
- best-practices in documenting version changes
59
-
60
- 0.0.13:
61
- Bug fixes
62
- Fixed build pdf command so it doesn't try to build epub
63
-
64
- 0.0.12:
65
- Doc fixes
66
- Added new post-install message to alert users to install wkhtmltopdf
67
-
68
- Removed old POST_INSTALL file
69
-
70
- 0.0.11:
71
- Complete rewrite
72
- Switched from docbook toolchain to html/css/javascript toolchain
73
-
74
- Removed all XML/XSLT/FOP dependencies since no longer using docbook
75
-
76
- Added wkhtmltopdf as the html-to-pdf processor
77
-
78
- Added Boom(.css) microformat to replace structural markup previously
79
- available via docbook
80
-
81
- Moved copyright to BlueHead Inc
82
-
83
- 0.0.4:
84
- Core Changes
85
- Added new mobi build
86
-
87
- Branding around World Uniting Press
88
-
89
- Added epubcheck for epub validations, v1.2
90
-
91
- Added kindlegen for generating mobi
92
-
93
-
94
- 0.0.3:
95
- Core Changes
96
- Added Java toolsets, including all necessary .jars for working with
97
- Docbook and bookshop
98
-
99
- Updated documentation to include information on how to setup java tools
100
- and Classpaths on various systems
101
-
102
- Added MIT-LICENSE
103
-
104
- Application Generator now has dynamically generated dates and content
105
-
106
- Added epub build command
107
-
108
- Added pdf build command
109
-
110
- Significant rework of Command Line Interface and 'help' dialogues
111
-
112
- Bug Fixes
113
- (none as this was a substantial rework)