softcover 1.0.5 → 1.1.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f9f3eb15e6fbec7019ecc06fa6a402bf9ff834e
-  data.tar.gz: c2cbb02f31d25ae06db8ef4429e01ec9449a99ec
+  metadata.gz: 8a74e00ffe39d6b7b2a6f772bd698f3fe138b0a9
+  data.tar.gz: 516e5a62be24069edc9ecc2e3ea64fcba564ab78
 SHA512:
-  metadata.gz: cd151c9b82682172feab47891a84653eab0e874f2467913865dbee759f52005a2a7fe03011daf00015741952aed036441457d6f5b97daddf39ff81121ce03ba2
-  data.tar.gz: 11e83d009e8790358cb43a21547e0a29256426a50c3d6f06396a4aae8176c975178825fc8bba8ec8a3a6d0ac37509c6a2928770f0955239e746c271e71a5b398
+  metadata.gz: bce9e2b9c19ddbc2f640a7c910b6c5a3a27da614d78d56efc0241839119cc44f9cffe3c54ee33990bf60c647c39336cab6e8f15387dbc1b91f3d9f39438e5fee
+  data.tar.gz: 26fb6a92a58ab407c823d6ff7786ef4fc529cf4223b1bfe5fe1667f133de7cd46ad5c2cdf70ead916ac1e4657473e7042d2aaa56c0aaee0fd0add584015f4d58

data/lib/softcover/article_template/Book.txt

@@ -0,0 +1,3 @@
+cover
+maketitle
+an_article.md

data/lib/softcover/article_template/chapters/an_article.md

@@ -0,0 +1,100 @@
+# Title of the Article
+
+The is the first paragraph of the Softcover document template. It shows how to write a document in [Markdown](http://daringfireball.net/projects/markdown/), augmented with some custom extensions, including numbered footnotes[^sample-footnote] and embedded \LaTeX.[^pronunciation]
+
+This is the second paragraph, showing how to *emphasize* text. You can also make text **bold**.
+
+## A section
+\label{sec:a_section}
+
+This is a section. We'll take a look at some of the features supported by Softcover.
+
+### Source code
+
+In plain Markdown, you can typeset code samples and other verbatim text using four spaces of indentation:
+
+    def hello
+      puts "hello, world"
+    end
+
+Softcover also supports GitHub-style "code fencing" with language-specific syntax highlighting:
+
+```ruby
+def hello
+  puts "hello, world!"
+end
+```
+
+The second of these can be combined with Softcover's `codelisting` environment to make code listings via embedded \LaTeX, as shown in Listing~\ref{code:hello}.
+
+\begin{codelisting}
+\codecaption{Hello, world.}
+\label{code:hello}
+```ruby
+def hello
+  puts "hello, world!"
+end
+```
+\end{codelisting}
+
+
+### Mathematics
+
+Softcover supports mathematical typesetting via embedded \LaTeX. This includes both inline math, such as \( \phi^2 - \phi - 1 = 0, \) and centered math, such as
+\[ \phi^2 - \phi - 1 = 0. \]
+Softcover also supports numbered equations via embedded \LaTeX, as seen in Eq.~\eqref{eq:phi} and Eq.~\eqref{eq:gauss}.
+
+\begin{equation}
+\label{eq:phi}
+\phi = \frac{1+\sqrt{5}}{2} \approx 1.618
+\end{equation}
+
+\begin{equation}
+\label{eq:gauss}
+\mathbf{\nabla}\cdot\mathbf{B} = 0 \qquad\mbox{Gauss's law}
+\end{equation}
+
+
+## Images and tables
+\label{sec:images_and_tables}
+
+This is the second section. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+
+### Images
+
+Softcover supports the inclusion of images, like this:
+
+![Some dude.](images/01_michael_hartl_headshot.jpg)
+
+Using \LaTeX\ labels, you can also include a caption (as in Figure~\ref{fig:captioned_image}) or just a figure number (as in Figure~\ref{fig:figure_number}).
+
+![Some dude.\label{fig:captioned_image}](images/01_michael_hartl_headshot.jpg)
+
+![\label{fig:figure_number}](images/01_michael_hartl_headshot.jpg)
+
+### 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` |
+
+
+## Final section
+
+This is the final section. The previous sections were Section~\ref{sec:a_section} and Section~\ref{sec:images_and_tables}.
+
+[^sample-footnote]: Like this.
+
+[^pronunciation]: Pronunciations of "LaTeX" differ, but *lay*-tech is the one I prefer.

data/lib/softcover/article_template/chapters/an_article.tex

@@ -0,0 +1,170 @@
+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}}. To learn how to easily publish (and optionally sell) documents produced with Softcover, visit \href{http://softcover.io/}{Softcover.io}.
+
+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).
+
+\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.
+
+Softcover comes with full support for syntax-highlighted source code:
+%= lang:ruby
+\begin{code}
+def hello
+  puts "hello, world!"
+end
+\end{code}
+\noindent Softcover can highlight any language supported by \href{http://pygments.org/languages/}{Pygments} (which is 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\_pdf.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{latex\_styles/custom\_pdf.sty}}
+%= <<(latex_styles/custom_pdf.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}
+
+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}.
+
+\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}.
+
+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}
+
+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}
+
+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
+
+\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}
+
+Softcover comes with a command-line interface called \kode{poly}. To get more information, just run \kode{softcover help}:
+
+%= lang:console
+\begin{code}
+$ 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
+  .
+  .
+  .
+\end{code}
+
+\noindent You can run \kode{softcover help <command>} to get additional help on a given command:
+
+%= lang:console
+\begin{code}
+$ softcover help build
+Usage:
+  softcover build, build:all
+
+Options:
+  -q, [--quiet]   # Quiet output
+  -s, [--silent]  # Silent output
+
+Build all formats
+\end{code}

data/lib/softcover/article_template/config/book.yml.erb

@@ -0,0 +1,11 @@
+---
+slug: <%= name %>
+filename: <%= name %>
+title: Original Article Title
+subtitle: Change me
+description: Change me.
+author: Author Name
+copyright: <%= Time.new.year %>
+uuid: <%= SecureRandom.uuid %>
+pdf_preview_page_range: 1..30
+epub_mobi_preview_chapter_range: 0..1

data/lib/softcover/article_template/config/preamble.tex

@@ -0,0 +1,8 @@
+\documentclass[14pt]{extarticle} % Edit this line to change the documentclass.
+% Add custom preamble content below.
+% Example commands for using the Polyglossia package with French are
+% included for reference.
+% You may also have to edit config/lang.yml to sync up the HTML/EPUB/MOBI.
+% \usepackage{polyglossia}
+% \setdefaultlanguage{french}
+% \DeclareTextCommandDefault{\nobreakspace}{\leavevmode\nobreak\ }