review 1.0.0 → 1.1.0

data/bin/review-preproc

@@ -24,8 +24,10 @@ require 'fileutils'
 require 'optparse'
 
 def sigmain
-  Signal.trap(:PIPE, 'IGNORE')
   Signal.trap(:INT) { exit 1 }
+  if RUBY_PLATFORM !~ /mswin(?!ce)|mingw|cygwin|bccwin/
+    Signal.trap(:PIPE, 'IGNORE')
+  end
   main
 rescue Errno::EPIPE
   exit 0
@@ -65,6 +67,7 @@ SJIS)') {|enc|
   parser.on('--final', 'Unfold text and strip preprocessor tags. (deprecated)') {
     mode = :final
   }
+  parser.on('--tabwidth=WIDTH', "Replace tabs with space characters. (0: don't replace)") {|width| param["tabwidth"] = width.to_i }
   parser.on('--help', 'Print this message and quit.') {
     puts parser.help
     exit 0
@@ -77,7 +80,7 @@ SJIS)') {|enc|
     exit 1
   end
 
-  pp = ReVIEW::Preprocessor.new(ReVIEW::Repository.new, param)
+  pp = ReVIEW::Preprocessor.new(ReVIEW::Repository.new(param), param)
   current_file = nil
   ARGV.each do |path|
     current_file = path

data/bin/review-vol

@@ -15,10 +15,10 @@ require 'pathname'
 bindir = Pathname.new(__FILE__).realpath.dirname
 $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
-require 'review/book'
-require 'review/exception'
+require 'review'
 require 'optparse'
-require 'nkf'
+
+include ReVIEW::TextUtils
 
 def main
   $KCODE = 'UTF-8' unless defined?(Encoding)
@@ -85,14 +85,7 @@ end
 
 def print_chapter_volume(chap)
   vol = chap.volume
-  title = chap.title
-  if @param["outencoding"] =~ /^EUC$/i
-    title = NKF.nkf("-W -e", title)
-  elsif @param["outencoding"] =~ /^SJIS$/i
-    title = NKF.nkf("-W -s", title)
-  elsif @param["outencoding"] =~ /^JIS$/i
-    title = NKF.nkf("-W -j", title)
-  end
+  title = convert_outencoding(chap.title, @param["outencoding"])
   printf "%s %3dKB %6dC %5dL %3dP %s %-s\n",
          chapnumstr(chap.number), vol.kbytes, vol.chars, vol.lines, vol.page,
          "#{chap.name} ".ljust(25, '.'), title

data/debian/changelog

@@ -1,5 +1,5 @@
-review (0.6+20101123) unstable; urgency=low
+review (1.0+20120212) unstable; urgency=low
 
-  * Initial Release. (closes: #)
+  * Initial Release. (closes: #XXXX)
 
- -- Kenshi Muto <kmuto@debian.org>  Tue, 23 Nov 2010 17:35:59 +0900
+ -- Kenshi Muto <kmuto@debian.org>  Sun, 12 Feb 2012 15:38:55 +0900

data/debian/copyright

@@ -8,12 +8,14 @@ It was downloaded from:
 
 Upstream Author(s):
 
-    Minero Aoki <aamine@loveruby.net>, Kenshi Muto <kmuto@debian.org>,
-    and Masayoshi Takahashi <takahashimm@gmail.com>.
+    Minero Aoki, Kenshi Muto,
+    Masayoshi Takahashi, and
+    Masanori KADO <kdmsnr@gmail.com>.
 
 Copyright:
 
-    Copyright (C) 2006-2010 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
+    Copyright (C) 2006-2012 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+    Masanori KADO.
 
     For lib/uuid.rb:
     Copyright(c) 2005 URABE, Shyouhei

data/debian/docs

@@ -1,5 +1,6 @@
 README.rdoc
 ChangeLog
 doc/format.rdoc
+doc/quickstart.rdoc
 doc/sample.css
 doc/sample.yaml

data/doc/format.rdoc

@@ -259,9 +259,7 @@ RD や各種 Wiki の文法をとりいれて簡素化しています。
 表は //table[識別子][キャプション]{ 〜 //} です。ヘッダと内容を
 分ける罫線は「------」で書き込んであります。
 
-カラム間は任意個数のタブで区切ります。また、カラム先頭の「.」は削
-除されるので、カラムの先頭文字が「.」の場合は「.」をもう一つ余計に
-付けてください。例えば「.」という内容のカラムは「..」と書きます。
+カラム間は任意個数のタブで区切ります。また、カラム先頭の「.」は削除されるので、カラムの先頭文字が「.」の場合は「.」をもう一つ余計に付けてください。例えば「.」という内容のカラムは「..」と書きます。
 また、空のカラムは「.」と書けます。
 
 例:
@@ -311,12 +309,22 @@ RD や各種 Wiki の文法をとりいれて簡素化しています。
 本文中の「@<fn>{site}」は脚注番号に置換され、「本書のサポート
 サイト……」という文は実際の脚注に変換されます。
 
+注意: PDFで、コラムや表など平文でないところで「@<fn>{～}」を使うには、footnotetextオプションを使う必要があります。
+
+=== footnotetextオプション
+
+footnotetextオプションを使うには、YAMLファイルのparamsに「--footnotetext」を追加します。
+
+これでPDFのコラムや表のなかでも脚注が使えるようになります。
+
+ただし、通常の脚注(footnote)ではなく、footnotemarkとfootnotetextを使うため、本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。
+
 == 参考文献の定義
 
 参考文献は同一ディレクトリ内の bib.re に定義します。
-//bibpaper[site][キャプション]{..コメント..}
+//bibpaper[cite][キャプション]{..コメント..}
 コメントが無い場合も定義可能です。
-//bibpaper[site][キャプション]
+//bibpaper[cite][キャプション]
 
 例:
 
@@ -359,14 +367,12 @@ LaTeX の式を挿入するには、//texequation{ 〜 //} を使います。
 
 出力される空白を制御するタグとしては、//noindentがあります。
 
-//noindent:: その直後に来る段落冒頭のインデントをなくする(HTMLではnoindentクラスになる)
+//noindent:: その直後に来る段落冒頭のインデントをなくす(HTMLではnoindentクラスになる)
 
 以前あった「//linebreak」(改行)、「//pagebreak」(改ページ)は廃止になります。
 
 == コメント
 
-以前は「//comment」というタグがありましたが、廃止されます。
-
 最終結果に出力されないコメントを記述したい場合は「#@#」を使ってください。
 
 例:
@@ -379,6 +385,12 @@ LaTeX の式を挿入するには、//texequation{ 〜 //} を使います。
 
   #@warn(あとで書く)
 
+最終結果に出力するコメントを記述したい場合は、//commentまたは@<comment>を使った上で、review-compileコマンドに--draftオプションを追加してください。
+
+例:
+
+  @<comment>{あとで書く}
+
 == 生データ行
 
 ReVIEW のタグ範囲を越えて何か特別な行を挿入したい場合、//raw を使います。
@@ -413,7 +425,31 @@ ReVIEW は任意のブロックを追加可能なので、本によって専用
 //prototype:: 関数プロトタイプ。『ふつうのLinuxプログラミング』で使用。
 //type:: 関数の型宣言。『ふつうのHaskellプログラミング』で使用。
 
-拡張文法はreview-ext.rbというファイルで指定できますが、ここでは詳しく触れません。
+拡張文法はreview-ext.rbというファイルで指定できます。
+例えば、
+
+    # review-ext.rb
+    ReVIEW::Compiler.defblock :foo, 0..1
+ 
+    class ReVIEW::HTMLBuilder
+      def foo(lines, caption = nil)
+        puts lines.join(",")
+      end
+    end
+
+のようにすると、以下のような文法を追加できます。
+
+    //foo{
+    A
+    B
+    C
+    //}
+    
+    # 出力結果
+    A,B,C
+
+詳しいことについては、ここでは触れません。
+
 
 == 段落中で使う文法 (インライン命令)
 
@@ -428,12 +464,14 @@ ReVIEW は任意のブロックを追加可能なので、本によって専用
 @<bou>{ふさわしい}:: 傍点。
 @<ruby>{直截, ちょくせつ}:: ルビ。
 @<ami>{重点ポイント}:: 文字に対するアミかけ。
-@<b>{どうしても}:: 太字。
-@<em>{どうしても}:: 太字(強調)。
+@<b>{どうしても}:: 太字 (ボールド)。
 @<i>{どうしても}:: イタリック。
+@<strong>{どうしても}:: 強調。
+@<em>{どうしても}:: 強調。
 @<tt>{foo($bar)}:: テキストをテレタイプ文字(等幅フォント)で出力する。
 @<tti>{FooClass}:: テキストをテレタイプ文字(等幅フォント)のイタリックで出力する。
 @<ttb>{BarClass}:: テキストをテレタイプ文字(等幅フォント)の太字で出力する。
+@<u>{下線}:: 下線。
 @<br>{}::  段落中改行。
 @<m>{a + \alpha}:: TeXインライン式。
 @<icon>{samplephoto}:: インライン画像。
@@ -505,6 +543,14 @@ PART:
 
   @<hd>{preface|はじめに|まずわ}
 
+参照先にラベルが設定されている場合は、ラベルで参照します。
+
+  =={hajimeni} はじめに
+  :
+  === まずわ
+  :
+  @<hd>{hajimeni|まずわ}
+
 == リンク
 
 Web ハイパーリンクを記述するには、リンクに @<href>、アンカーに //label

data/doc/quickstart.rdoc

@@ -140,7 +140,7 @@ sample.re を HTML に変換すると、次のようになります。
   </body>
   </html>
 
-ReVIEW フォーマットについての詳細は、format.rdoc (オンラインでは [[https://github.com/kmuto/review/blob/master/doc/format.rdoc]] ) を参照してください。
+ReVIEW フォーマットについての詳細は、 {format.rdoc}[https://github.com/kmuto/review/blob/master/doc/format.rdoc] を参照してください。
 
 review-compile を含め、ほとんどのコマンドは --help オプションを付けるとオプションについてのヘルプが表示されます。review-compile には多数のオプションがあるので確認してください。
 
@@ -172,9 +172,9 @@ review-compile を含め、ほとんどのコマンドは --help オプション
 
 review-pdfmaker コマンドで PDF ブックの作成、review-epubmaker コマンドで EPUB ファイルの作成ができます。
 
-PDF を作成するには、pTeXLive2009 以上の環境が必要です。EPUB を作成するには、zip コマンドが必要です (MathML も使いたいときには、[[http://www.hinet.mydns.jp/?mathml.rb]] の MathML ライブラリも必要です)。
+PDF を作成するには、pTeXLive2009 以上の環境が必要です。EPUB を作成するには、zip コマンドが必要です (MathML も使いたいときには、 {MathML ライブラリ}[http://www.hinet.mydns.jp/?mathml.rb]も必要です)。
 
-いずれのコマンドも、必要な設定情報を記した YAML ファイルを引数に指定して実行します。YAML ファイルのサンプルは、sample.yaml (オンラインでは[[https://github.com/kmuto/review/blob/master/doc/sample.yaml]]) としてこのドキュメントと同じディレクトリに収録しています。
+いずれのコマンドも、必要な設定情報を記した YAML ファイルを引数に指定して実行します。YAML ファイルのサンプルは、 {sample.yaml}[https://github.com/kmuto/review/blob/master/doc/sample.yaml] としてこのドキュメントと同じディレクトリに収録しています。
 
   review-pdfmaker YAMLファイル  ←PDFの作成
   review-epubmaker YAMLファイル ←EPUBの作成
@@ -184,5 +184,5 @@ PDF を作成するには、pTeXLive2009 以上の環境が必要です。EPUB
 ReVIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2010年12月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
 
 バグ・パッチの報告、開発者用メーリングリストなどについての情報は、
-[[https://github.com/kmuto/review/wiki]]
+https://github.com/kmuto/review/wiki
 を参照してください。

data/doc/sample.yaml

@@ -5,7 +5,7 @@
 # このファイルはUTF-8エンコーディングで記述してください。
 
 # ブック名(ファイル名になるもの。ASCII範囲の文字を使用)
-bookname: sample
+bookname: review-sample
 # 書名
 booktitle: ReVIEW EPUBサンプル
 # 著者
@@ -44,15 +44,19 @@ secnolevel: 2
 epubversion: 2
 # HTMLのバージョン(現時点では4または5。デフォルトは4。epubversionを3にした場合は自動で5に設定される)
 htmlversion: 4
+# 表紙を出力するか
+titlepage: true
+# 目次を出力するか
+toc: true
 # EPUB標準の目次以外に目次を作成するか
-# mytoc: nil
+mytoc: null
 # 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
-# colophon: true
+colophon: null
 # XHTML生成後に実行するプログラム。$1:HTMLの生成されたディレクトリ $2:ReVIEWファイルのあるディレクトリ $3:起動時指定のyamlファイル名
 # posthook: hook.sh
-# EPUBで表紙をコンテンツに含めるか。デフォルト(no)では作成されない。yesにするとiBooks等でも最初に表紙が表示されるようになる
-# cover_linear: yes
+# EPUBで表紙をコンテンツに含めるか。デフォルトでは作成されない。yesにするとiBooks等でも最初に表紙が表示されるようになる
+cover_linear: null
 # review-compileに渡すパラメータ
 params: --stylesheet=sample.css
-# デバッグフラグ。nilでないときには一時ファイルをカレントディレクトリに作成し、削除もしない
-# debug: nil
+# デバッグフラグ。nullでないときには一時ファイルをカレントディレクトリに作成し、削除もしない
+debug: null

data/lib/epubmaker.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # = epubmaker.rb -- EPUB production set.
 #
-# Copyright (c) 2010 Kenshi Muto
+# Copyright (c) 2010-2012 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of

data/lib/epubmaker/epubv2.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # = epubv2.rb -- EPUB version 2 producer.
 #
-# Copyright (c) 2010 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2012 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -10,6 +10,7 @@
 #
 
 require 'epubmaker/producer'
+require 'cgi'
 
 module EPUBMaker
   
@@ -22,9 +23,7 @@ module EPUBMaker
     
     # Return mimetype content.
     def mimetype
-      return <<EOT
-application/epub+zip
-EOT
+      return "application/epub+zip"
     end
     
     # Return opf file content.
@@ -37,9 +36,9 @@ EOT
       %w[title language date type format source description relation coverage subject rights].each do |item|
         next if @producer.params[item].nil?
         if @producer.params[item].instance_of?(Array)
-          s << @producer.params[item].map {|i| %Q[    <dc:#{item}>#{i}</dc:#{item}>\n]}.join
+          s << @producer.params[item].map {|i| %Q[    <dc:#{item}>#{CGI.escapeHTML(i.to_s)}</dc:#{item}>\n]}.join
         else
-          s << %Q[    <dc:#{item}>#{@producer.params[item]}</dc:#{item}>\n]
+          s << %Q[    <dc:#{item}>#{CGI.escapeHTML(@producer.params[item].to_s)}</dc:#{item}>\n]
         end
       end
       
@@ -54,14 +53,14 @@ EOT
       %w[aut a-adp a-ann a-arr a-art a-asn a-aqt a-aft a-aui a-ant a-bkp a-clb a-cmm a-dsr a-edt a-ill a-lyr a-mdc a-mus a-nrt a-oth a-pht a-prt a-red a-rev a-spn a-ths a-trc a-trl].each do |role|
         next if @producer.params[role].nil?
         @producer.params[role].each do |v|
-          s << %Q[    <dc:creator opf:role="#{role.sub('a-', '')}">#{v}</dc:creator>\n]
+          s << %Q[    <dc:creator opf:role="#{role.sub('a-', '')}">#{CGI.escapeHTML(v)}</dc:creator>\n]
         end
       end
       # contributor
       %w[adp ann arr art asn aqt aft aui ant bkp clb cmm dsr edt ill lyr mdc mus nrt oth pht prt red rev spn ths trc trl].each do |role|
         next if @producer.params[role].nil?
         @producer.params[role].each do |v|
-          s << %Q[    <dc:contributor opf:role="#{role}">#{v}</dc:contributor>\n]
+          s << %Q[    <dc:contributor opf:role="#{role}">#{CGI.escapeHTML(v)}</dc:contributor>\n]
           if role == "prt"
             s << %Q[    <dc:publisher>#{v}</dc:publisher>\n]
           end
@@ -135,15 +134,15 @@ EOT
       s << <<EOT
   </head>
   <docTitle>
-    <text>#{@producer.params["title"]}</text>
+    <text>#{CGI.escapeHTML(@producer.params["title"])}</text>
   </docTitle>
   <docAuthor>
-    <text>#{@producer.params["aut"].nil? ? "" : @producer.params["aut"].join(", ")}</text>
+    <text>#{@producer.params["aut"].nil? ? "" : CGI.escapeHTML(@producer.params["aut"].join(", "))}</text>
   </docAuthor>
   <navMap>
     <navPoint id="top" playOrder="1">
       <navLabel>
-        <text>#{@producer.params["title"]}</text>
+        <text>#{CGI.escapeHTML(@producer.params["title"])}</text>
       </navLabel>
       <content src="#{@producer.params["cover"]}"/>
     </navPoint>
@@ -203,13 +202,13 @@ EOT
     def cover
       s = common_header
       s << <<EOT
-  <title>#{@producer.params["title"]}</title>
+  <title>#{CGI.escapeHTML(@producer.params["title"])}</title>
 </head>
 <body>
 EOT
       if @producer.params["coverimage"].nil?
         s << <<EOT
-<h1 class="cover-title">#{@producer.params["title"]}</h1>
+<h1 class="cover-title">#{CGI.escapeHTML(@producer.params["title"])}</h1>
 EOT
       else
         file = nil
@@ -222,7 +221,7 @@ EOT
         raise "coverimage #{@producer.params["coverimage"]} not found. Abort." if file.nil?
         s << <<EOT
   <div id="cover-image" class="cover-image">
-    <img src="#{file}" alt="#{@producer.params["title"]}" class="max"/>
+    <img src="#{file}" alt="#{CGI.escapeHTML(@producer.params["title"])}" class="max"/>
   </div>
 EOT
    end
@@ -238,10 +237,10 @@ EOT
     def titlepage
       s = common_header
       s << <<EOT
-  <title>#{@producer.params["title"]}</title>
+  <title>#{CGI.escapeHTML(@producer.params["title"])}</title>
 </head>
 <body>
-  <h1 class="tp-title">#{@producer.params["title"]}</h1>
+  <h1 class="tp-title">#{CGI.escapeHTML(@producer.params["title"])}</h1>
 EOT
 
       if @producer.params["aut"]
@@ -250,7 +249,7 @@ EOT
     <br />
     <br />
   </p>
-  <h2 class="tp-author">#{@producer.params["aut"]}</h2>
+  <h2 class="tp-author">#{CGI.escapeHTML(@producer.params["aut"])}</h2>
 EOT
       end
 
@@ -262,7 +261,7 @@ EOT
     <br />
     <br />
   </p>
-  <h3 class="tp-publisher">#{@producer.params["prt"]}</h3>
+  <h3 class="tp-publisher">#{CGI.escapeHTML(@producer.params["prt"])}</h3>
 EOT
       end
 
@@ -281,7 +280,7 @@ EOT
 </head>
 <body>
   <div class="colophon">
-    <p class="title">#{@producer.params["title"]}</p>
+    <p class="title">#{CGI.escapeHTML(@producer.params["title"])}</p>
 EOT
 
       if @producer.params["pubhistory"]
@@ -289,11 +288,11 @@ EOT
       end
       
       s << %Q[    <table class="colophon">\n]
-      s << %Q[      <tr><th>#{@producer.res.v("c-aut")}</th><td>#{@producer.params["aut"]}</td></tr>\n] if @producer.params["aut"]
-      s << %Q[      <tr><th>#{@producer.res.v("c-dsr")}</th><td>#{@producer.params["dsr"]}</td></tr>\n] if @producer.params["dsr"]
-      s << %Q[      <tr><th>#{@producer.res.v("c-ill")}</th><td>#{@producer.params["ill"]}</td></tr>\n] if @producer.params["ill"]
-      s << %Q[      <tr><th>#{@producer.res.v("c-edt")}</th><td>#{@producer.params["edt"]}</td></tr>\n] if @producer.params["edt"]
-      s << %Q[      <tr><th>#{@producer.res.v("c-prt")}</th><td>#{@producer.params["prt"]}</td></tr>\n] if @producer.params["prt"]
+      s << %Q[      <tr><th>#{@producer.res.v("c-aut")}</th><td>#{CGI.escapeHTML(@producer.params["aut"])}</td></tr>\n] if @producer.params["aut"]
+      s << %Q[      <tr><th>#{@producer.res.v("c-dsr")}</th><td>#{CGI.escapeHTML(@producer.params["dsr"])}</td></tr>\n] if @producer.params["dsr"]
+      s << %Q[      <tr><th>#{@producer.res.v("c-ill")}</th><td>#{CGI.escapeHTML(@producer.params["ill"])}</td></tr>\n] if @producer.params["ill"]
+      s << %Q[      <tr><th>#{@producer.res.v("c-edt")}</th><td>#{CGI.escapeHTML(@producer.params["edt"])}</td></tr>\n] if @producer.params["edt"]
+      s << %Q[      <tr><th>#{@producer.res.v("c-prt")}</th><td>#{CGI.escapeHTML(@producer.params["prt"])}</td></tr>\n] if @producer.params["prt"]
       s << <<EOT
     </table>
   </div>
@@ -380,16 +379,16 @@ EOT
         FileUtils.mkdir_p(File.dirname("#{tmpdir}/OEBPS/#{item.file}")) unless File.exist?(File.dirname("#{tmpdir}/OEBPS/#{item.file}"))
         FileUtils.cp(fname, "#{tmpdir}/OEBPS/#{item.file}")
       end
-      
+
       fork {
         Dir.chdir(tmpdir) {|d|
-          exec("zip -0X #{epubfile} mimetype")
+          exec("zip", "-0X", "#{epubfile}", "mimetype")
         }
       }
       Process.waitall
       fork {
         Dir.chdir(tmpdir) {|d|
-          exec("zip -Xr9D #{epubfile} META-INF OEBPS")
+          exec("zip", "-Xr9D", "#{epubfile}", "META-INF", "OEBPS")
         }
       }
       Process.waitall