softcover 0.0.1 → 0.5.0

data/lib/softcover/server/views/main.js.erb

@@ -0,0 +1,58 @@
+wait = ->
+  $.ajax
+    url: window.location.pathname + '/wait'
+    dataType: 'json'
+    timeout: 29 * 1000
+    success: ->
+      $.get window.location.pathname + '.js', (html)->
+        $('#book').html html
+        initMathJax()
+        initNavOffset()
+        wait()
+    error: (jqXHR, textStatus)->
+      if textStatus == 'timeout'
+        # polling end, reconnect immediately
+        wait()
+      else
+        # server down, try reconnecting again after timeout
+        setTimeout wait, 5000
+
+initMathJax = ->
+  $('#mathJaxJS').remove()
+  delete MathJax
+
+  chapter_number = $('.chapter').attr('data-number')
+  script = document.createElement( 'script' )
+  script.id = 'mathJaxJS'
+  script.type = 'text/javascript'
+  script.src = '<%= @mathjax_src %>'
+  script.innerHTML = """
+    <%= @mathjax_config %>
+    """
+
+  $('head').append script
+
+delay = 1000
+initNavOffset = ->
+  loading = true
+  finish = _.debounce ->
+    loading = false
+  , delay
+
+  offset = 20
+  navHeight = $('#bookMenu').height() + offset
+  $(window).scroll ->
+    if loading
+      offset = $(window.location.hash).offset().top - navHeight
+      $(window).scrollTop offset
+      finish()
+
+  $(window).bind 'hashchange', (e)->
+    e.preventDefault()
+    offset = $(window.location.hash).offset().top - navHeight
+    $(window).scrollTop offset
+
+$ ->
+  initMathJax()
+  initNavOffset()
+  wait()

data/lib/softcover/template/.softcover-deploy

@@ -0,0 +1,6 @@
+# Edit this file to customize your deployment steps with custom command options
+# or additional commands.
+#
+# softcover build:all
+# softcover build:preview
+# softcover publish

data/lib/softcover/template/Book.txt

@@ -0,0 +1,9 @@
+cover
+frontmatter:
+maketitle
+tableofcontents
+preface.md
+mainmatter:
+a_chapter.md
+another_chapter.md
+yet_another_chapter.md

data/lib/softcover/template/book.tex

@@ -0,0 +1,21 @@
+\documentclass[14pt]{extbook}
+\usepackage{softcover}
+\VerbatimFootnotes % Allows verbatim text in footnotes
+
+\title{Title of the Book}
+\author{Author Name}
+\date{} % Leave blank, enter a date, or remove to use today's date.
+
+\begin{document}
+  \includepdf{images/cover.pdf}
+  \frontmatter
+  \maketitle
+  \tableofcontents
+  % List frontmatter sections here (preface, foreword, etc.).
+  \include{chapters/preface}
+  \mainmatter
+  % List chapters here in the order they should appear in the book.
+  \include{chapters/a_chapter}
+  \include{chapters/another_chapter}
+  \include{chapters/yet_another_chapter}
+\end{document}

data/lib/softcover/template/book.yml.erb

@@ -0,0 +1,11 @@
+---
+title: <%= name %>
+slug: <%= name %>
+filename: <%= name %>
+subtitle: Change-me
+cover: images/cover.png
+description: Change me.
+copyright: <%= Time.new.year %>
+uuid: <%= SecureRandom.uuid %>
+pdf_preview_page_range: 1..30
+epub_mobi_preview_chapter_range: 0..1

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

@@ -0,0 +1,118 @@
+# 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 *second* paragraph, showing how to emphasize text.[^sample-footnote] You can also make text **bold** or _emphasize a second way_.
+
+## A section
+
+This is a section.
+
+### Source code
+
+This is a subsection.
+
+You can typeset code samples and other verbatim text using four space of indentation:
+
+    def hello
+      puts "hello, world"
+    end
+
+Softcover also comes with full support for syntax-highlighted source code using kramdown's default syntax, which combines the language name with indentation:
+
+{lang="ruby"}
+    def hello
+      puts "hello, world"
+    end
+
+Softcover's Markdown mode also extends kramdown to support "code fencing" from GitHub-flavored Markdown:
+
+```ruby
+def hello
+  puts "hello, world!"
+end
+```
+
+### Mathematics
+
+Softcover's Markdown mode supports limited mathematical typesetting, including inline math, such as {$$}\phi^2 - \phi - 1 = 0{/$$}, and centered math, such as
+
+{$$}
+\phi = \frac{1+\sqrt{5}}{2}.
+{/$$}
+
+
+## Images and tables
+
+This is the second section.
+
+Softcover supports the inclusion of images, like this:
+
+![Some dude.](images/2011_michael_hartl.png)
+
+### Tables
+
+Softcover supports raw tables via a simple table syntax:
+
+|**HTTP request** | **URL** | **Action** | **Purpose** |
+| `GET` | /users | `index` | page to list all users |
+| `GET` | /users/1 | `show` | page to show user with id `1` |
+| `GET` | /users/new | `new` | page to make a new user |
+| `POST` | /users | `create` | create a new user |
+| `GET` | /users/1/edit | `edit` | page to edit user with id `1` |
+| `PATCH` | /users/1 | `update` | update user with id `1` |
+| `DELETE` | /users/1 | `destroy` | delete user with id `1` |
+
+
+## Command-line interface
+
+Softcover comes with a command-line interface called `softcover`. To get more information, just run `softcover help`:
+
+```console
+$ softcover help
+Commands:
+  softcover build, build:all           # Build all formats
+  softcover build:epub                 # Build EPUB
+  softcover build:html                 # Build HTML
+  softcover build:mobi                 # Build MOBI
+  softcover build:pdf                  # Build PDF
+  softcover build:preview              # Build book preview in all formats
+  softcover config                     # View local config
+  softcover config:add key=value       # Add to your local config vars
+  softcover epub:validate, epub:check  # Validate EPUB with epubcheck
+  softcover help [COMMAND]             # Describe available 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 publish                    # Publish your book on Softcover
+  softcover publish:screencasts        # Publish screencasts
+  softcover server                     # Run local server
+```
+
+For additional help on a given command, run `softcover help <command>`:
+
+```console
+$ softcover help build
+Usage:
+  softcover build, build:all
+
+Options:
+  -q, [--quiet]   # Quiet output
+  -s, [--silent]  # Silent output
+
+Build all formats
+```
+
+## Miscellanea
+
+This is the end of the template---apart from two mostly empty chapters. In fact, let’s include the last chapter in its entirety, just to see how mostly empty it is:
+
+<<(chapters/yet_another_chapter.md, lang: text)
+
+Visit <http://manual.softcover.io> to learn more about what Softcover can do.
+
+
+[^sample-footnote]: This is a footnote. It is numbered automatically.
+
+[^pronunciation]: Pronunciations of "LaTeX" differ, but *lay*-tech is the one I prefer.

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

@@ -0,0 +1,191 @@
+\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 \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}
+
+This is a section. Because it has a label, we can refer to it as Section~\ref{sec:a_section}. The cross-reference will be automatically numbered and linked. There's another reference to this section in Section~\ref{sec:floats}, as well as one in Chapter~\ref{cha:another_chapter}.
+
+\subsection{Source code}
+\label{sec:source_code}
+
+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:
+%= 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).
+
+You can also define \emph{code listings}, as seen in Listing~\ref{code:hello_world}. Such code listings are automatically numbered and linked.
+
+\begin{codelisting}
+\label{code:hello_world}
+\codecaption{``Hello, world!'' in Ruby.}
+%= lang:ruby
+\begin{code}
+def hello
+  puts "hello, world!"
+end
+\end{code}
+\end{codelisting}
+
+You can indicate inline code with the \verb+\kode+ command, as in \kode{current\_\-user}. If you prefer a plainer version of the same thing, you can use ``typewriter text'', as in \texttt{current\_\-user}.
+
+For words whose hypenation isn't built in, you can indicate an optional hyphen using \verb+\-+ (Listing~\ref{code:hyphenation}), which will only be used if necessary to make a clean line break (and even then only when producing PDFs). You can also define global hyphenation rules in \texttt{custom.sty}, which includes a rule for hyphenating ``JavaScript'' (Listing~\ref{code:custom}).
+
+\begin{codelisting}
+\label{code:hyphenation}
+\codecaption{Adding an optional hyphen to \kode{current\_user}.}
+%= lang:latex
+\begin{code}
+current\_\-user
+\end{code}
+\end{codelisting}
+
+\begin{codelisting}
+\label{code:custom}
+\codecaption{Defining custom commands. \\ \filepath{custom.sty}}
+%= <<(custom.sty, lang: tex)
+\end{codelisting}
+
+Listing~\ref{code:hyphenation} also shows how to escape the underscore character using a backslash. This is necessary because plain underscores are reserved for math environments (Section~\ref{sec:mathematics}).
+
+\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
+\[ \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}.
+
+\begin{equation}
+\label{eq:golden_ratio}
+\phi = \frac{1+\sqrt{5}}{2} \approx 1.618 \qquad{\text{The Golden Ratio}}
+\end{equation}
+
+\begin{equation}
+\label{eq:stokes_theorem}
+\int_\Omega d\omega = \int_{\partial\Omega} \omega \qquad{\text{Generalized Stokes's Theorem}}
+\end{equation}
+
+\section{Floats}
+\label{sec:floats}
+
+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.)
+
+\subsection{Graphics and figures}
+\label{sec:graphics_and_figures}
+
+You can include raw graphics like this:
+
+\includegraphics{images/2011_michael_hartl.png}
+
+\noindent You can also include centered images:
+
+\image{images/2011_michael_hartl.png}
+
+\noindent Or include one with a box, like so:
+
+\imagebox{images/2011_michael_hartl.png}
+
+To turn an image into a figure, use the \kode{figure} environment (Figure~\ref{fig:the_dude}).
+
+\begin{figure}
+\imagebox{images/2011_michael_hartl.png}
+\caption{Some \href{http://michaelhartl.com/}{dude}.\label{fig:the_dude}}
+\end{figure}
+
+\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.
+
+\bigskip
+
+\begin{tabular}{llll}
+\textbf{HTTP request} & \textbf{URL} & \textbf{Action} & \textbf{Purpose} \\ \hline
+
+\texttt{GET} & /users & \texttt{index} & page to list all users \\
+\texttt{GET} & /users/1 & \texttt{show} & page to show user with id \texttt{1}\\
+\texttt{GET} & /users/new & \texttt{new} & page to make a new user \\
+\texttt{POST} & /users & \texttt{create} & create a new user \\
+\texttt{GET} & /users/1/edit & \texttt{edit} & page to edit user with id \texttt{1} \\
+\texttt{PATCH} & /users/1 & \texttt{update} & update user with id \texttt{1}  \\
+\texttt{DELETE} & /users/1 & \texttt{destroy} & delete user with id \texttt{1}
+\end{tabular}
+
+\begin{table}
+\begin{tabular}{llll}
+\textbf{HTTP request} & \textbf{URL} & \textbf{Action} & \textbf{Purpose} \\ \hline
+
+\texttt{GET} & /users & \texttt{index} & page to list all users \\
+\texttt{GET} & /users/1 & \texttt{show} & page to show user with id \texttt{1}\\
+\texttt{GET} & /users/new & \texttt{new} & page to make a new user \\
+\texttt{POST} & /users & \texttt{create} & create a new user \\
+\texttt{GET} & /users/1/edit & \texttt{edit} & page to edit user with id \texttt{1} \\
+\texttt{PATCH} & /users/1 & \texttt{update} & update user with id \texttt{1}  \\
+\texttt{DELETE} & /users/1 & \texttt{destroy} & delete user with id \texttt{1}
+\end{tabular}
+\caption{The default \href{http://rubyonrails.org/}{Rails} actions.\label{table:rails_actions}}
+\end{table}
+
+\section{Command-line interface}
+
+\PolyTeXnic\ comes with a command-line interface called \kode{poly}. To get more information, just run \kode{poly help}:
+
+%= lang:console
+\begin{code}
+$ poly help
+Commands:
+  poly build, build:all           # Build all formats
+  poly build:epub                 # Build EPUB
+  poly build:html                 # Build HTML
+  poly build:mobi                 # Build MOBI
+  poly build:pdf                  # Build PDF
+  poly build:preview              # Build book preview in all formats
+  poly config                     # View local config
+  poly config:add key=value       # Add to your local config vars
+  poly epub:validate, epub:check  # Validate EPUB with epubcheck
+  poly help [COMMAND]             # Describe available commands...
+  poly login                      # Log into Softcover account
+  poly logout                     # Log out of Softcover account
+  poly new <name>                 # Generate new book directory structure.
+  poly open                       # Open book on Softcover website (OS X only)
+  poly publish                    # Publish your book on Softcover
+  poly publish:screencasts        # Publish screencasts
+  poly server                     # Run local server
+\end{code}
+
+For additional help on a given command, run \kode{poly help <command>}:
+%= lang:console
+\begin{code}
+$ poly help build
+Usage:
+  poly build, build:all
+
+Options:
+  -q, [--quiet]   # Quiet output
+  -s, [--silent]  # Silent output
+
+Build all formats
+\end{code}
+
+
+\section{Miscellanea}
+
+This is the end of the template---apart from two mostly empty chapters (Chapter~\ref{cha:another_chapter} and Chapter~\ref{cha:yet_another_chapter}). In fact, let's include Chapter~\ref{cha:yet_another_chapter} in its entirety, just to see how mostly empty it is:
+
+%= <<(chapters/yet_another_chapter.tex)
+
+Visit \href{http://polytexnic.org/book}{http://polytexnic.org/book} to learn more about what \PolyTeXnic\ can do.

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

@@ -0,0 +1,5 @@
+# Another chapter
+
+This is another chapter.[^numbering]
+
+[^numbering]: Footnotes are numbered on a per-chapter basis.

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

@@ -0,0 +1,4 @@
+\chapter{Another chapter}
+\label{cha:another_chapter}
+
+This is a reference to Chapter~\ref{cha:a_chapter}.\footnote{Footnotes are numbered on a per-chapter basis.} In particular, Section~\ref{sec:a_section} talks about code and math. I'm particularly partial to Listing~\ref{code:hello_world} and Eq.~\eqref{eq:stokes_theorem}.

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

@@ -0,0 +1,3 @@
+# Preface
+
+This is an example of "frontmatter", which comes before the main text of the book.

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

@@ -0,0 +1,3 @@
+\chapter*{Preface}
+
+This is an example of ``frontmatter'', which comes before the main text of the book. Note the asterisk after the chapter command (``chapter star''), which suppresses \LaTeX's default numbering.