review 2.0.0 → 2.1.0

data/lib/review/preprocessor.rb

@@ -107,7 +107,7 @@ module ReVIEW
 
     private
 
-    TYPES = %w( file range )
+    TYPES = %w(file range)
 
     def preproc(f)
       init_vars
@@ -161,7 +161,7 @@ module ReVIEW
       end
     end
 
-    KNOWN_DIRECTIVES = %w( require provide warn ok )
+    KNOWN_DIRECTIVES = %w(require provide warn ok)
 
     def known_directive?(op)
       KNOWN_DIRECTIVES.index(op)

data/lib/review/topbuilder.rb

@@ -503,10 +503,28 @@ module ReVIEW
       [str.to_i(16)].pack("U")
     end
 
+    def inline_comment(str)
+      if @book.config["draft"]
+        %Q[◆→DTP連絡:#{str}←◆]
+      else
+        ""
+      end
+    end
+
     def inline_m(str)
       %Q[◆→TeX式ここから←◆#{str}◆→TeX式ここまで←◆]
     end
 
+    def inline_hd_chap(chap, id)
+      if chap.number
+        n = chap.headline_index.number(id)
+        if @book.config["secnolevel"] >= n.split('.').size
+          return I18n.t("chapter_quote", "#{n}　#{compile_inline(chap.headline(id).caption)}")
+        end
+      end
+      I18n.t("chapter_quote", compile_inline(chap.headline(id).caption))
+    end
+
     def noindent
       puts "◆→DTP連絡:次の1行インデントなし←◆"
     end

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/review/webtocprinter.rb

@@ -1,4 +1,5 @@
 require 'review/tocprinter'
+require 'review/i18n'
 
 module ReVIEW
   class WEBTOCPrinter < TOCPrinter
@@ -22,7 +23,13 @@ module ReVIEW
 
     def print_part(part)
       if part.number
-        @out.puts "<li>#{h(part.title)}\n<ul>\n"
+        if part.file?
+          ext = part.book.config["htmlext"] || "html"
+          path = part.path.sub(/\.re/, "."+ext)
+          @out.puts "<li><a href=\"#{path}\">#{h(I18n.t("part_short", part.number) + " " + part.title)}</a>\n<ul>\n"
+        else
+          @out.puts "<li>#{h(I18n.t("part_short", part.number) + " " + part.title)}\n<ul>\n"
+        end
       end
       part.each_chapter do |chap|
         print_chapter(chap)
@@ -37,7 +44,7 @@ module ReVIEW
       ext = chap.book.config["htmlext"] || "html"
       path = chap.path.sub(/\.re/, "."+ext)
       if chap_node.number && chap.on_CHAPS?
-        label = "#{chap.number} #{chap.title}"
+        label = "#{I18n.t("chapter_short", chap.number)} #{chap.title}"
       else
         label = chap.title
       end

data/templates/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006-2016 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+

data/templates/README.md

@@ -0,0 +1,8 @@
+# template files for Re:VIEW
+
+This directory is for template files of Re:VIEW.
+
+## License
+
+The license of files in this directory is MIT. See [LICENSE](./LICENSE) file.
+

data/templates/latex/layout.tex.erb

@@ -1,11 +1,17 @@
-\documentclass[<%= @documentclassoption %>]{<%= @documentclass %>}
+\documentclass[dvipdfmx,<%= @documentclassoption %>]{<%= @documentclass %>}
+% %% fixes to LaTeX2e
+% \usepackage{fix-cm}[2006/09/13 v1.1m]
+% \usepackage{fixltx2e}[2006/09/13 v1.1m]
+
 <%- if @texcompiler == "uplatex" -%>
 \usepackage[deluxe,uplatex]{otf}
 <%- else -%>
 \usepackage[deluxe]{otf}
 <%- end -%>
-\usepackage[dvipdfmx]{color}
+\usepackage[T1]{fontenc}\usepackage{textcomp}%T1/TS1
+% \usepackage{lmodern}
 \usepackage[dvipdfmx]{graphicx}
+\usepackage[dvipdfmx,table]{xcolor}%requires colortbl, array
 \usepackage{framed}
 \usepackage{wrapfig}
 \definecolor{shadecolor}{gray}{0.9}
@@ -36,28 +42,11 @@
 \newcommand{\parasep}{\vspace*{3zh}}
 \setlength{\footskip}{30pt}
 
-<%- if @texcompiler == "uplatex" -%>
+%% Bookmarkの文字化け対策（日本語向け）
 \usepackage[dvipdfmx,bookmarks=true,bookmarksnumbered=true,colorlinks=true,%
-            pdftitle={<%= @config.name_of("booktitle") %>},%
-            pdfauthor={<%= @config.names_of("aut").join(I18n.t("names_splitter")) %>}]{hyperref}
-% uplatexでのBookmarkの文字化け対策（日本語向け）
+     pdftitle={<%= escape_latex(@config.name_of("booktitle")) %>},%
+     pdfauthor={<%= escape_latex(@config.names_of("aut").join(I18n.t("names_splitter"))) %>}]{hyperref}
 \usepackage[dvipdfmx]{pxjahyper}
-<%- else -%>
-%% Bookmarkの文字化け対策（日本語向け）
-\ifnum 46273=\euc"B4C1 % 46273 == 0xB4C1 == 漢(EUC-JP)
-  \usepackage{atbegshi}%
-  \AtBeginShipoutFirst{\special{pdf:tounicode EUC-UCS2}}%
-  %%\AtBeginDvi{\special{pdf:tounicode EUC-UCS2}}%
-\else
-  \usepackage{atbegshi}%
-  \AtBeginShipoutFirst{\special{pdf:tounicode 90ms-RKSJ-UCS2}}%
-  %%\AtBeginDvi{\special{pdf:tounicode 90ms-RKSJ-UCS2}}%
-\fi
-
-\usepackage[dvipdfm,bookmarks=true,bookmarksnumbered=true,colorlinks=true,%
-     pdftitle={<%= @config.name_of("booktitle") %>},%
-     pdfauthor={<%= @config.names_of("aut").join(I18n.t("names_splitter")) %>}]{hyperref}
-<%- end -%>
 
 <%- if ["utbook", "tbook"].include?(@documentclass)  -%>
 \newcommand{\headfont}{\gtfamily\sffamily\bfseries}
@@ -70,7 +59,7 @@
 <%-   else -%>
 \usepackage{listings}
 <%-   end -%>
-\renewcommand{\lstlistingname}{<%= I18n.t("list")%>}
+\renewcommand{\lstlistingname}{<%= escape_latex(I18n.t("list")) %>}
 \lstset{%
   breaklines=true,%
   breakautoindent=false,%
@@ -134,7 +123,7 @@
   \vspace{2zw}}
 
 \newcommand{\reviewcolumnhead}[2]{%
-{\noindent\large <%= I18n.t("column_head")%>: #2}}
+{\noindent\large <%= escape_latex(I18n.t("column_head"))%>: #2}}
 
 \newcommand{\reviewtablecaption}[1]{%
   \caption{#1}}
@@ -160,18 +149,20 @@
 \newcommand{\reviewboxcaption}[1]{%
   \medskip{\small\noindent #1}\vspace*{-1.3zw}}
 
-\newcommand{\reviewimageref}[2]{<%= I18n.t("image")%> #1}
-\newcommand{\reviewtableref}[2]{<%= I18n.t("table")%> #1}
-\newcommand{\reviewlistref}[1]{<%= I18n.t("list")%> #1}
+\newcommand{\reviewimageref}[2]{<%= escape_latex(I18n.t("image"))%> #1}
+\newcommand{\reviewtableref}[2]{<%= escape_latex(I18n.t("table"))%> #1}
+\newcommand{\reviewlistref}[1]{<%= escape_latex(I18n.t("list"))%> #1}
 \newcommand{\reviewbibref}[2]{#1}
-\newcommand{\reviewcolumnref}[2]{<%= I18n.t("columnname")%> #1}
+\newcommand{\reviewcolumnref}[2]{<%= escape_latex(I18n.t("columnname"))%> #1}
 \newcommand{\reviewsecref}[2]{#1}
 
 \newcommand{\reviewminicolumntitle}[1]{%
-  {\large <%= I18n.t("memo_head")%>: #1}\\}
+  {\large <%= escape_latex(I18n.t("memo_head"))%>: #1}\\}
 
 <%- if @config["toctitle"].present? -%>
-\renewcommand{\contentsname}{<%= @config["toctitle"]%>}
+\renewcommand{\contentsname}{<%= escape_latex(@config["toctitle"]) %>}
+<%- elsif I18n.t("toctitle") -%>
+\renewcommand{\contentsname}{<%= escape_latex(I18n.t("toctitle")) %>}
 <%- end -%>
 
 \newenvironment{reviewminicolumn}{%
@@ -199,6 +190,37 @@
 \newcommand{\reviewcolophon}[0]{\clearpage}
 \newcommand{\reviewappendix}[0]{\appendix}
 
+\newcommand{\reviewprepartname}{<%= escape_latex(@locale_latex["prepartname"]) %>}
+\newcommand{\reviewpostpartname}{<%= escape_latex(@locale_latex["postpartname"]) %>}
+\newcommand{\reviewprechaptername}{<%= escape_latex(@locale_latex["prechaptername"]) %>}
+\newcommand{\reviewpostchaptername}{<%= escape_latex(@locale_latex["postchaptername"]) %>}
+\newcommand{\reviewfigurename}{<%= escape_latex(I18n.t("image")) %>}
+\newcommand{\reviewtablename}{<%= escape_latex(I18n.t("table")) %>}
+\newcommand{\reviewappendixname}{<%= escape_latex(@locale_latex["preappendixname"]) %>}
+
+\ifdefined\prepartname
+  \renewcommand{\prepartname}{\reviewprepartname}
+\fi
+\ifdefined\postpartname
+  \renewcommand{\postpartname}{\reviewpostpartname}
+\fi
+\ifdefined\prechaptername
+  \renewcommand{\prechaptername}{\reviewprechaptername}
+\fi
+\ifdefined\postchaptername
+  \renewcommand{\postchaptername}{\reviewpostchaptername}
+\fi
+\ifdefined\figurename
+  \renewcommand{\figurename}{\reviewfigurename}
+\fi
+\ifdefined\tablename
+  \renewcommand{\tablename}{\reviewtablename}
+\fi
+\ifdefined\appendixname
+  \renewcommand{\appendixname}{\reviewappendixname}
+\fi
+
+
 \makeatletter
 %% maxwidth is the original width if it is less than linewidth
 %% otherwise use linewidth (to make sure the graphics do not exceed the margin)
@@ -215,8 +237,6 @@
 <%= @config["usepackage"] %>
 <%- end -%>
 
-\usepackage[T1]{fontenc}
-
 \begin{document}
 
 \reviewmainfont
@@ -236,7 +256,7 @@
 \begin{center}%
   \mbox{} \vskip5zw
    \reviewtitlefont%
-    {\Huge <%= @config.name_of("booktitle") %> \par}%
+    {\Huge <%= escape_latex(@config.name_of("booktitle")) %> \par}%
     \vskip 15em%
     {\huge
       \lineskip .75em
@@ -244,7 +264,7 @@
         <%= @authors %>
       \end{tabular}\par}%
     \vfill
-    {\large <%= @config["date"] %> <%= I18n.t("edition")%>\hspace{2zw}<%= I18n.t("published_by", @config.names_of("prt").join(I18n.t("names_splitter")))%>\par}%
+    {\large <%= escape_latex(@config["date"].to_s) %> <%= escape_latex(I18n.t("edition")) %>\hspace{2zw}<%= escape_latex(I18n.t("published_by", @config.names_of("pbl").join(I18n.t("names_splitter"))))%>\par}%
 \vskip4zw\mbox{}
   \end{center}%
 \end{titlepage}
@@ -309,7 +329,7 @@
 
 \vspace*{\fill}
 
-{\noindent\reviewtitlefont\Large <%= @config.name_of("booktitle") %>} \\
+{\noindent\reviewtitlefont\Large <%= escape_latex(@config.name_of("booktitle")) %>} \\
 \rule[8pt]{14cm}{1pt} \\
 {\noindent
 <%= @config["pubhistory"].to_s.gsub(/\n/){"\n\n\\noindent\n"} %>
@@ -320,7 +340,9 @@
 \end{tabular}
 　\\
 \rule[0pt]{14cm}{1pt} \\
-<%= @config.names_of("rights").join('\\' + '\\') %> \\
+<%-     if @config["rights"] -%>
+<%= @config.names_of("rights").map{|s| escape_latex(s)}.join('\\' + '\\') %> \\
+<%-     end -%>
 <%-   end -%>
 <%- end -%>
 

data/templates/web/html/layout-html5.html.erb

@@ -18,7 +18,7 @@
     <nav class="side-content">
       <h1><%=h @book.config["booktitle"] %></h1>
       <%= @toc %>
-      <p class="review-signature">powered by <a href="http://reviewml.com">Re:VIEW</a></p>
+      <p class="review-signature">powered by <a href="http://reviewml.org/">Re:VIEW</a></p>
     </nav>
     <div class="book-body">
       <header>

data/test/assets/test_template.tex

@@ -1,7 +1,13 @@
-\documentclass[uplatex,oneside]{jsbook}
+\documentclass[dvipdfmx,uplatex,oneside]{jsbook}
+% %% fixes to LaTeX2e
+% \usepackage{fix-cm}[2006/09/13 v1.1m]
+% \usepackage{fixltx2e}[2006/09/13 v1.1m]
+
 \usepackage[deluxe,uplatex]{otf}
-\usepackage[dvipdfmx]{color}
+\usepackage[T1]{fontenc}\usepackage{textcomp}%T1/TS1
+% \usepackage{lmodern}
 \usepackage[dvipdfmx]{graphicx}
+\usepackage[dvipdfmx,table]{xcolor}%requires colortbl, array
 \usepackage{framed}
 \usepackage{wrapfig}
 \definecolor{shadecolor}{gray}{0.9}
@@ -30,10 +36,10 @@
 \newcommand{\parasep}{\vspace*{3zh}}
 \setlength{\footskip}{30pt}
 
+%% Bookmarkの文字化け対策（日本語向け）
 \usepackage[dvipdfmx,bookmarks=true,bookmarksnumbered=true,colorlinks=true,%
-            pdftitle={Re:VIEW Sample Book},%
-            pdfauthor={}]{hyperref}
-% uplatexでのBookmarkの文字化け対策（日本語向け）
+     pdftitle={Re:VIEW Sample Book},%
+     pdfauthor={}]{hyperref}
 \usepackage[dvipdfmx]{pxjahyper}
 
 
@@ -115,6 +121,7 @@
 \newcommand{\reviewminicolumntitle}[1]{%
   {\large ■メモ: #1}\\}
 
+\renewcommand{\contentsname}{目次}
 
 \newenvironment{reviewminicolumn}{%
   \vspace{1.5zw}\begin{screen}}{%
@@ -141,6 +148,37 @@
 \newcommand{\reviewcolophon}[0]{\clearpage}
 \newcommand{\reviewappendix}[0]{\appendix}
 
+\newcommand{\reviewprepartname}{第}
+\newcommand{\reviewpostpartname}{部}
+\newcommand{\reviewprechaptername}{第}
+\newcommand{\reviewpostchaptername}{章}
+\newcommand{\reviewfigurename}{図}
+\newcommand{\reviewtablename}{表}
+\newcommand{\reviewappendixname}{付録}
+
+\ifdefined\prepartname
+  \renewcommand{\prepartname}{\reviewprepartname}
+\fi
+\ifdefined\postpartname
+  \renewcommand{\postpartname}{\reviewpostpartname}
+\fi
+\ifdefined\prechaptername
+  \renewcommand{\prechaptername}{\reviewprechaptername}
+\fi
+\ifdefined\postchaptername
+  \renewcommand{\postchaptername}{\reviewpostchaptername}
+\fi
+\ifdefined\figurename
+  \renewcommand{\figurename}{\reviewfigurename}
+\fi
+\ifdefined\tablename
+  \renewcommand{\tablename}{\reviewtablename}
+\fi
+\ifdefined\appendixname
+  \renewcommand{\appendixname}{\reviewappendixname}
+\fi
+
+
 \makeatletter
 %% maxwidth is the original width if it is less than linewidth
 %% otherwise use linewidth (to make sure the graphics do not exceed the margin)
@@ -154,8 +192,6 @@
 \makeatother
 
 
-\usepackage[T1]{fontenc}
-
 \begin{document}
 
 \reviewmainfont
@@ -173,7 +209,7 @@
         
       \end{tabular}\par}%
     \vfill
-    {\large 2011-01-01 版\hspace{2zw} 発行\par}%
+    {\large 2011{-}01{-}01 版\hspace{2zw} 発行\par}%
 \vskip4zw\mbox{}
   \end{center}%
 \end{titlepage}

data/test/book_test_helper.rb

@@ -10,14 +10,17 @@ include ReVIEW
 module BookTestHelper
   def mktmpbookdir(files = {})
     created_files = {}
-    Dir.mktmpdir do |dir|
-      files.each_pair do |basename, content|
-        path = File.join(dir, basename)
-        File.open(path, 'w') {|o| o.print content }
-        created_files[basename] = path
+    Dir.mktmpdir do |tmpdir|
+      Dir.chdir(tmpdir) do
+        dir = "."
+        files.each_pair do |basename, content|
+          path = File.join(dir, basename)
+          File.open(path, 'w') {|o| o.print content }
+          created_files[basename] = path
+        end
+        book = Book::Base.load(dir)
+        yield(dir, book, created_files)
       end
-      book = Book::Base.load(dir)
-      yield(dir, book, created_files)
     end
   end
 

data/test/sample-book/src/Rakefile

@@ -34,6 +34,13 @@ task :html_all do
   build_all("html")
 end
 
+desc 'preproc all'
+task :preproc do
+  Dir.glob("*.re").each do |file|
+    sh "review-preproc --replace #{file}"
+  end
+end
+
 desc 'generate PDF and EPUB file'
 task :all => [:pdf, :epub]
 

data/test/test_book.rb

@@ -154,7 +154,7 @@ class BookTest < Test::Unit::TestCase
     end
   end
 
-  # backword compatible
+  # backward compatible
   def test_setParameter
     book = Book::Base.new(File.dirname(__FILE__))
     book.config = :test
@@ -506,9 +506,6 @@ EOC
     end
 
     mktmpbookdir 'preface.re' => '12345' do |dir, book, files|
-      assert_raises(Errno::ENOENT, Errno::EINVAL) do # XXX: OK?
-        book.volume
-      end
 
       Dir.chdir(dir) do
         book2 = Book::Base.new('.')