review 1.2.0 → 1.3.0

data/bin/review-preproc

@@ -18,6 +18,7 @@ $LOAD_PATH.unshift((bindir + '../lib').realpath)
 
 require 'review/preprocessor'
 require 'review/unfold'
+require 'review/version'
 require 'lineinput'
 require 'stringio'
 require 'fileutils'
@@ -42,41 +43,42 @@ def main
   }
 
   mode = :output
-  parser = OptionParser.new
-  parser.banner = "Usage: #{File.basename($0)} [-c|-d|-s|--replace] [<file>...]"
-  parser.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and
+  opts = OptionParser.new
+  opts.version = ReVIEW::VERSION
+  opts.banner = "Usage: #{File.basename($0)} [-c|-d|-s|--replace] [<file>...]"
+  opts.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and
 SJIS)') {|enc|
     param["inencoding"] = enc
   }
-  parser.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC
+  opts.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC
 , JIS, and SJIS)') {|enc|
     param["outencoding"] = enc
   }
-  parser.on('-c', '--check', 'Check if preprocess is needed.') {
+  opts.on('-c', '--check', 'Check if preprocess is needed.') {
     mode = :check
   }
-  parser.on('-d', '--diff', 'Show diff from current file.') {
+  opts.on('-d', '--diff', 'Show diff from current file.') {
     mode = :diff
   }
-  parser.on('--replace', 'Replace file by preprocessed one.') {
+  opts.on('--replace', 'Replace file by preprocessed one.') {
     mode = :replace
   }
-  parser.on('-s', '--strip', 'Strip preprocessor tags.') {
+  opts.on('-s', '--strip', 'Strip preprocessor tags.') {
     mode = :strip
   }
-  parser.on('--final', 'Unfold text and strip preprocessor tags. (deprecated)') {
+  opts.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
+  opts.on('--tabwidth=WIDTH', "Replace tabs with space characters. (0: don't replace)") {|width| param["tabwidth"] = width.to_i }
+  opts.on('--help', 'Print this message and quit.') {
+    puts opts.help
     exit 0
   }
   begin
-    parser.parse!
+    opts.parse!
   rescue OptionParser::ParseError => err
     $stderr.puts err.message
-    $stderr.puts parser.help
+    $stderr.puts opts.help
     exit 1
   end
 

data/bin/review-vol

@@ -23,40 +23,42 @@ include ReVIEW::TextUtils
 def main
   $KCODE = 'UTF-8' unless defined?(Encoding)
 
-  @param = {
+  @config = ReVIEW::Configure.values
+  @config.merge!({
     "inencoding" => "UTF-8",
     "outencoding" => "UTF-8"
-  }
+  })
 
   part_sensitive = false
   basedir = nil
-  parser = OptionParser.new
-  parser.on('-P', '--part-sensitive', 'Prints volume of each parts.') {
+  opts = OptionParser.new
+  opts.version = ReVIEW::VERSION
+  opts.on('-P', '--part-sensitive', 'Prints volume of each parts.') {
     part_sensitive = true
   }
-  parser.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc|
-    @param["inencoding"] = enc
+  opts.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc|
+    @config["inencoding"] = enc
   }
-  parser.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc|
-    @param["outencoding"] = enc
+  opts.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc|
+    @config["outencoding"] = enc
   }
-  parser.on('--directory=DIR', 'Compile all chapters in DIR.') {|path|
+  opts.on('--directory=DIR', 'Compile all chapters in DIR.') {|path|
     basedir = path
   }
-  parser.on('--help', 'Print this message and quit') {
-    puts parser.help
+  opts.on('--help', 'Print this message and quit') {
+    puts opts.help
     exit 0
   }
   begin
-    parser.parse!
+    opts.parse!
   rescue OptionParser::ParseError => err
     $stderr.puts err.message
-    $stderr.puts parser.help
+    $stderr.puts opts.help
     exit 1
   end
 
   book = basedir ? ReVIEW::Book.load(basedir) : ReVIEW.book
-  ReVIEW.book.param = @param
+  ReVIEW.book.config = @config
   if part_sensitive
     sep = ""
     book.each_part do |part|
@@ -85,7 +87,7 @@ end
 
 def print_chapter_volume(chap)
   vol = chap.volume
-  title = convert_outencoding(chap.title, @param["outencoding"])
+  title = convert_outencoding(chap.title, @config["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/docs

@@ -3,4 +3,4 @@ ChangeLog
 doc/format.rdoc
 doc/quickstart.rdoc
 doc/sample.css
-doc/sample.yaml
+doc/sample.yml

data/doc/catalog.rdoc

@@ -0,0 +1,34 @@
+= Re:VIEW カタログファイル ガイド
+
+Re:VIEW のカタログファイル catalog.ymlについて説明します。
+
+== カタログファイルとは
+
+Re:VIEW フォーマットで記述された各ファイルを特に一冊の本（例えばpdfやepub）にまとめる際に、どのようにそれらのファイルを構造化するかを指定するファイルです。
+現在はカタログファイルと言えばcatalog.ymlのことを指します。
+
+== catalog.ymlを用いた場合の設定方法
+
+catalog.yml内で、PREDEF（前付け）、CHAPS（本編）、POSTDEF（後付け）を記述します。CHAPSのみ必須です。
+
+  PREDEF:
+    - intro.re
+  
+  CHAPS:
+    - ch01.re
+    - ch02.re
+  
+  POSTDEF:
+    - appendix.re
+
+本編に対して、「部」構成を加えたい場合、CHAPSを段階的にして記述します。
+
+（旧バージョンの利用者の方へ: PARTという項目はありません。CHAPSに記述してください）
+
+== バージョン 1.2以前について
+
+1.2以前のRe:VIEWではカタログファイルとしてPREDEF, CHAPS, POSTDEF, PARTという独立した4つのファイルを使用していました。
+そのため、当時のバージョンを利用する際にはcatalog.ymlではなくそちらを記述する必要があります。
+
+現在のRe:VIEWはcatalog.ymlを用いた方法と旧バージョンが使用していたCHAPS, PREDEF, POSTDEF, PARTを用いた方法と両方をサポートしています。
+ただしcatalog.ymlが存在する場合、そちらが優先されます。

data/doc/format.rdoc

@@ -568,6 +568,20 @@ PART:
   :
   @<hd>{hajimeni|まずわ}
 
+=== コラム見出し参照
+
+コラムの見出しの参照は、@<column>を使います。
+
+例:
+
+  @<column>{Re:VIEWの用途いろいろ}
+
+ラベルでの参照もできます。
+
+  ==[column]{review-application} Re:VIEWの応用
+  :
+  @<column>{review-application}
+
 == リンク
 
 Web ハイパーリンクを記述するには、リンクに @<href>、アンカーに //label
@@ -588,7 +602,7 @@ Web ハイパーリンクを記述するには、リンクに @<href>、アン
 Re:VIEWが出力する文字列(「第◯章」「図」「表」など）を、指定した言語に
 合わせて出力することができます。デフォルトは日本語です。
 
-CHAPS などと同じディレクトリに locale.yaml というファイルを用意して、
+CHAPS などと同じディレクトリに locale.yml というファイルを用意して、
 以下のように記述します（日本語の場合）。
 
 例:
@@ -596,7 +610,7 @@ CHAPS などと同じディレクトリに locale.yaml というファイルを
   locale: ja
 
 既存の表記を書き換えたい場合は、該当する項目を上書きします。
-既存の設定ファイルは lib/review/i18n.yaml にあります。
+既存の設定ファイルは lib/review/i18n.yml にあります。
 
 例:
 

data/doc/libepubmaker/{config.yaml → config.yml}

@@ -62,9 +62,6 @@ aut: ["Minero Aoki", "Kenshi Muto", "Masayoshi Takahashi", "Masanori Kado"]
 # coverage: 内容の範囲や領域(配列で複数指定可)
 
 # htmlext: HTMLファイルの拡張子(省略した場合はhtml)
-# cover: カバーページのファイル名(省略した場合はbookname.xhtmlになる)
-#
-# coverimage: カバー用画像
 #
 # CSSファイル(配列で複数指定可)
 stylesheet: ["stylesheet.css"]
@@ -77,41 +74,64 @@ stylesheet: ["stylesheet.css"]
 # 目次として抽出する見出しレベル
 # toclevel: 2
 # 目次を要素の階層表現にしない。省略した場合(null)は階層化する。
-# 構成によっては、階層化目次ではepubcheckにパスしない目次ができるが、
-# そのようなときにはこれをtrueにする
+# 特に部扉が入るなどの理由で、構成によっては階層化目次でepubcheckに
+# パスしない目次ができるが、そのようなときにはこれをtrueにする
 # flattoc: null
 # 目次のインデントレベルをスペース文字で表現する(flattocがtrueのときのみ)
 # flattocindent: true
+
+# 採番の設定。採番させたくない見出しには「==[nonum]」のようにnonum指定をする
+# 
 # 本文でセクション番号を表示する見出しレベル
 # secnolevel: 2
-# 前付でセクション番号を表示する見出しレベル
+
+# 付録の連番のスタイル。null(アラビア数字1〜。デフォルト)、alpha(英字A〜)、roman(ローマ数字I〜)
+# appendix_format: null
+
+# 以下のsecnolevelはまだ未実装。
+# 前付でセクション番号を表示する見出しレベル(未実装)
 # pre_secnolevel: 0
-# 後付でセクション番号を表示する見出しレベル
-# post_secnolevel: 0
-# 部番号を表示する見出しレベル
+# 後付(付録)でセクション番号を表示する見出しレベル(未実装)
+# post_secnolevel: 1
+# 部番号を表示する見出しレベル(未実装)
 # part_secnolevel: 1
 
-# NCX目次の見出しレベルごとの飾り(配列で設定)
+# NCX目次の見出しレベルごとの飾り(配列で設定)。EPUB3ではNCXは作られない
 #ncxindent:
 #- 
 #- - 
 
 # EPUB2標準の目次以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
-# ePUB3においてはこの設定によらず必ず作成する
+# ePUB3においてはこの設定によらず必ず作成される
 # mytoc: true
 
-# 表紙の後に権利表記ページを作成するか。デフォルトでは作成されない。ファイル名を指定するとそのファイルが使われる(data配列にも指定しておく必要がある)
-# titlepage: title.xhtml
-
-# 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.xhtmlとしてコピーされる(data配列にも指定しておく必要がある)
-# colophon: true
-# pubhistory: 奥付履歴
+# 表紙にするHTMLファイル。ファイル名を指定すると表紙として入る
+# cover: null
+# 表紙に配置し、書籍の影絵にも利用する画像ファイル。省略した場合はnull (画像を使わない)
+# coverimage: null
+# 表紙の後に大扉ページを作成するか。省略した場合はnull (作成しない)
+# titlepage: null
+# 自動生成される大扉ページを上書きするファイル。ファイル名を指定すると大扉として入る
+# titlefile: null
+# 原書大扉ページにするHTMLファイル。ファイル名を指定すると原書大扉として入る
+# originaltitlefile: null
+# 権利表記ページファイル。ファイル名を指定すると権利表記として入る
+# creditfile: null
 
 # プロフィールページファイル。ファイル名を指定すると著者紹介として入る
 # profile: null
 # プロフィールページの目次上の見出し
 # profiletitle: 著者紹介
 
+# 広告ファイル。ファイル名を指定すると広告として入る
+# advfile: null
+
+# 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
+# colophon: true
+
+# 裏表紙ファイル (画像はcoversまたはimagesに配置する)。ファイル名を指定すると裏表紙として入る
+# backcover: null
+
 # フックは、各段階で介入したいときのプログラムを指定する。自動で適切な引数が渡される
 # プログラムには実行権限が必要
 
@@ -119,7 +139,7 @@ stylesheet: ["stylesheet.css"]
 # 渡される引数1=作業用展開ディレクトリ
 # hook_beforeprocess: null
 
-# 前付の変換後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
+# 前付の作成後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
 # 渡される引数1=作業用展開ディレクトリ
 # hook_afterfrontmatter: null
 
@@ -127,7 +147,7 @@ stylesheet: ["stylesheet.css"]
 # 渡される引数1=作業用展開ディレクトリ
 # hook_afterbody: null
 
-# 後付の変換後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
+# 後付の作成後に実行するプログラム。作業用展開ディレクトリにある目次ファイル(toc-html.txt)を操作したいときなどに利用する。
 # 渡される引数1=作業用展開ディレクトリ
 # hook_afterbackmatter: null
 
@@ -154,6 +174,12 @@ stylesheet: ["stylesheet.css"]
 # fontdir内から取り込まれる対象となるファイル拡張子。省略した場合は以下
 # font_ext: ["ttf", "woff", "otf"]
 
+# 変換したHTMLファイルおよびCSSを解析して厳密に使用している画像ファイルだけを取り込むか。デフォルトはnull(imagesディレクトリすべてを取り込む)
+# なお、フォント、カバー、広告についてはこの設定によらずディレクトリ内のものがすべて取り込まれる
+# verify_target_images: null
+# verify_target_imagesがtrueの状態において、解析で発見されなくても強制的に取り込むファイルの相対パスの配列
+# force_include_images: []
+
 # Re:VIEWファイル名を使わず、前付にpre01,pre02...、本文にchap01,chap02l...、後付にpost01,post02...という名前付けルールにするか
 # rename_for_legacy: null
 
@@ -161,3 +187,21 @@ stylesheet: ["stylesheet.css"]
 # zip_stage1: "zip -0Xq"
 # ePUBアーカイブの圧縮実行
 # zip_stage2: "zip -Xr9Dq"
+# ePUBアーカイブに追加するパス(デフォルトはmimetype、META-INF、OEBPS)
+# zip_addpath: null
+
+# 以下は古いreview-epubmaker実装で使用されていたパラメータで、
+# 互換性のために同じ機能を提供しているが、将来廃止予定であり、使うべきではない。
+#
+# ヘッダ・フッタのない、表紙のHTMLファイル。
+# (※ヘッダ・フッタを入れたcoverを使うように変更することを勧告する。)
+# coverfile: null
+# ヘッダ・フッタのない、大扉ページ差し替えのHTMLファイル。
+# (※ヘッダ・フッタを入れたtitlefileを使うように変更することを勧告する。)
+# titlepagefile: null
+# ヘッダ・フッタのない、裏表紙のHTMLファイル。
+# (※ヘッダ・フッタを入れたbackcoverを使うように変更することを勧告する。)
+# backcoverfile: null
+# 奥付の日付文字列。
+# (※history配列を使うように変更することを勧告する。)
+# pubhistory: 奥付履歴文字列

data/doc/quickstart.rdoc

@@ -174,7 +174,7 @@ review-pdfmaker コマンドで PDF ブックの作成、review-epubmaker コマ
 
 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.yml}[https://github.com/kmuto/review/blob/master/doc/sample.yml] としてこのドキュメントと同じディレクトリに収録しています。
 
   review-pdfmaker YAMLファイル  ←PDFの作成
   review-epubmaker YAMLファイル ←EPUBの作成

data/lib/epubmaker.rb

@@ -11,7 +11,7 @@
 # == Quick usage
 #  require 'epubmaker'
 #  epub = EPUBMaker::Producer.new
-#  params = epub.load("config.yaml")
+#  params = epub.load("config.yml")
 #  epub.contents.push(EPUBMaker::Content.new({"file" => "ch01.xhtml"}))
 #  epub.contents.push(EPUBMaker::Content.new({"file" => "ch02.xhtml"}))
 #   ...

data/lib/epubmaker/content.rb

@@ -26,6 +26,10 @@ module EPUBMaker
     attr_accessor :level
     # Show in TOC? nil:No.
     attr_accessor :notoc
+    # Properties (EPUB3)
+    attr_accessor :properties
+    # Chapter type (pre/post/part/nil(body))
+    attr_accessor :chaptype
 
     # :call-seq:
     #    initialize(file, id, media, title, level, notoc)
@@ -33,7 +37,7 @@ module EPUBMaker
     # Construct Content object by passing a sequence of parameters or hash.
     # Keys of +hash+ relate with each parameters.
     # +file+ (or +hash+["file"]) is required. Others are optional.
-    def initialize(fileorhash, id=nil, media=nil, title=nil, level=nil, notoc=nil)
+    def initialize(fileorhash, id=nil, media=nil, title=nil, level=nil, notoc=nil, properties=nil, chaptype=nil)
       if fileorhash.instance_of?(Hash)
         @id = fileorhash["id"]
         @file = fileorhash["file"]
@@ -41,6 +45,8 @@ module EPUBMaker
         @title = fileorhash["title"]
         @level = fileorhash["level"]
         @notoc = fileorhash["notoc"]
+        @properties = fileorhash["properties"] || []
+        @chaptype = fileorhash["chaptype"]
       else
         @file = fileorhash
         @id = id
@@ -48,6 +54,8 @@ module EPUBMaker
         @title = title
         @level = level
         @notoc = notoc
+        @properties = properties || []
+        @chaptype = chaptype
       end
       complement
     end

data/lib/epubmaker/epubv2.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 # = epubv2.rb -- EPUB version 2 producer.
 #
-# Copyright (c) 2010-2013 Kenshi Muto and Masayoshi Takahashi
+# Copyright (c) 2010-2014 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -352,7 +352,14 @@ EOT
             items.each_with_index do |item, rev|
               editstr = (edit == 0) ? "初版" : "第#{edit + 1}版" # FIXME:i18n
               revstr = "第#{rev + 1}刷"
-              s << %Q[      <p>#{date_to_s(item)}　#{editstr}#{revstr}　発行</p>\n] # FIXME:i18n
+              if item =~ /\A\d+\-\d+\-\d+\Z/
+                s << %Q[      <p>#{date_to_s(item)}　#{editstr}#{revstr}　発行</p>\n] # FIXME:i18n
+              else
+                # custom date with string
+                item.match(/\A(\d+\-\d+\-\d+)[\s　](.+)/) do |m|
+                  s << %Q[      <p>#{date_to_s(m[1])}　#{m[2]}</p>\n]
+                end
+              end
             end
           end
         else
@@ -382,6 +389,12 @@ EOT
       end
       s << <<EOT
     </table>
+EOT
+      if !@producer.params["rights"].nil? && @producer.params["rights"].size > 0
+        s << %Q[    <p class="copyright">#{@producer.params["rights"].join("<br />")}</p>]
+      end
+
+      s << <<EOT
   </div>
 </body>
 </html>
@@ -421,19 +434,30 @@ EOT
       require 'rexml/document'
       level = 1
       find_jump = nil
+      has_part = nil
+      toclevel = @producer.params["toclevel"].to_i
 
       # check part existance
       @producer.contents.each do |item|
-        if item.notoc.nil? && item.level == 0
-          level = 0
+        if item.notoc.nil? && item.chaptype == "part"
+          has_part = true
+          break
         end
       end
 
+      if !has_part.nil?
+        @producer.contents.each do |item|
+          item.level += 1 if item.chaptype == "part" || item.chaptype == "body"
+          item.notoc = true if (item.chaptype == "pre" || item.chaptype == "post") && !item.level.nil? && (item.level + 1 == toclevel)
+        end
+        toclevel += 1
+      end
+
       doc = REXML::Document.new(%Q[<#{type} class="toc-h#{level}"><li /></#{type}>])
 
       e = doc.root.elements[1] # first <li/>
       @producer.contents.each do |item|
-        next if !item.notoc.nil? || item.level.nil? || item.file.nil? || item.title.nil? || item.level > @producer.params["toclevel"].to_i
+        next if !item.notoc.nil? || item.level.nil? || item.file.nil? || item.title.nil? || item.level > toclevel
 
         if item.level == level
           e2 = e.parent.add_element("li")
@@ -442,6 +466,12 @@ EOT
           find_jump = true if (item.level - level) > 1
           # deeper
           (level + 1).upto(item.level) do |n|
+            if e.size == 0
+              # empty span for epubcheck
+              es = e.add_element("span") 
+              es.add_text(REXML::Text.new("　", false, nil, true))
+            end
+
             e2 = e.add_element(type, {"class" => "toc-h#{n}"})
             e3 = e2.add_element("li")
             e = e3
@@ -516,7 +546,29 @@ EOT
 
     def export_zip(tmpdir, epubfile)
       Dir.chdir(tmpdir) {|d| system("#{@producer.params["zip_stage1"]} #{epubfile} mimetype") }
-      Dir.chdir(tmpdir) {|d| system("#{@producer.params["zip_stage2"]} #{epubfile} META-INF OEBPS") }
+      Dir.chdir(tmpdir) {|d| system("#{@producer.params["zip_stage2"]} #{epubfile} META-INF OEBPS #{@producer.params["zip_addpath"]}") }
+    end
+
+    def legacy_cover_and_title_file(loadfile, writefile)
+      s = common_header
+      s << <<EOT
+  <title>#{@producer.params["booktitle"]}</title>
+</head>
+<body>
+EOT
+      File.open(loadfile) do |f|
+        f.each_line do |l|
+          s << l
+        end
+      end
+      s << <<EOT
+</body>
+</html>
+EOT
+
+      File.open(writefile, "w") do |f|
+        f.puts s
+      end
     end
 
     private
@@ -530,7 +582,7 @@ EOT
 <head>
   <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/>
   <meta http-equiv="Content-Style-Type" content="text/css"/>
-  <meta name="generator" content="EPUBMaker::Producer"/>
+  <meta name="generator" content="Re:VIEW"/>
 EOT
 
       @producer.params["stylesheet"].each do |file|