softcover 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 241551e9906a00f2eb0a5d8ce1de0c08609ddb30
-  data.tar.gz: 4f4e7c76d2095f5901a453dfabe386305c8b4ade
+  metadata.gz: 5cafb54a38347e1a39e36d6d4bcca3aa533d7eb2
+  data.tar.gz: b1b6d089e5c1cdf27bdd8c7617d32261c37b5e33
 SHA512:
-  metadata.gz: 8cbcbc5414d6e04a168c14b15d505e3ecfda89f6ade8ef241a036f4d92d1682aa181e71d2349ccfcf2e0d00a6a0a49469700f9d2c059feb2db39fe5987419f34
-  data.tar.gz: 6de7dd3b4b929147c8d2aa84e3fe04244ddf965d9daa22abb334fde33288f58464f84d1918c99afa89016ad3a244dae2cb90bcbbad67e4d0e1956b6aff36d727
+  metadata.gz: 4e8a8c0f01b38a3cd2d9278b54c75c4456f969739ce72fd348d767a95b3fa603df147c247d4882ff716811fdb63673062fdec566a8b9e7008a3670659f0b8589
+  data.tar.gz: 019ce8093c7f097e387a428944636b1877178cf69240779bfa077b2f2064e12f06c4b09272f61fc7a36b9a2173940d1be24097be64f94e22a8e083bd2a267d39

data/lib/softcover/cli.rb

@@ -163,11 +163,11 @@ module Softcover
     # ===============================================
 
     desc "new <name>", "Generate new book directory structure."
-    method_option :markdown,
+    method_option :polytex,
                   :type => :boolean,
                   :default => false,
-                  :aliases => "-m",
-                  :desc => "Generate a Markdown book."
+                  :aliases => "-p",
+                  :desc => "Generate a PolyTeX book."
     method_option :simple,
                   :type => :boolean,
                   :default => false,

data/lib/softcover/commands/generator.rb

@@ -8,7 +8,7 @@ module Softcover
       # Generates the default book file tree.
       def generate_file_tree(name, options = {})
         @name = name
-        @markdown = options[:markdown]
+        @markdown = !options[:polytex]
         @simple   = options[:simple]
 
         thor = Thor::Shell::Basic.new

data/lib/softcover/commands/server.rb

@@ -12,7 +12,9 @@ module Softcover::Commands::Server
     server_pid = Process.pid
     directories = ['.', 'chapters']
     @listener = Listen.to(*directories)
-    @listener.filter(/(\.tex|\.md|custom\.sty)$/)
+    file_pattern = markdown? ? '\.md' : '\.tex'
+    @listener.filter(/(#{file_pattern}|custom\.sty)$/)
+
     @listener.change do |modified|
       rebuild modified.try(:first)
       Process.kill("HUP", server_pid)
@@ -20,11 +22,16 @@ module Softcover::Commands::Server
     @listener.start
   end
 
+  def markdown?
+    !Dir.glob(path('chapters/*.md')).empty?
+  end
+
   def rebuild(modified=nil)
     printf modified ? "=> #{File.basename modified} changed, rebuilding... " :
                       'Building...'
     t = Time.now
-    Softcover::Builders::Html.new.build
+    builder = Softcover::Builders::Html.new
+    builder.build(preserve_tex: true)
     puts "Done. (#{(Time.now - t).round(2)}s)"
 
   rescue Softcover::BookManifest::NotFound => e

data/lib/softcover/template/chapters/a_chapter.md

@@ -1,12 +1,14 @@
 # A chapter
+\label{cha:a_chapter}
 
-This is the first paragraph of the Softcover Markdown template. It shows how to write a document in Markdown, a lightweight markup language, augmented with the [kramdown](http://kramdown.rubyforge.org/) converter and some custom extensions. (The other available input format is *PolyTeX*, a subset of the *LaTeX* typesetting language optimized for ebooks. PolyTeX has a more complicated syntax but is more powerful.) For more information, see [*The Softcover Manual*](http://manual.softcover.io/) (**link not live yet**). To learn how to easily publish (and optionally sell) documents produced with Softcover, visit [Softcover.io](http://softcover.io/). Softcover is currently in private beta; go to [Softcover.io](http://softcover.io/) to get an invitation.
+This is the first paragraph of the Softcover Markdown template. It shows how to write a document in Markdown, a lightweight markup language, augmented with the [kramdown](http://kramdown.rubyforge.org/) converter and some custom extensions, including support for embedded \PolyTeX, a subset of the powerful \LaTeX\ typesetting system.  For more information, see [*The Softcover Book*](http://manual.softcover.io/) (**link not live yet**). To learn how to easily publish (and optionally sell) documents produced with Softcover, visit [Softcover.io](http://softcover.io/). Softcover is currently in private beta; go to [Softcover.io](http://softcover.io/) to get an invitation.
 
 This is the *second* paragraph, showing how to emphasize text.[^sample-footnote] You can also make text **bold** or _emphasize a second way_.
 
 ## A section
+\label{sec:a_section}
 
-This is a section.
+This is a section. You can refer to it using the \LaTeX\ cross-reference syntax, like so: Section~\ref{sec:a_section}.
 
 ### Source code
 
@@ -33,14 +35,37 @@ def hello
 end
 ```
 
+The last of these can be combined with \PolyTeX's `codelisting` environment to make code listings with linked cross-references (Listing~\ref{code:hello}).
+
+\begin{codelisting}
+\codecaption{Hello, world.}
+\label{code:hello}
+```ruby
+def hello
+  puts "hello, world!"
+end
+```
+\end{codelisting}
+
+
 ### Mathematics
 
-Softcover's Markdown mode supports limited mathematical typesetting, including inline math, such as {$$}\phi^2 - \phi - 1 = 0{/$$}, and centered math, such as
+Softcover's Markdown mode supports mathematical typesetting using \LaTeX\ syntax, including inline math, such as \( \phi^2 - \phi - 1 = 0, \) and centered math, such as
+\[ \phi = \frac{1+\sqrt{5}}{2}. \]
+It also support centered equations with linked cross-reference via embedded \PolyTeX\ (Eq.~\eqref{eq:phi}).
+
+\begin{equation}
+\label{eq:phi}
+\phi = \frac{1+\sqrt{5}}{2}
+\end{equation}
+
+Softcover also supports an alternate math syntax, such as {$$}\phi^2 - \phi - 1 = 0{/$$}, and centered math, such as
 
 {$$}
 \phi = \frac{1+\sqrt{5}}{2}.
 {/$$}
 
+The \LaTeX\ syntax is strongly preferred, but the alternate syntax is included for maximum compatibility with other systems.
 
 ## Images and tables
 
@@ -84,7 +109,7 @@ Commands:
   softcover login                      # Log into Softcover account
   softcover logout                     # Log out of Softcover account
   softcover new <name>                 # Generate new book directory structure.
-  softcover open                       # Open book on Softcover website (OS X only)
+  softcover open                       # Open book on Softcover website
   softcover publish                    # Publish your book on Softcover
   softcover publish:screencasts        # Publish screencasts
   softcover server                     # Run local server
@@ -110,7 +135,7 @@ This is the end of the template---apart from two mostly empty chapters. In fact,
 
 <<(chapters/yet_another_chapter.md, lang: text)
 
-Visit <http://manual.softcover.io> to learn more about what Softcover can do.
+Visit [*The Softcover Book*](http://manual.softcover.io) to learn more about what Softcover can do.
 
 
 [^sample-footnote]: This is a footnote. It is numbered automatically.

data/lib/softcover/template/chapters/a_chapter.tex

@@ -1,12 +1,10 @@
 \chapter{A chapter}
 \label{cha:a_chapter}
 
-This is the first paragraph of the \PolyTeXnic\ template. It shows how to write a document in \PolyTeX, a subset of the \LaTeX\ typesetting language optimized for ebooks. For more information, see \href{http://polytexnic.org/book}{\emph{The \PolyTeXnic\ Book}} and the \href{http://polytexnic.org/source}{\PolyTeX\ source of the book} (\textbf{links not live yet}). To learn how to easily publish (and optionally sell) documents produced with \PolyTeXnic, visit \href{http://softcover.io/}{Softcover.io}. \PolyTeXnic\ is currently in private beta; go to \href{http://softcover.io/}{Softcover.io} to get an invitation.
+This is the first paragraph of the Softcover template. It shows how to write a document in \PolyTeX, a subset of the \LaTeX\ typesetting language optimized for ebooks. For more information, see \href{http://manual.softcover.org/book}{\emph{The Softcover Book}} and the \href{http://example.com}{\PolyTeX\ source of the book} (\textbf{links not live yet}). To learn how to easily publish (and optionally sell) documents produced with Softcover, visit \href{http://softcover.io/}{Softcover.io}. Softcover is currently in private beta; go to \href{http://softcover.io/}{Softcover.io} to get an invitation.
 
 This is the \emph{second} paragraph, showing how to emphasize text.\footnote{This is a footnote. It is numbered automatically.} You can also make text \textbf{bold} or \textit{italicized} (which looks the same as emphasized text).
 
-\emph{Note}: ``\PolyTeXnic'' is pronounced exactly like the English word \emph{polytechnic}, and ``\LaTeX'' is pronounced \emph{lay}-tech (with ``tech'' as in ``technology'').\footnote{Pronunciations of ``\LaTeX'' differ, but \emph{lay}-tech is the one I prefer.}
-
 \section{A section}
 \label{sec:a_section}
 
@@ -17,14 +15,14 @@ This is a section. Because it has a label, we can refer to it as Section~\ref{se
 
 This is a subsection. As usual, it can be referenced by label (Section~\ref{sec:source_code}). Note that the label starts with \kode{sec:}, not \kode{ssec:} or \kode{subsec:}. Any of these would work, but I find that sections often become subsections (and vice versa) when figuring out the structure of a book, and using \kode{sec:} to prefix them both saves having to change labels.
 
-\PolyTeXnic\ comes with full support for syntax-highlighted source code:
+Softcover comes with full support for syntax-highlighted source code:
 %= lang:ruby
 \begin{code}
 def hello
   puts "hello, world!"
 end
 \end{code}
-\noindent \PolyTeXnic\ can highlight any language supported by \href{http://pygments.org/languages/}{Pygments} (which means most of them).
+\noindent Softcover can highlight any language supported by \href{http://pygments.org/languages/}{Pygments} (which means most of them).
 
 You can also define \emph{code listings}, as seen in Listing~\ref{code:hello_world}. Such code listings are automatically numbered and linked.
 
@@ -63,7 +61,7 @@ Listing~\ref{code:hyphenation} also shows how to escape the underscore character
 \subsection{Mathematics}
 \label{sec:mathematics}
 
-\PolyTeXnic\ supports full mathematical typesetting, including inline math, such as $\phi^2 - \phi - 1 = 0$, and centered math, such as
+Softcover supports full mathematical typesetting, including inline math, such as $\phi^2 - \phi - 1 = 0$, and centered math, such as
 \[ \phi = \frac{1+\sqrt{5}}{2}. \]
 It also supports cross-referenced equations, as in Eq.~\eqref{eq:golden_ratio} and Eq.~\eqref{eq:stokes_theorem}.
 
@@ -82,7 +80,7 @@ It also supports cross-referenced equations, as in Eq.~\eqref{eq:golden_ratio} a
 
 This is the second section. As we saw above above, the first section is Section~\ref{sec:a_section}.
 
-\PolyTeXnic\ supports \href{http://en.wikibooks.org/wiki/LaTeX/Floats,_Figures_and_Captions}{\emph{floats}} such as figures and tables, including numbered captions and linked cross-references. The defining quality of a float is that its placement isn't guaranteed (i.e., it ``floats'' in the document), so you shouldn't generally assume it will be placed immediately after the text that precedes it. (Such placement \emph{will} be the case with HTML-based output, but \emph{not} in PDFs, where \TeX's state-of-the-art float placement algorithm is in charge.)
+Softcover supports \href{http://en.wikibooks.org/wiki/LaTeX/Floats,_Figures_and_Captions}{\emph{floats}} such as figures and tables, including numbered captions and linked cross-references. The defining quality of a float is that its placement isn't guaranteed (i.e., it ``floats'' in the document), so you shouldn't generally assume it will be placed immediately after the text that precedes it. (Such placement \emph{will} be the case with HTML-based output, but \emph{not} in PDFs, where \TeX's state-of-the-art float placement algorithm is in charge.)
 
 \subsection{Graphics and figures}
 \label{sec:graphics_and_figures}
@@ -109,7 +107,7 @@ To turn an image into a figure, use the \kode{figure} environment (Figure~\ref{f
 \subsection{Tables and tabular environments}
 \label{tables_and_tabular}
 
-\PolyTeXnic\ supports raw tables via the \kode{tabular} environment. To make a tabular environment into a full-blown table, with a number and a caption, use the \kode{table} environment (Table~\ref{table:rails_actions}), which includes some special magic to make the font size nicer in PDFs.
+Softcover supports raw tables via the \kode{tabular} environment. To make a tabular environment into a full-blown table, with a number and a caption, use the \kode{table} environment (Table~\ref{table:rails_actions}), which includes some special magic to make the font size nicer in PDFs.
 
 \bigskip
 
@@ -142,7 +140,7 @@ To turn an image into a figure, use the \kode{figure} environment (Figure~\ref{f
 
 \section{Command-line interface}
 
-\PolyTeXnic\ comes with a command-line interface called \kode{poly}. To get more information, just run \kode{poly help}:
+Softcover comes with a command-line interface called \kode{poly}. To get more information, just run \kode{poly help}:
 
 %= lang:console
 \begin{code}
@@ -188,4 +186,4 @@ This is the end of the template---apart from two mostly empty chapters (Chapter~
 
 %= <<(chapters/yet_another_chapter.tex)
 
-Visit \href{http://polytexnic.org/book}{http://polytexnic.org/book} to learn more about what \PolyTeXnic\ can do.
+See \href{http://manual.softcover.org/book}{\emph{The Softcover Book}} to learn more about what Softcover can do.

data/lib/softcover/version.rb

@@ -1,3 +1,3 @@
 module Softcover
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/cli_spec.rb

@@ -35,13 +35,13 @@ describe Softcover::CLI do
 
   context "softcover new options" do
     subject { `softcover help new` }
-    it { should include '-m, [--markdown]' }
+    it { should include '-p, [--polytex]' }
     it { should include '-s, [--simple]' }
   end
 
   context "softcover new" do
     before(:all) { chdir_to_fixtures }
-    after(:all) { remove_book }
+    after(:all)  { remove_book }
     it "should not raise error" do
       result = `softcover new book 2>&1`
       expect($?.exitstatus).to eq 0
@@ -107,7 +107,7 @@ describe Softcover::CLI do
     before(:all) do
       remove_book
       chdir_to_fixtures
-      silence { `softcover new book` }
+      silence { `softcover new book --polytex` }
       chdir_to_book
     end
     after(:all) { remove_book }
@@ -120,7 +120,7 @@ describe Softcover::CLI do
     before(:all) do
       remove_book
       chdir_to_fixtures
-      silence { `softcover new book -m` }
+      silence { `softcover new book` }
       chdir_to_book
     end
     after(:all) { remove_book }

data/spec/commands/generator_spec.rb

@@ -7,7 +7,7 @@ describe Softcover::Commands::Generator do
     before(:all) do
       chdir_to_non_book
       @name = 'foo_bar'
-      Softcover::Commands::Generator.generate_file_tree @name
+      Softcover::Commands::Generator.generate_file_tree @name, polytex: true
     end
 
     let(:name) { @name }
@@ -142,7 +142,8 @@ describe Softcover::Commands::Generator do
     before(:all) do
       chdir_to_non_book
       @name = 'foo_bar'
-      Softcover::Commands::Generator.generate_file_tree @name, simple: true
+      Softcover::Commands::Generator.generate_file_tree @name, simple: true,
+                                                               polytex: true
     end
 
     let(:name) { @name }
@@ -196,7 +197,7 @@ describe Softcover::Commands::Generator do
     before(:all) do
       chdir_to_non_book
       @name = 'foo_bar'
-      Softcover::Commands::Generator.generate_file_tree @name, markdown: true
+      Softcover::Commands::Generator.generate_file_tree @name
     end
 
     let(:name) { @name }
@@ -244,7 +245,9 @@ describe Softcover::Commands::Generator do
       $stdin.should_receive(:gets).and_return("a")
 
       silence do
-        2.times { Softcover::Commands::Generator.generate_file_tree name }
+        2.times do
+          Softcover::Commands::Generator.generate_file_tree name, polytex: true
+        end
       end
     end
 

data/spec/webmock_helpers.rb

@@ -159,7 +159,7 @@ module WebmockHelpers
     remove_book
     Dir.chdir File.join File.dirname(__FILE__), "fixtures/"
     flags = []
-    flags << '-m' if options[:markdown]
+    flags << '-p' unless options[:markdown]
     flags << '-s' if options[:simple]
     silence { system "softcover new #{name} #{flags.join(' ')}" }
     chdir_to_book

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: softcover
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Michael Hartl
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-13 00:00:00.000000000 Z
+date: 2013-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: polytexnic