softcover 1.0.5 → 1.1.beta1

data/lib/softcover/book_template/latex_styles/language_customization.sty

@@ -0,0 +1,11 @@
+% This file is automatically overwritten; do not edit.
+
+% Aside box label
+\renewcommand{\boxlabel}{Box}
+
+% Codelisting captions
+\usepackage[hypcap=false]{caption}
+\DeclareCaptionFormat{listing}{\hspace{-0.2em}\colorbox[gray]{.85}{\hspace{0.1em}\parbox{0.997\textwidth}{#1#2#3}}\vspace{-1.3\baselineskip}}
+\captionsetup[listing]{format=listing,labelfont=bf,skip=16pt,font={rm,normalsize}}
+\DeclareCaptionType{listing}
+\newcommand{\codecaption}[1]{\captionof{listing}{#1}}

data/lib/softcover/book_template/latex_styles/softcover.sty

@@ -0,0 +1,174 @@
+% This is a generated file. Do not edit.
+
+% Page size
+% These settings are optimized for ebooks.
+% If you want different settings, override them in custom_pdf.sty.
+\setlength{\oddsidemargin}{.25in}
+\setlength{\evensidemargin}{.25in}
+\setlength{\textheight}{8in}
+\setlength{\textwidth}{6.25in}
+\setlength{\topmargin}{0in}
+
+% Font encodings
+\usepackage[T1]{fontenc}
+% Be able to define colors
+\usepackage[svgnames]{xcolor}
+% Be able to include book covers
+\usepackage{pdfpages}
+% Include graphics
+\usepackage{graphicx}
+\def\maxwidth#1{\ifdim\Gin@nat@width>#1 #1\else\Gin@nat@width\fi}
+% Support the \url command
+\usepackage{url}
+% Commands included by PolyTeXnic
+\usepackage{latex_styles/polytexnic_commands}
+% Links
+\definecolor{darkblue}{rgb}{0,0.18,0.45}
+\definecolor{darkgreen}{rgb}{0,0.39,0}
+% Bizarrely, we need to define the ALL CAPS version of DARKGREEN to account
+% for some edge cases, whose nature remains mysterious.
+\definecolor{DARKGREEN}{rgb}{0,0.39,0}
+\definecolor{hilightyellow}{rgb}{1.0,1.0,0.8}
+% Configure hyperref footnotes
+\usepackage[hyperfootnotes=false]{hyperref}
+\hypersetup{hyperfootnotes=false}
+\hypersetup{colorlinks,linkcolor=darkblue,urlcolor=blue}
+% Syntax highlighting
+\usepackage{latex_styles/pygments}
+% Change color of '@go', "general output", from gray to dark green.
+\expandafter\def\csname PY@tok@go\endcsname{\def\PY@tc##1{\textcolor{darkgreen}{##1}}}
+% American Mathematical Society extensions
+\usepackage{amsmath}
+\usepackage{amsfonts}
+% 'Verbatim' environment
+\usepackage{fancyvrb}
+% Be able to resize text relative to other text
+\usepackage{relsize}
+% Support longtable environment.
+\usepackage{longtable}
+% Support strikethrough (via \sout{text})
+\usepackage[normalem]{ulem}
+
+% Configure fonts
+\renewcommand{\rmdefault}{ptm}
+\usepackage{courier}
+\normalfont % in case the EC fonts aren't available
+
+% Code environments
+\DefineVerbatimEnvironment%
+  {code}{Verbatim}{fontsize=\relsize{-2.5},fontseries=b}
+% The metacode environment exists solely to allow meta-discussion of the code
+% environment, as in
+%   %= lang:latex
+%   \begin{metacode}
+%   %= lang:ruby
+%   \begin{code}
+%   def foo
+%     "bar"
+%   end
+%   \end{code}
+%   \end{metacode}
+\DefineVerbatimEnvironment%
+  {metacode}{Verbatim}{fontsize=\relsize{-2.5},fontseries=b}
+% Use a nice font in code environments.
+\usepackage[scaled=0.92]{helvet}
+
+% Filesystem paths
+\newcommand{\filepath}[1]{\textit{\texttt{\small #1}}}
+
+% Size-constrained images
+\newcommand{\image}[1]{\begin{center}\includegraphics[width=\maxwidth{0.95\textwidth}]{#1}\end{center}}
+\newcommand{\imagebox}[1]{\begin{center}\fbox{\includegraphics[width=\maxwidth{0.95\textwidth}]{#1}}\end{center}}
+
+\newenvironment{framed_shaded}{%
+  \def\FrameCommand##1{\hskip\@totalleftmargin
+  \fcolorbox{boxcolor}{shadecolor}{##1}%
+      % There is no \@totalrightmargin, so:
+      \hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth}%
+  \MakeFramed {\advance\hsize-\width
+    \@totalleftmargin\z@ \linewidth\hsize
+    \advance\labelsep\fboxsep
+    \@setminipage\vspace{0.3em}}%
+ }{\vspace{-0.6em}\par\unskip\@minipagefalse\endMakeFramed}
+
+\newenvironment{full_framed_shaded}{%
+  \def\FrameCommand{\fboxsep=\FrameSep\fcolorbox{boxcolor}{shadecolor}}%
+  \MakeFramed {\advance\hsize\width \FrameRestore}}%
+ {\endMakeFramed}
+
+\newenvironment{container}{%
+  \def\FrameCommand##1{\hskip\@totalleftmargin \hskip-\fboxsep
+  \colorbox{white}{##1}\hskip-\fboxsep
+      % There is no \@totalrightmargin, so:
+      \hskip-\linewidth \hskip-\@totalleftmargin \hskip\columnwidth}%
+  \MakeFramed {\advance\hsize-\width
+    \@totalleftmargin\z@ \linewidth\hsize
+    \@setminipage}%
+ }{\par\unskip\@minipagefalse\endMakeFramed}
+
+% Caption styling
+\usepackage[font={it,small}]{caption}
+
+% Codelistings
+\newcounter{codelisting}
+\@ifundefined{chapter}{}{\numberwithin{codelisting}{chapter}}
+\newenvironment{codelisting}{\refstepcounter{codelisting}\begin{framed_shaded}\vspace{-0.5em}}%
+{\end{framed_shaded}}
+% See latex_styles/language_customization.sty for codelisting captions.
+
+% Aside boxes
+\usepackage{amsthm}
+\theoremstyle{definition}
+\newcommand{\boxlabel}{Box}
+\@ifundefined{chapter}
+  {\newtheorem{aside}{\boxlabel}}
+  {\newtheorem{aside}{\boxlabel}[chapter]}
+\usepackage{latex_styles/framed}
+\definecolor{shadecolor}{gray}{0.97}
+\definecolor{boxcolor}{gray}{0.10}
+\newenvironment{shaded_aside}[2]{\begin{full_framed_shaded}\begin{aside}\label{#2} \textbf{#1}\end{aside}}{\bigskip\end{full_framed_shaded}}
+
+% Additional commands
+\newcommand{\heading}[1]{\textbf{#1}}
+\newcommand{\kodesize}{\smaller[0.75]}
+\newcommand{\kode}[1]{\textcolor{darkgreen}{\textbf{\texttt{\kodesize #1}}}}
+\newcommand{\coloredtext}[2]{\textcolor{#1}{#2}}
+\newcommand{\coloredtexthtml}[2]{\textcolor[HTML]{#1}{#2}}
+
+% Subtitle command
+\usepackage{titling}
+\newcommand{\subtitle}[1]{%
+  \posttitle{%
+    \par\end{center}
+    \begin{center}\large#1\end{center}
+    \vskip0.5em}%
+}
+
+% Enable the \pbox command for paragraph boxes in tables.
+\usepackage{pbox}
+
+% Enable float placement options.
+\usepackage{float}
+
+% Define some commonly used Unicode characters.
+\usepackage{newunicodechar}
+\newunicodechar{—}{---}
+\newunicodechar{–}{--}
+
+\usepackage{latex_styles/language_customization}
+
+% Fix quotes in code environments.
+% Provides "upquote.sty" functionality compatible with the latest Pygments.
+\RequirePackage{textcomp}
+\begingroup
+\catcode`'=\active
+\catcode``=\active
+\g@addto@macro\@noligs
+   {\let`\textasciigrave
+    \let'\textquotesingle
+    \let\PYZsq\textquotesingle}
+\endgroup
+
+% Include custom commands.
+\usepackage{latex_styles/custom}
+\usepackage{latex_styles/custom_pdf}

data/lib/softcover/builder.rb

@@ -14,7 +14,7 @@ module Softcover
     end
 
     def build!(options={})
-      setup
+      setup(options)
       build(options)
       verify
       self

data/lib/softcover/builders/epub.rb

@@ -34,8 +34,8 @@ module Softcover
     end
 
     # Returns a content.opf file based on a valid template.
-    def content_opf_template(title, copyright, author, uuid, cover_id, 
-                             toc_chapters, manifest_chapters, images)        
+    def content_opf_template(title, copyright, author, uuid, cover_id,
+                             toc_chapters, manifest_chapters, images)
 %(<?xml version="1.0" encoding="UTF-8"?>
 <package unique-identifier="BookID" version="3.0" xmlns="http://www.idpf.org/2007/opf">
   <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:dcterms="http://purl.org/dc/terms/"
@@ -107,7 +107,7 @@ module Softcover
         </nav>
     </body>
 </html>
-)      
+)
     end
 
   end
@@ -135,7 +135,7 @@ module Softcover
         copy_image_files
         write_html(options)
         write_contents
-        create_style_files
+        create_style_files(options)
         make_epub(options)
         move_epub
       end
@@ -310,6 +310,10 @@ module Softcover
           png['alt'] = png_filename.sub('.png', '')
           svg.replace(png)
         end
+        # Make references relative.
+        source.css('a.hyperref').each do |ref_node|
+          ref_node['href'] = ref_node['href'].sub('.html', '_fragment.html')
+        end
         source.at_css('div#book').children.to_xhtml
       end
 
@@ -343,7 +347,7 @@ module Softcover
         !!string.match(/(?:\\\(|\\\[|\\begin{equation})/)
       end
 
-      def create_style_files
+      def create_style_files(options)
         html_styles = File.join('html', 'stylesheets')
         epub_styles = File.join('epub', 'OEBPS', 'styles')
 
@@ -352,7 +356,7 @@ module Softcover
                    clean_book_id(path("#{html_styles}/softcover.css")))
 
         # Copy over the EPUB-specific CSS.
-        template_dir = File.join(File.dirname(__FILE__), '..', 'template')
+        template_dir = Softcover::Utils.template_dir(options)
         epub_css     = File.join(template_dir, epub_styles, 'epub.css')
         FileUtils.cp(epub_css, epub_styles)
 
@@ -474,8 +478,8 @@ module Softcover
                    id = "img-#{label}"
                    %(<item id="#{id}" href="#{href}" media-type="image/#{ext}"/>)
                  end
-        content_opf_template(manifest.title, manifest.copyright, 
-                             manifest.author, manifest.uuid, cover_id, 
+        content_opf_template(manifest.title, manifest.copyright,
+                             manifest.author, manifest.uuid, cover_id,
                              toc_ch, man_ch, images)
       end
 

data/lib/softcover/builders/html.rb

@@ -5,13 +5,13 @@ module Softcover
     class Html < Builder
       include Softcover::Utils
 
-      def setup
+      def setup(options)
         Dir.mkdir "html" unless File.directory?("html")
         html_styles = path('html/stylesheets')
         unless File.directory?(html_styles)
           Dir.mkdir html_styles
         end
-        template_dir = path("#{File.dirname(__FILE__)}/../template")
+        template_dir = Softcover::Utils.template_dir(options)
         custom_css = path("#{template_dir}/html/stylesheets/custom.css")
         target = path("#{html_styles}/custom.css")
         FileUtils.cp(custom_css, target) unless File.exist?(target)
@@ -24,8 +24,6 @@ module Softcover
           RubyProf.start
         end
 
-        write_master_latex_file(manifest)
-
         if manifest.markdown?
           unless options[:'find-overfull']
             remove_unneeded_polytex_files
@@ -50,7 +48,7 @@ module Softcover
                                          '..', 'server', 'views',
                                          'book.html.erb'))
           file_content = ERB.new(erb_file).result(binding)
-          write_full_html_file(manifest.slug, file_content)
+          write_full_html_file(manifest.slug, file_content, options)
           write_chapter_html_files(Nokogiri::HTML(file_content), erb_file)
         end
 
@@ -59,7 +57,7 @@ module Softcover
           printer = RubyProf::GraphPrinter.new(result)
           printer.print(STDOUT, {})
         end
-
+        write_master_latex_file(manifest)
         true
       end
 
@@ -103,7 +101,8 @@ module Softcover
         p = Polytexnic::Pipeline.new(markdown,
                                      source: :markdown,
                                      custom_commands: Softcover.custom_styles,
-                                     language_labels: language_labels)
+                                     language_labels: language_labels,
+                                     article: Softcover::Utils.article?)
         p.polytex
       end
 
@@ -118,20 +117,21 @@ module Softcover
         end
         Polytexnic::Pipeline.new(polytex,
                                  custom_commands: Softcover.custom_styles,
-                                 language_labels: language_labels).to_html
+                                 language_labels: language_labels,
+                                 article: Softcover::Utils.article?).to_html
       end
 
       # Writes the full HTML file for the book.
       # The resulting file is a self-contained HTML document suitable
       # for viewing in isolation.
-      def write_full_html_file(basename, file_content)
+      def write_full_html_file(basename, file_content, options)
         html_filename = File.join('html', basename + '.html')
         File.open(html_filename, 'w') do |f|
           f.write(file_content)
         end
         polytexnic_css = File.join('html', 'stylesheets', 'softcover.css')
-        source_css     = File.join(File.dirname(__FILE__),
-                                   "../template/#{polytexnic_css}")
+        source_css     = File.join(Softcover::Utils.template_dir(options),
+                                   polytexnic_css)
         FileUtils.cp source_css, polytexnic_css
         write_pygments_file(:html, File.join('html', 'stylesheets'))
         built_files.push html_filename
@@ -155,21 +155,34 @@ module Softcover
         chapter_number = 0
         current_chapter = manifest.chapters.first
         reference_cache = {}
-        xml.css('#book>div').each do |node|
-          klass = node.attributes['class'].to_s
-          id = node.attributes['id'].to_s
-          if klass == 'chapter' || id == 'frontmatter'
-            current_chapter = manifest.chapters[chapter_number]
-            node['data-chapter'] = current_chapter.slug
-            chapter_number += 1
+        if Softcover::Utils.article?
+          # Include all the material before the first section.
+          xml.css('#book').children.each do |node|
+            next if node['id'] == 'title_page'
+            break if node['class'] == 'section'
+            current_chapter.nodes.push node
           end
+        end
+        xml.css('#book>div').each do |node|
+          # Include the title page info.
+          if node['id'] == 'title_page'
+            current_chapter.nodes.unshift node
+          else
+            klass = node.attributes['class'].to_s
+            id = node.attributes['id'].to_s
+            if klass == 'chapter' || id == 'frontmatter'
+              current_chapter = manifest.chapters[chapter_number]
+              node['data-chapter'] = current_chapter.slug
+              chapter_number += 1
+            end
 
-          reference_cache[node['data-tralics-id']] = current_chapter
-          node.xpath('.//*[@data-tralics-id]').each do |labeled_node|
-            reference_cache[labeled_node['data-tralics-id']] = current_chapter
-          end
+            reference_cache[node['data-tralics-id']] = current_chapter
+            node.xpath('.//*[@data-tralics-id]').each do |labeled_node|
+              reference_cache[labeled_node['data-tralics-id']] = current_chapter
+            end
 
-          current_chapter.nodes.push node
+            current_chapter.nodes.push node
+          end
         end
         reference_cache
       end
@@ -217,6 +230,12 @@ module Softcover
       # Writes the chapter as a complete, self-contained HTML document.
       def write_complete_file(chapter, erb_file, n)
         html_filename = File.join('html', chapter.slug + '.html')
+        # Make references absolute.
+        chapter.nodes.each do |node|
+          node.css('a.hyperref').each do |ref_node|
+            ref_node['href'] = ref_node['href'].sub('_fragment', '')
+          end
+        end
         File.open(html_filename, 'w') do |f|
           @html = chapter.nodes.map(&:to_xhtml).join("\n")
           @mathjax = Softcover::Mathjax::config(chapter_number: n)

data/lib/softcover/builders/pdf.rb

@@ -41,7 +41,7 @@ module Softcover
           File.write(Softcover::Utils.tmpify(manifest, filename), latex)
         end
         write_pygments_file(:latex, Softcover::Directories::STYLES)
-        copy_polytexnic_sty
+        copy_polytexnic_sty(options)
 
         # Renaming the PDF in the command is necessary because `execute`
         # below uses `exec` (except in tests, where it breaks). Since `exec`
@@ -148,11 +148,11 @@ module Softcover
         end
 
         # Copies the style file to ensure it's always fresh.
-        def copy_polytexnic_sty
+        def copy_polytexnic_sty(options)
           softcover_sty  = File.join(Softcover::Directories::STYLES,
                                      'softcover.sty')
-          source_sty     = File.join(File.dirname(__FILE__),
-                                     '..', 'template', softcover_sty)
+          source_sty     = File.join(Softcover::Utils.template_dir(options), 
+                                     softcover_sty)
           FileUtils.cp source_sty, softcover_sty
         end
     end

data/lib/softcover/cli.rb

@@ -200,12 +200,17 @@ module Softcover
     # Generator
     # ===============================================
 
-    desc "new <name>", "Generate new book directory structure"
+    desc "new <name>", "Generate new document directory structure"
     method_option :polytex,
                   :type => :boolean,
                   :default => false,
                   :aliases => "-p",
-                  :desc => "Generate a PolyTeX book."
+                  :desc => "Generate a PolyTeX document."
+    method_option :article,
+                  :type => :boolean,
+                  :default => false,
+                  :aliases => "-a",
+                  :desc => "Generate an article instead of a book."
     def new(n)
       Softcover::Commands::Generator.generate_file_tree(n, options)
     end

data/lib/softcover/commands/generator.rb

@@ -9,6 +9,8 @@ module Softcover
       def generate_file_tree(name, options = {})
         @name = name
         @markdown = !options[:polytex]
+        @article = options[:article]
+        template_dir = Softcover::Utils.template_dir(article: @article)
 
         thor = Thor::Shell::Basic.new
 
@@ -81,11 +83,7 @@ module Softcover
         book_yml = File.join(Softcover::Directories::CONFIG, 'book.yml')
         puts "Done. Please update #{book_yml}"
       end
-
-      def template_dir
-        File.expand_path File.join File.dirname(__FILE__), "..", "template"
-      end
-
+      
       # Returns a list of all the files and directories used to build the book.
       def all_files_and_directories
         files_directories_maybe_markdown
@@ -93,7 +91,9 @@ module Softcover
 
       # Returns the files and directories based on the input format.
       def files_directories_maybe_markdown
-        fds = Dir.glob(File.join(template_dir, "**/*"), File::FNM_DOTMATCH)
+        fds = Dir.glob(
+                File.join(Softcover::Utils.template_dir(article: @article), 
+                          "**/*"), File::FNM_DOTMATCH)
         if markdown?
           # Skip the PolyTeX chapter files, which will be generated later.
           fds.reject { |e| e =~ /\/chapters\/.*\.tex/ }