review 3.0.0.preview3 → 3.0.0.preview4

data/samples/syntax-book/lib/tasks/review.rake

@@ -0,0 +1,113 @@
+# Copyright (c) 2006-2018 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.
+
+require 'fileutils'
+require 'rake/clean'
+
+BOOK = ENV['REVIEW_BOOK'] || 'book'
+BOOK_PDF = BOOK + '.pdf'
+BOOK_EPUB = BOOK + '.epub'
+CONFIG_FILE = ENV['REVIEW_CONFIG_FILE'] || 'config.yml'
+CATALOG_FILE = ENV['REVIEW_CATALOG_FILE'] || 'catalog.yml'
+WEBROOT = ENV['REVIEW_WEBROOT'] || 'webroot'
+TEXTROOT = BOOK + '-text'
+TOPROOT = BOOK + '-text'
+
+def build(mode, chapter)
+  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
+  mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml', 'top' => 'txt', 'plaintext' => 'txt' }
+  FileUtils.mv 'tmp', chapter.gsub(/re\z/, mode_ext[mode])
+end
+
+def build_all(mode)
+  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css"
+end
+
+task default: :html_all
+
+desc 'build html (Usage: rake build re=target.re)'
+task :html do
+  if ENV['re'].nil?
+    puts 'Usage: rake build re=target.re'
+    exit
+  end
+  build('html', ENV['re'])
+end
+
+desc 'build all html'
+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: %i[pdf epub]
+
+desc 'generate PDF file'
+task pdf: BOOK_PDF
+
+desc 'generate static HTML file for web'
+task web: WEBROOT
+
+desc 'generate text file (without decoration)'
+task plaintext: TEXTROOT do
+  sh "review-textmaker -n #{CONFIG_FILE}"
+end
+
+desc 'generate (decorated) text file'
+task text: TOPROOT do
+  sh "review-textmaker #{CONFIG_FILE}"
+end
+
+desc 'generate EPUB file'
+task epub: BOOK_EPUB
+
+IMAGES = FileList['images/**/*']
+OTHERS = ENV['REVIEW_DEPS'] || []
+SRC = FileList['./**/*.re', '*.rb'] + [CONFIG_FILE, CATALOG_FILE] + IMAGES + FileList[OTHERS]
+SRC_EPUB = FileList['*.css']
+SRC_PDF = FileList['layouts/*.erb', 'sty/**/*.sty']
+
+file BOOK_PDF => SRC + SRC_PDF do
+  FileUtils.rm_rf [BOOK_PDF, BOOK, BOOK + '-pdf']
+  sh "review-pdfmaker #{CONFIG_FILE}"
+end
+
+file BOOK_EPUB => SRC + SRC_EPUB do
+  FileUtils.rm_rf [BOOK_EPUB, BOOK, BOOK + '-epub']
+  sh "review-epubmaker #{CONFIG_FILE}"
+end
+
+file WEBROOT => SRC do
+  FileUtils.rm_rf [WEBROOT]
+  sh "review-webmaker #{CONFIG_FILE}"
+end
+
+file TEXTROOT => SRC do
+  FileUtils.rm_rf [TEXTROOT]
+end
+
+CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT, 'images/_review_math', TEXTROOT])

data/samples/syntax-book/lib/tasks/z01_copy_sty.rake

@@ -0,0 +1,17 @@
+desc 'copy sty/* files from current Re:VIEW source code (in git repos)'
+task :copy_sty do
+  review_rootdir = '../..'
+  jsbook_dir = File.join(review_rootdir, 'templates/latex/review-jsbook')
+  gentombow_dir = File.join(review_rootdir, 'vendor/gentombow')
+  Dir.glob(File.join(jsbook_dir, '*.cls')) do |file|
+    FileUtils.cp file, 'sty'
+  end
+  Dir.glob(File.join(jsbook_dir, 'review-*.sty')) do |file|
+    FileUtils.cp file, 'sty'
+  end
+  FileUtils.cp File.join(gentombow_dir, 'gentombow.sty'), 'sty/gentombow09j.sty'
+end
+
+CLEAN.include([Dir.glob('sty/review-*.sty'), 'sty/review-jsbook.cls', 'sty/gentombow09j.sty'])
+
+Rake::Task[BOOK_PDF].enhance([:copy_sty])

data/samples/syntax-book/sty/reviewmacro.sty

@@ -1,39 +1,15 @@
-%% from review-pdfmaker
-\usepackage{fancyhdr}
-\pagestyle{fancy}
-\lhead{\gtfamily\sffamily\bfseries\upshape \leftmark}
-\chead{}
-\rhead{\gtfamily\sffamily\bfseries\upshape \rightmark}
-\renewcommand{\sectionmark}[1]{\markright{\thesection~#1}{}}
-\renewcommand{\chaptermark}[1]{\markboth{\prechaptername\ \thechapter\ \postchaptername~#1}{}}
-\renewcommand{\headfont}{\gtfamily\sffamily\bfseries}
+% Re:VIEW 2互換のlayout.tex.erb記載相当の内容
+\RequirePackage{review-base}
 
-\fancypagestyle{plainhead}{%
-\fancyhead{}
-\fancyfoot{} % clear all header and footer fields
-\fancyfoot[CE,CO]{\thepage}
-\renewcommand{\headrulewidth}{0pt}
-\renewcommand{\footrulewidth}{0pt}}
+% Re:VIEW 2互換のreviewmacro.sty(装飾カスタマイズ)内容
+\RequirePackage{review-style}
 
-%% using Helvetica as sans-serif
-\renewcommand{\sfdefault}{phv}
+% ユーザー固有の定義
+\RequirePackage{review-custom}
 
-%% for listings
-%\renewcommand{\lstlistingname}{List}
-%\lstset{%
-%  breaklines=true,%
-%  breakautoindent=false,%
-%  breakindent=0pt,%
-%  fontadjust=true,%
-%  backgroundcolor=\color{shadecolor},%
-%  frame=single,%
-%  framerule=0pt,%
-%  basicstyle=\ttfamily\scriptsize,%
-%  commentstyle=\color{reviewgreen},%
-%  identifierstyle=\color{reviewblue},%
-%  stringstyle=\color{reviewred},%
-%  keywordstyle=\bfseries\color{reviewdarkred},%
-%}
+%% run \@endofreviewmacrohook at the end of reviewmacro style
+\@ifundefined{@endofreviewmacrohook}{}{%
+\let\AtEndOfReVIEWMacro\@firstofone
+\@endofreviewmacrohook}
 
-
-\sloppy
+\endinput

data/templates/latex/config.erb

@@ -31,6 +31,7 @@
 \def\review@intn@columnhead{<%= escape_latex(I18n.t('column_head')) %>}
 \def\review@intn@image{<%= escape_latex(I18n.t('image')) %>}
 \def\review@intn@table{<%= escape_latex(I18n.t('table')) %>}
+\def\review@intn@equation{<%= escape_latex(I18n.t('equation')) %>}
 \def\review@intn@columnname{<%= escape_latex(I18n.t('columnname')) %>}
 \def\review@intn@memohead{<%= escape_latex(I18n.t('memo_head')) %>}
 \def\review@intn@edition{<%= escape_latex(I18n.t('edition')) %>}

data/templates/latex/review-jlreq/review-base.sty

@@ -93,9 +93,13 @@
 \newcommand{\reviewcmdcaption}[1]{\review@commoncaption{}{#1}}
 \newenvironment{reviewlistblock}{\list{}{\topsep.5\baselineskip \leftmargin\z@ \itemindent\z@}\item\relax}{\endlist}% 上下アキ0.5
 
+\newcommand{\reviewequationcaption}[1]{\review@commoncaption{}{#1}}
+\newenvironment{reviewequationblock}{}{}
+
 \newcommand{\reviewimageref}[2]{\review@intn@image #1}
 \newcommand{\reviewtableref}[2]{\review@intn@table #1}
 \newcommand{\reviewlistref}[1]{\review@intn@list #1}
+\newcommand{\reviewequationref}[1]{\review@intn@equation #1}
 \newcommand{\reviewbibref}[2]{#1}
 \newcommand{\reviewcolumnref}[2]{\review@intn@columnname #1}
 \newcommand{\reviewsecref}[2]{#1}

data/templates/latex/review-jlreq/review-jlreq.cls

@@ -37,7 +37,7 @@ cls]
 \PassOptionsToPackage{nosetpagesize}{graphicx}%%for TL16 or higher version
 }{}
 
-\RequirePackage{xkeyval}
+\RequirePackage{xkeyval,everypage}
 
 %% useful helpers
 \newcommand\recls@get@p@[2]{%
@@ -57,6 +57,52 @@ cls]
       \ClassError{recls}{The option #1 should have no value}{\@ehc}}%
     #2}}
 
+%% \recls@set@hiddenfolio{<preset>}
+%% <preset>: default, marusho-ink (丸正インキ), nikko-pc (日光企画),
+%%    shippo (ねこのしっぽ)
+\def\recls@set@hiddenfolio#1{\ifx#1\@empty\else
+  \@ifundefined{@makehiddenfolio@#1}{%
+    \recls@error{Not define such hiddenfolio: #1}}\relax
+  %% set hiddenfolio preset
+  \expandafter\let\expandafter\@makehiddenfolio\csname @makehiddenfolio@#1\endcsname
+  %% redefine to output \@makehiddenfolio for every page
+  \@bannertoken{\hskip-5mm\smash{\hiddenfolio@font\@makehiddenfolio}}%
+  \AddEverypageHook{\maketombowbox}%
+\fi}
+
+\def\hiddenfolio@font{\reset@font
+  \scriptsize\sffamily\baselineskip.8\baselineskip}
+
+%% hiddenfolio=default
+\@namedef{@makehiddenfolio@default}{%
+  \ifodd\c@page
+    \llap{\thepage\hspace{\dimexpr\recls@tombobleed}}%
+  \else
+    \rlap{\hspace{\dimexpr\paperwidth+\recls@tombobleed}\thepage}%
+  \fi}
+
+%% hiddenfolio=marusho-ink
+\@namedef{@makehiddenfolio@marusho-ink}{%
+  \gdef\recls@tombobleed{5mm}%
+  \@nameuse{@makehiddenfolio@nikko-pc}}
+
+%% hiddenfolio=nikko-pc
+\@namedef{@makehiddenfolio@nikko-pc}{%
+  \def\recls@hiddfolio{%
+    \edef\recls@tmp{\thepage}%
+    \lower\dimexpr4pt+\recls@tombobleed+.5\paperheight+5\p@\hbox{%
+      \vbox{\expandafter\@tfor\expandafter\recls@x\expandafter:\expandafter=\recls@tmp\do{%
+        \hbox to 1zw{\hss\recls@x\hss}}}}}%
+  \ifodd\c@page
+    \rlap{\recls@hiddfolio}%
+  \else
+    \llap{\recls@hiddfolio\hspace{-\paperwidth}}%
+  \fi}
+
+%% hiddenfolio=shippo
+\@namedef{@makehiddenfolio@shippo}{%
+  \@nameuse{@makehiddenfolio@nikko-pc}}
+
 %% cameraready=print,ebook,preview
 \newif\if@cameraready \@camerareadyfalse
 \newif\if@pdfhyperlink \@pdfhyperlinkfalse
@@ -70,10 +116,13 @@ cls]
 \DeclareOptionX{startpage}[1]{\gdef\recls@startpage{\numexpr #1-1\relax}}
 \DeclareOptionX{serial_pagination}[false]{\csname recls@serialpage#1\endcsname}
 
+%% 隠しノンブルプリセット
+\DeclareOptionX{hiddenfolio}{\gdef\recls@hiddenfolio{#1}}%%default: (none)
+
 % jlreqのオプションについては https://github.com/abenori/jlreq/blob/master/README-ja.md を参照
 \PassOptionsToClass{book,paper=a5}{jlreq}% クラスで必ず使うオプションの指定。デフォルトをA5にしておく
 \DeclareOptionX*{\PassOptionsToClass{\CurrentOption}{jlreq}}%
-\ExecuteOptionsX{cameraready,tombopaper,bleed_margin,cover,startpage,serial_pagination}
+\ExecuteOptionsX{cameraready,tombopaper,bleed_margin,cover,startpage,serial_pagination,hiddenfolio}
 \ProcessOptionsX\relax
 
 \def\recls@tmp{preview}\ifx\recls@cameraready\recls@tmp
@@ -99,6 +148,11 @@ cls]
 % トンボ設定
 \if@pdftombo
   \RequirePackage[trimmarks_paper=\recls@tombopaper,bleed_margin=\recls@tombobleed]{jlreq-trimmarks}
+  % https://github.com/abenori/jlreq/blob/master/jlreq-trimmarks-ja.md を参照
+  \jlreqtrimmarkssetup{banner={}}
+  % 隠しノンブル
+  \AtEndOfClass{%
+    \recls@set@hiddenfolio{\recls@hiddenfolio}}
 \fi
 
 % エンジンとドライバの情報。jlreq-trimmarksが定義されていればそっちから持ってくる。

data/templates/latex/review-jlreq/review-style.sty

@@ -33,9 +33,3 @@
 % 図表フロートの配置
 \floatplacement{figure}{H}
 \floatplacement{table}{H}
-
-% トンボ情報
-\if@pdftombo
-% https://github.com/abenori/jlreq/blob/master/jlreq-trimmarks-ja.md を参照
-\jlreqtrimmarkssetup{banner={}}
-\fi

data/templates/latex/review-jsbook/review-base.sty

@@ -110,6 +110,10 @@
     \end{alltt}\end{center}
   \end{figure}}
 
+\newcommand{\reviewequationcaption}[1]{%
+  \medskip{\small\noindent #1}}
+\newenvironment{reviewequationblock}{}{}
+
 \newenvironment{reviewlistblock}{}{}
 
 \newenvironment{reviewemlist}{%
@@ -181,6 +185,7 @@
 \newcommand{\reviewimageref}[2]{\review@intn@image #1}
 \newcommand{\reviewtableref}[2]{\review@intn@table #1}
 \newcommand{\reviewlistref}[1]{\review@intn@list #1}
+\newcommand{\reviewequationref}[1]{\review@intn@equation #1}
 \newcommand{\reviewbibref}[2]{#1}
 \newcommand{\reviewcolumnref}[2]{\review@intn@columnname #1}
 \newcommand{\reviewsecref}[2]{#1}

data/test/assets/test_template.tex

@@ -1,6 +1,6 @@
 \documentclass[dvipdfmx]{review-jsbook}
 \makeatletter
-\def\review@reviewversion{3.0.0.preview2}
+\def\review@reviewversion{3.0.0.preview3}
 \def\review@texcompiler{uplatex}
 \def\review@documentclass{review-jsbook}
 
@@ -19,6 +19,7 @@
 \def\review@intn@columnhead{■コラム}
 \def\review@intn@image{図}
 \def\review@intn@table{表}
+\def\review@intn@equation{式}
 \def\review@intn@columnname{コラム}
 \def\review@intn@memohead{■メモ}
 \def\review@intn@edition{版}

data/test/assets/test_template_backmatter.tex

@@ -1,6 +1,6 @@
 \documentclass[dvipdfmx]{review-jsbook}
 \makeatletter
-\def\review@reviewversion{3.0.0.preview2}
+\def\review@reviewversion{3.0.0.preview3}
 \def\review@texcompiler{uplatex}
 \def\review@documentclass{review-jsbook}
 
@@ -19,6 +19,7 @@
 \def\review@intn@columnhead{■コラム}
 \def\review@intn@image{図}
 \def\review@intn@table{表}
+\def\review@intn@equation{式}
 \def\review@intn@columnname{コラム}
 \def\review@intn@memohead{■メモ}
 \def\review@intn@edition{版}

data/test/test_htmlbuilder.rb

@@ -1080,7 +1080,7 @@ EOS
       FileUtils.mkdir_p(File.join(dir, 'images'))
       expected = <<-EOB
 <div class=\"equation\">
-<img src=\"images/_review_math/_gen_XXX.png\" class=\"math_gen_255609d0624d30ecd7b33bfbf069fa39965e221476aeb507f48766d9f216b9eb\" alt="p \\land \\bm{P} q" />
+<img src=\"images/_review_math/_gen_XXX.png\" class=\"math_gen_84291054a12d278ea05694c20fbbc8e974ec66fc13be801c01dca764faeecccb\" alt="p \\land \\bm{P} q" />
 </div>
       EOB
       tmpio = $stderr
@@ -1778,4 +1778,42 @@ EOB
       assert_equal ':1: error: key not found: "n"', e.message
     end
   end
+
+  def test_texequation_plain
+    src = <<-EOS
+//texequation{
+e=mc^2
+//}
+EOS
+    expected = <<-EOS
+<div class="equation">
+<pre>e=mc^2
+</pre>
+</div>
+EOS
+    actual = compile_block(src)
+    assert_equal expected, actual
+  end
+
+  def test_texequation_with_caption
+    src = <<-EOS
+@<eq>{emc2}
+
+//texequation[emc2][The Equivalence of Mass @<i>{and} Energy]{
+e=mc^2
+//}
+EOS
+    expected = <<-EOS
+<p><span class="eqref">式1.1</span></p>
+<div id="emc2" class="caption-equation">
+<p class="caption">式1.1: The Equivalence of Mass <i>and</i> Energy</p>
+<div class="equation">
+<pre>e=mc^2
+</pre>
+</div>
+</div>
+EOS
+    actual = compile_block(src)
+    assert_equal expected, actual
+  end
 end

data/test/test_idgxmlbuilder.rb

@@ -735,4 +735,28 @@ EOS
     actual = compile_inline('test @<comment>{コメント} test2')
     assert_equal 'test <msg>コメント</msg> test2', actual
   end
+
+  def test_texequation
+    src = <<-EOS
+//texequation{
+e=mc^2
+//}
+EOS
+    expected = %Q(<replace idref="texblock-1"><pre>e=mc^2</pre></replace>)
+    actual = compile_block(src)
+    assert_equal expected, actual
+  end
+
+  def test_texequation_with_caption
+    src = <<-EOS
+@<eq>{emc2}
+
+//texequation[emc2][The Equivalence of Mass @<i>{and} Energy]{
+e=mc^2
+//}
+EOS
+    expected = %Q(<p><span type='eq'>式1.1</span></p><equationblock><caption>式1.1　The Equivalence of Mass <i>and</i> Energy</caption><replace idref="texblock-1"><pre>e=mc^2</pre></replace></equationblock>)
+    actual = compile_block(src)
+    assert_equal expected, actual
+  end
 end

data/test/test_latexbuilder.rb

@@ -1116,6 +1116,45 @@ EOS
 \\caption{FOO}
 \\label{image:chap1:sampleimg}
 \\end{reviewimage}
+EOS
+    actual = compile_block(src)
+    assert_equal expected, actual
+  end
+
+  def test_texequation
+    src = <<-EOS
+//texequation{
+e=mc^2
+//}
+EOS
+    expected = <<-EOS
+
+\\begin{equation*}
+e=mc^2
+\\end{equation*}
+EOS
+    actual = compile_block(src)
+    assert_equal expected, actual
+  end
+
+  def test_texequation_with_caption
+    src = <<-EOS
+@<eq>{emc2}
+
+//texequation[emc2][The Equivalence of Mass @<i>{and} Energy]{
+e=mc^2
+//}
+EOS
+    expected = <<-EOS
+
+\\reviewequationref{1.1}
+
+\\begin{reviewequationblock}
+\\reviewequationcaption{式1.1: The Equivalence of Mass \\reviewit{and} Energy}
+\\begin{equation*}
+e=mc^2
+\\end{equation*}
+\\end{reviewequationblock}
 EOS
     actual = compile_block(src)
     assert_equal expected, actual