review 2.3.0 → 2.4.0

data/test/assets/large.svg

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   xmlns:dc="http://purl.org/dc/elements/1.1/"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   width="250"
+   height="150"
+   viewBox="0 0 66.145832 39.687501"
+   version="1.1"
+   id="svg8"
+   inkscape:version="0.92.1 r15371"
+   sodipodi:docname="large.svg">
+  <defs
+     id="defs2" />
+  <sodipodi:namedview
+     id="base"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageopacity="0.0"
+     inkscape:pageshadow="2"
+     inkscape:zoom="0.35"
+     inkscape:cx="411.42857"
+     inkscape:cy="545.71429"
+     inkscape:document-units="mm"
+     inkscape:current-layer="layer1"
+     showgrid="false"
+     units="px"
+     inkscape:window-width="1920"
+     inkscape:window-height="1103"
+     inkscape:window-x="0"
+     inkscape:window-y="27"
+     inkscape:window-maximized="1" />
+  <metadata
+     id="metadata5">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:format>image/svg+xml</dc:format>
+        <dc:type
+           rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
+        <dc:title></dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <g
+     inkscape:label="レイヤー 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(0,-257.31247)">
+    <rect
+       id="rect10"
+       width="66.145836"
+       height="39.6875"
+       x="0"
+       y="258.44641"
+       style="stroke-width:0.26458332" />
+  </g>
+</svg>

data/test/assets/test_template.tex

@@ -7,7 +7,7 @@
 \usepackage{caption}
 \usepackage{suffix}
 \usepackage[T1]{fontenc}\usepackage{textcomp}%T1/TS1
-% \usepackage{lmodern}
+\usepackage{lmodern}
 \usepackage[dvipdfmx]{graphicx}
 \usepackage[dvipdfmx,table]{xcolor}%requires colortbl, array
 \usepackage{framed}

data/test/book_test_helper.rb

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

data/test/run_test.rb

@@ -1,10 +1,10 @@
-base_dir = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-lib_dir  = File.join(base_dir, "lib")
-test_dir = File.join(base_dir, "test")
+base_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+lib_dir  = File.join(base_dir, 'lib')
+test_dir = File.join(base_dir, 'test')
 
 $LOAD_PATH.unshift(lib_dir)
 
 require 'test/unit'
 
-argv = ["--max-diff-target-string-size=10000"]
+argv = ['--max-diff-target-string-size=10000']
 exit Test::Unit::AutoRunner.run(true, test_dir, argv)

data/test/sample-book/src/Rakefile

@@ -1,67 +1,66 @@
 require 'fileutils'
 require 'rake/clean'
 
-BOOK = "book"
-BOOK_PDF = BOOK+".pdf"
-BOOK_EPUB = BOOK+".epub"
-CONFIG_FILE = "config.yml"
-WEBROOT = "webroot"
+BOOK = 'book'
+BOOK_PDF = BOOK + '.pdf'
+BOOK_EPUB = BOOK + '.epub'
+CONFIG_FILE = 'config.yml'
+WEBROOT = 'webroot'
 
 def build(mode, chapter)
   sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
-  mode_ext = {"html" => "html", "latex" => "tex",
-              "idgxml" => "xml"}
-  FileUtils.mv "tmp", chapter.gsub(/re\z/, mode_ext[mode])
+  mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml' }
+  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
+task default: :html_all
 
-desc "build html (Usage: rake build re=target.re)"
+desc 'build html (Usage: rake build re=target.re)'
 task :html do
   if ENV['re'].nil?
-    puts "Usage: rake build re=target.re"
+    puts 'Usage: rake build re=target.re'
     exit
   end
-  build("html", ENV['re'])
+  build('html', ENV['re'])
 end
 
-desc "build all html"
+desc 'build all html'
 task :html_all do
-  build_all("html")
+  build_all('html')
 end
 
 desc 'preproc all'
 task :preproc do
-  Dir.glob("*.re").each do |file|
+  Dir.glob('*.re').each do |file|
     sh "review-preproc --replace #{file}"
   end
 end
 
 desc 'generate PDF and EPUB file'
-task :all => [:pdf, :epub]
+task all: %i[pdf epub]
 
 desc 'generate PDF file'
-task :pdf => BOOK_PDF
+task pdf: BOOK_PDF
 
 desc 'generate stagic HTML file for web'
-task :web => WEBROOT
+task web: WEBROOT
 
 desc 'generate EPUB file'
-task :epub => BOOK_EPUB
+task epub: BOOK_EPUB
 
 SRC = FileList['*.re'] + [CONFIG_FILE]
 
 file BOOK_PDF => SRC do
-  FileUtils.rm_rf [BOOK_PDF, BOOK, BOOK+"-pdf"]
+  FileUtils.rm_rf [BOOK_PDF, BOOK, BOOK + '-pdf']
   sh "review-pdfmaker #{CONFIG_FILE}"
 end
 
 file BOOK_EPUB => SRC do
-  FileUtils.rm_rf [BOOK_EPUB, BOOK, BOOK+"-epub"]
+  FileUtils.rm_rf [BOOK_EPUB, BOOK, BOOK + '-epub']
   sh "review-epubmaker #{CONFIG_FILE}"
 end
 
@@ -70,4 +69,4 @@ file WEBROOT => SRC do
   sh "review-webmaker #{CONFIG_FILE}"
 end
 
-CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK+"-pdf", BOOK+"-epub", WEBROOT])
+CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT, 'images/_review_math'])

data/test/syntax-book/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'review', '2.3.0'

data/test/syntax-book/Rakefile

@@ -0,0 +1,72 @@
+require 'fileutils'
+require 'rake/clean'
+
+BOOK = 'syntax-book'
+BOOK_PDF = BOOK + '.pdf'
+BOOK_EPUB = BOOK + '.epub'
+CONFIG_FILE = 'config.yml'
+WEBROOT = 'webroot'
+
+def build(mode, chapter)
+  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
+  mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml' }
+  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 stagic HTML file for web'
+task web: WEBROOT
+
+desc 'generate EPUB file'
+task epub: BOOK_EPUB
+
+SRC = FileList['*.re'] + [CONFIG_FILE]
+
+file BOOK_PDF => SRC do
+  FileUtils.rm_rf [BOOK_PDF, BOOK, BOOK + '-pdf']
+  sh "review-pdfmaker #{CONFIG_FILE}"
+end
+
+file BOOK_EPUB => SRC 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
+
+CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT])

data/test/syntax-book/appA.re

@@ -0,0 +1,22 @@
+= 付録の見出し
+== 付録の節
+
+=== 付録の項
+
+==== 付録の段
+
+@<list>{lista-1}、@<img>{puzzle}、@<table>{taba-1}
+
+#@# リスト、図、表
+//list[lista-1][Hello]{
+os.println("Hello");
+//}
+
+//image[puzzle][パズル]{
+//}
+
+//table[taba-1][付録表、見出し行なし（左1列目を見出しと見なす）]{
+a	1
+b	2
+c	3
+//}

data/test/syntax-book/bib.re

@@ -0,0 +1,6 @@
+= 参考文献
+//bibpaper[lins][Lins, 1991]{
+Refael D. Lins. A shared memory architecture for parallel study of algorithums for cyclic reference_counting. Technical Report 92, Computing Laboratory, The University of Kent at Canterbury , August 1991
+//}
+#@# 参考文献の見た目に決まったものはないが…今のTeXのはちょっと適当すぎる気はしています。もっと適切なタグで囲んだ形で出したほうがよさそう
+

data/test/syntax-book/catalog.yml

@@ -0,0 +1,15 @@
+PREDEF:
+ - pre01.re
+
+CHAPS:
+ - 部扉見出し:
+   - ch01.re
+ - part2.re:
+   - ch02.re
+   - ch03.re
+
+APPENDIX:
+ - appA.re
+
+POSTDEF:
+ - bib.re

data/test/syntax-book/ch01.re

@@ -0,0 +1,136 @@
+= 章見出し
+//lead{
+章にはリードが入ることがあります。図版や表が入ることはまずありませんが、@<b>{太字}くらいは使われることも。
+
+複数段落になる可能性もあります。
+//}
+#@# 章見出しやリードの見た目については紙面次第ですが……。商業誌だとリードはゴチにしていることが多い？
+#@# 部扉なしの場合は章扉あり、部扉ありの場合は章扉はあったりなかったり、という感じだが、一概には言えないし、デザインが絡むので厄介そう。部扉の背景に指定図版を貼り付けることがクラスファイル側でできるといいのかな
+#@# 第X章 という書き方は、HTMLではi18n.yml/locale.ymlでカスタマイズ可能にしている
+
+段落は普通に書き連ねていくだけです。段落間は空行を含めます。
+
+こんなかんじ
+
+です。空けない場合は、1つの
+段落として結合されます。TeXと違って文字種によって良い塩梅にスペースを入れてくれたりはしないので、特に英文の場合は注意が必要です。this is a
+pen.と「apen」になってしまいます。行頭行末のスペース文字も詰められてしまうので、
+this is a pen.は途中改行せずに記述しなければなりません。
+
+通常段落は「字下げ」することを想定して表現されますが、たとえばコードをまたぐ
+
+//emlist{
+'hello!' 'こんにちはWorld!'
+//}
+#@# コードリスト。紙面表現はアミカケがよいと思います。後出の例のようにキャプションが入ることもあります。また、インラインタグがこのリスト内で使われるので、単純なverbatimではまずいです。
+
+//noindent
+ようにしたい場合は、またいだ後の段落前に「@<tt>{//noindent}」を入れておくことで字下げを抑止できます（そもそもこういうまたぎ行為は筆者の好みではありませんが）。
+#@# 字下げ抑止と本文中等幅の例
+
+== 節見出し
+@<tt>{=}の数で見出しレベルを表しますが、最大@<tt>{=====}の5レベルまでの見出しがあり得ます（内部的にはレベル6まであるけれども非推奨で、一部のビルダでは動かない）。
+
+ * @<tt>{=}：章および部
+ * @<tt>{==}：節
+ * @<tt>{===}：項
+ * @<tt>{====}：段
+ * @<tt>{=====}：レベル5見出し
+
+「X.X.X」のように採番するか否かは@<tt>{config.yml}の@<tt>{secnolevel}パラメータで変動します@<fn>{f1}。デフォルトは2（X.Xまで）ですが、このリファレンスドキュメントでは一応4（X.X.X.X）まで採番を試みています。
+#@# FIXME:今のTeXレイアウトファイルだと設定によらずX.X.Xまでしか付かない？
+
+//footnote[f1][前述したように@<tt>{PREDEF}、@<tt>{POSTDEF}の場合は採番@<b>{しません}。]
+
+=== 項見出し……に脚注を入れると@<i>{TeX}ではエラー
+@<fn>{f2}という脚注を見出し箇所に入れようとするとTeXではエラーになります。見出しにそういうものを入れるべきではない、といえばそれまでですが。見出しにはインラインでの装飾タグが入る可能性があります。
+
+//footnote[f2][本当は項の脚注]
+
+==== 段見出し
+ここまで採番することがあるケースがあるか、というとたまにあったりします。
+
+===== レベル5見出し
+さすがにこのあたりのレベルは採番はしないですね。紙面では、:によるdescription箇条書きでは大きくなりすぎるような規模の場合にこのレベルの見出しを代用することがあります。
+
+あくまでも見出しなので、見出しの行にそのまま段落が続いてしまう見た目は期待と違います。
+
+== 長い節見出し■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□
+=== 長い項見出し■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□
+==== 長い段見出し■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□
+===== 長いレベル5見出し■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□■□
+
+また、nonumあるいはnotocを付けた見出しは、章であっても採番されません。前者nonumは採番なし・目次に含める、後者notocは採番なし・目次にも含めないという意味です。
+
+===[nonum] 採番しない項見出し
+
+=== 採番する項見出し
+
+nodispを付けると、紙面には表示されず目次には含まれる見出しとなります（採番なし）。節以下のレベルで使うことはほとんどなく、たとえば「献辞」のように紙面には見出しを出したくないけれども目次には入れておきたい前付名などに使うことを想定しています。
+
+===[nodisp] nodispで隠れた見出し
+
+== 箇条書き
+=== ナカグロ箇条書き
+ナカグロ箇条書き（HTMLの@<i>{ul}、TeXの@<i>{itemize}）は@<i>{スペース}+@<tt>{*}+@<i>{スペース}で表現します。インラインタグが含まれることがあります。
+
+ * 箇条書き1
+ * 箇条書き2@<b>{太字bold}@<i>{italicイタ}@<tt>{等幅code}
+
+入れ子ナカグロ箇条書きもあります。
+
+ * 箇条書き1
+ ** 箇条書き1-1
+ ** 箇条書き1-2
+ *** 箇条書き1-2-1
+ * 箇条書き2
+ ** 箇条書き2-1
+
+箇条書きの間に別の要素（ぶらさがりの段落など）が入ることは標準では対応しておらず、どうしてもそういうのが必要な場合は途中でフックして変換後ソースを書き換えることになります。
+
+=== 番号箇条書き
+番号箇条書き（HTMLの@<i>{ol}、TeXの@<i>{enumerate}）は@<i>{スペース}+@<tt>{数字.}+@<i>{スペース}で表現します。
+
+ 1. 箇条書き1
+ 2. 箇条書き2@<b>{太字bold}@<tt>{等幅code}
+
+olnumで一応番号が変更可能なことを期待していますが、Webブラウザだとだめなことが多いかもしれません。
+
+//olnum[10]
+
+ 10. 箇条書き10
+ 11. 箇条書き11
+
+=== 用語リスト
+用語リスト（HTMLの@<i>{dl}、TeXの@<i>{description}）は@<i>{スペース}+@<tt>{:}+@<i>{スペース}で見出しを、説明は行頭にタブかスペースを入れて表現します。
+
+ : Alpha@<b>{bold太字}@<i>{italicイタ}@<tt>{等幅code}
+	@<i>{DEC}の作っていた@<b>{RISC CPU}。@<i>{italicイタ}@<tt>{等幅code}
+	浮動小数点数演算が速い。
+ : POWER
+	IBMとモトローラが共同製作したRISC CPU。@<br>{}
+	派生としてPOWER PCがある。
+ : SPARC
+	Sunが作っているRISC CPU。
+	CPU数を増やすのが得意。
+
+//emlist{
+@<b>{bold太字}@<i>{italicイタ}
+
+ : Alpha@<embed>{@}<b>{bold太字}@<embed>{@}<i>{italicイタ}@<embed>{@}<tt>{等幅code}
+        @<embed>{@}<i>{DEC}の作っていた@<embed>{@}<b>{RISC CPU}。@<embed>{@}<i>{italicイタ}@<embed>{@}<tt>{等幅code}
+        浮動小数点数演算が速い。
+ : POWER
+        IBMとモトローラが共同製作したRISC CPU。@<embed>{@}<br>{}
+        派生としてPOWER PCがある。
+ : SPARC
+        Sunが作っているRISC CPU。
+        CPU数を増やすのが得意。@<balloon>{ふきだし説明}
+//}
+#@# コード内の太字およびイタリック。ttをコード内で使うのは無意味なので省略。
+#@# embedは単純にその中のものを展開するだけなので、紙面的な特殊対応は不要。
+#@# balloonは、本当は引き出し線+右寄せ にできるといいが…
+
+説明文に複数の段落を入れることは構文上できないので、@<tt>{@}@<tt>{<br>{\}}を入れて改行することで代替します。
+
+#@# コラム