prophecy 0.2.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e10e86a5056fe045d17438b054d22a295f8a77ef
4
- data.tar.gz: b2dd5720ad6308cbce74ee761f32aa8cb4224eea
3
+ metadata.gz: 49d2198b38345c2283e65b9298b3c27d2214c5d4
4
+ data.tar.gz: 8d9932dbd4d872a1ad9ca655bb0b41abc41d39b7
5
5
  SHA512:
6
- metadata.gz: ee64db92f06632f80f2857a6d0b74a57a84bdc1182dc2f4a4d6bdf413f0e3381c4bd0a92387a5fbdf761e712bb4a7c15802a633dade8324421a49501735f422e
7
- data.tar.gz: cd1bb1c982fdf0d361278a9130681638d86e81b186641c525c75ad8505c729f0284ae87a04cb2ee5805eb376c10181d1dc343ab0fa807a369e1c16d52e51d366
6
+ metadata.gz: 4182e8ec43e54cc55011accf6a86673deead93535f03542ef27b3360ee2d923d5c2195435d85e815c6154f0dc65436acd402f02dda3a7ad6f758cb7f61d00667
7
+ data.tar.gz: c023ad7b3d9fd3bde3cb1deb705fdb82f2f4c94c40d45d0d3c26ac1af908a1f4bad57ec31660dae38d675ab7719005cc87a113aa149d5a1262b835e409c71f9f
data/.gitignore CHANGED
@@ -17,3 +17,4 @@ test/tmp
17
17
  test/version_tmp
18
18
  tmp
19
19
  TODO.org
20
+ TODO.md
data/Overview.md CHANGED
@@ -1,44 +1,3 @@
1
1
 
2
- ## Overview
3
-
4
- Build a book as a PDF, EPUB and MOBI.
5
-
6
- The manuscript can be in Markdown (kramdown), LaTeX or HTML. Use the
7
- same manuscript files for the different target formats or mix them as
8
- needed.
9
-
10
- This tool will generate the TOC files (.ncx and .xhtml), Manifest and
11
- the rest.
12
-
13
- ## Installation
14
-
15
- $ gem install prophecy
16
-
17
- ## Usage
18
-
19
- 1. Start a new book: `$ prophecy new bookname`, this will create a
20
- folder `bookname` with skeleton files to get started with.
21
- 1. Add the manuscript to `manuscript/` (in Markdown, LaTeX or HTML)
22
- 2. Fill out basic book info in `book.yml`
23
- 3. Compile the book: `prophecy epub`, `prophecy mobi` or `prophecy pdf` if you have
24
- LaTeX installed
25
- 4. Done! Grab the files from the `publish/` folder
26
-
27
- ## Inspried by
28
-
29
- [bookshop](https://github.com/blueheadpublishing/bookshop), [kitabu](https://github.com/fnando/kitabu), and the [gem guide](https://github.com/radar/guides/blob/master/gem-development.md).
30
-
31
- ## PDF
32
-
33
- * LaTeX
34
- * Typography: anecdote
35
- * Fonts: Gentium and Crimson Text
36
- * ready for press
37
-
38
- ## EPUB and MOBI
39
-
40
- * CSS Style: Byronic
41
- * fonts: Source Sans Pro and Existence Light
42
- * goodness from epub-samples and epub-boilerplate
43
- * mobi with KindleGen
2
+ # Overview
44
3
 
data/README.md CHANGED
@@ -10,12 +10,20 @@ manifest, guide -- is the litany of pain.
10
10
  Sounds like the machine should be doing this, and we can just go and
11
11
  meditate on peace.
12
12
 
13
+ $ gem install prophecy
14
+ $ prophecy new "This World"
15
+ $ cd thisworld
16
+ $ vim book.yml
17
+ $ prophecy epub && prophecy mobi && prophecy latex
18
+
13
19
  ## Let's see that
14
20
 
15
21
  [![Screencast demo][demo-jpg]](http://asciinema.org/a/5680)
16
22
 
17
23
  [demo-jpg]: http://profound-labs.github.io/images/screenshots/prophecy-screencast.jpg
18
24
 
25
+ Demo: [asciinema.org/a/5680](http://asciinema.org/a/5680)
26
+
19
27
  ## And then this happens
20
28
 
21
29
  Add Screeshots.
@@ -25,8 +33,10 @@ documentclass for the PDF.
25
33
 
26
34
  ## Onwards
27
35
 
28
- - Installation for Linux, OS/X, Windows
36
+ Add docs for...
37
+
29
38
  - Overview
39
+ - Installation for Linux, OS/X, Windows
30
40
  - Custom page templates
31
41
  - Custom CSS style
32
42
 
data/bin/prophecy CHANGED
@@ -1,4 +1,9 @@
1
1
  #!/usr/bin/env ruby
2
2
 
3
3
  require 'prophecy/cli'
4
+
5
+ if File.exist?('book.rb')
6
+ require './book.rb'
7
+ end
8
+
4
9
  Prophecy::CLI.start
@@ -1,61 +1,50 @@
1
- This folder contains the distribution of epubcheck project.
2
-
3
- EpubCheck is a tool to validate IDPF Epub files. It can detect many
4
- types of errors in Epub. OCF container structure, OPF and OPS mark-up,
5
- and internal reference consistency are checked. EpubCheck can be run
6
- as a standalone command-line tool, installed as a web application or
7
- used as a library.
8
-
9
- Epubcheck project home: http://code.google.com/p/epubcheck/
10
-
11
- BUILDING
12
-
13
- To build epubcheck from the sources you need Java Development Kit (JDK) 1.5 or above
14
- and Apache ant (http://ant.apache.org/) 1.6 or above installed
15
-
16
- Run
17
-
18
- ant -f build.xml
19
-
20
- RUNNING
21
-
22
- To run the tool you need Java Runtime (1.5 or above). Any OS should do. Run
23
- it from the command line:
24
-
25
- java -jar epubcheck-x.x.x.jar file.epub
26
-
27
- All detected errors are simply printed to stderr.
28
-
29
- USING AS A LIBRARY
30
-
31
- You can also use EpubCheck as a library in your Java application. EpubCheck
32
- public interfaces can be found in com.adobe.epubcheck.api package. EpubCheck
33
- class can be used to instantiate a validation engine. Use one of its
34
- constructors and then call validate() method. Report is an interface that
35
- you can implement to get a list of the errors and warnings reported by the
36
- validation engine (instead of the error list being printed out).
37
-
38
- LICENSING
39
-
40
- See COPYING.txt
41
-
42
- AUTHORS
43
-
44
- Peter Sorotokin
45
- Garth Conboy
46
- Markus Gylling
47
- Piotr Kula
48
-
49
- Most of the EpubCheck functionality comes from the schema validation tool Jing
50
- and schemas that were developed by IDPF and DAISY. EpubCheck development was
51
- largely done at Adobe Systems.
52
-
53
-
54
-
55
-
56
-
57
-
58
-
59
-
60
-
61
-
1
+ This folder contains the distribution of epubcheck project.
2
+
3
+ EpubCheck is a tool to validate IDPF Epub files. It can detect many
4
+ types of errors in Epub. OCF container structure, OPF and OPS mark-up,
5
+ and internal reference consistency are checked. EpubCheck can be run
6
+ as a standalone command-line tool, installed as a web application or
7
+ used as a library.
8
+
9
+ Epubcheck project home: http://code.google.com/p/epubcheck/
10
+
11
+ RUNNING
12
+
13
+ To run the tool you need Java Runtime (1.5 or above). Any OS should do. Run
14
+ it from the command line:
15
+
16
+ java -jar epubcheck-x.x.x.jar file.epub
17
+
18
+ All detected errors are simply printed to stderr.
19
+
20
+ USING AS A LIBRARY
21
+
22
+ You can also use EpubCheck as a library in your Java application. EpubCheck
23
+ public interfaces can be found in com.adobe.epubcheck.api package. EpubCheck
24
+ class can be used to instantiate a validation engine. Use one of its
25
+ constructors and then call validate() method. Report is an interface that
26
+ you can implement to get a list of the errors and warnings reported by the
27
+ validation engine (instead of the error list being printed out).
28
+
29
+ LICENSING
30
+
31
+ See COPYING.txt and THIRD-PARTY.txt
32
+
33
+ AUTHORS / CONTRIBUTORS
34
+
35
+ Peter Sorotokin
36
+ Garth Conboy
37
+ Markus Gylling
38
+ Piotr Kula
39
+ Paul Norton
40
+ Liza Daly
41
+ Jessica Hekman
42
+ George Bina
43
+ Bogdan Iordache
44
+ Ionut-Maxim Margelatu
45
+ Thomas Ledoux
46
+ Romain Deltour
47
+
48
+ Most of the EpubCheck functionality comes from the schema validation tool Jing
49
+ and schemas that were developed by IDPF and DAISY. EpubCheck development was
50
+ largely done at Adobe Systems.
@@ -0,0 +1,20 @@
1
+ Licenses of third-party dependencies
2
+ ------------------------------------
3
+
4
+ Guava: Google Core Libraries for Java, 13.0.1
5
+ The Apache Software License, Version 2.0
6
+
7
+ Saxon-HE, 9.4.0.6
8
+ Mozilla Public License Version 1.0
9
+
10
+ Commons Compress, 1.4.1
11
+ The Apache Software License, Version 2.0
12
+
13
+ Jing, 20120724.0.0
14
+ New BSD License
15
+
16
+ Simple API for CSS, 1.3
17
+ The W3C Software License
18
+
19
+
20
+ Copies of the licenses are provided in the 'licenses' directory.
Binary file
Binary file
Binary file
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,27 @@
1
+ Copyright (c) {{YEAR}}, {{OWNER}}
2
+ All rights reserved.
3
+
4
+ Redistribution and use in source and binary forms, with or without
5
+ modification, are permitted provided that the following conditions are met:
6
+
7
+ Redistributions of source code must retain the above copyright notice, this
8
+ list of conditions and the following disclaimer.
9
+
10
+ Redistributions in binary form must reproduce the above copyright notice, this
11
+ list of conditions and the following disclaimer in the documentation and/or
12
+ other materials provided with the distribution.
13
+
14
+ Neither the name of {{the ORGANIZATION nor the names of its contributors}} may
15
+ be used to endorse or promote products derived from this software without
16
+ specific prior written permission.
17
+
18
+ THIS SOFTWARE IS PROVIDED BY {{THE COPYRIGHT HOLDERS AND CONTRIBUTORS}} "AS IS"
19
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21
+ DISCLAIMED. IN NO EVENT SHALL {{THE COPYRIGHT HOLDER OR CONTRIBUTORS}} BE
22
+ LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23
+ CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
24
+ GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
+ HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
+ LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
27
+ OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.