review 2.3.0 → 2.4.0

data/bin/review-pdfmaker

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-# encoding: utf-8
-
 # Copyright (c) 2010-2017 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.

data/bin/review-preproc

@@ -1,9 +1,7 @@
 #!/usr/bin/env ruby
 #
-# $Id: review-preproc 3761 2007-12-31 07:20:09Z aamine $
-#
 # Copyright (c) 2010-2014 Minero Aoki, Kenshi Muto
-# Copyright (c) 1999-2007 Minero Aoki
+#               1999-2007 Minero Aoki
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -20,6 +18,7 @@ require 'review/preprocessor'
 require 'review/unfold'
 require 'review/version'
 require 'review/extentions'
+require 'review/logger'
 require 'lineinput'
 require 'stringio'
 require 'fileutils'
@@ -36,11 +35,12 @@ rescue Errno::EPIPE
 end
 
 def main
-  if File.file?("review-preproc-ext.rb")
-    if ENV["REVIEW_SAFE_MODE"].to_i & 2 > 0
-      warn "review-preproc-ext.rb is prohibited in safe mode. ignored."
+  @logger = ReVIEW.logger
+  if File.file?('review-preproc-ext.rb')
+    if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
+      @logger.warn 'review-preproc-ext.rb is prohibited in safe mode. ignored.'
     else
-      Kernel.load File.expand_path("review-preproc-ext.rb")
+      Kernel.load File.expand_path('review-preproc-ext.rb')
     end
   end
 
@@ -49,31 +49,21 @@ def main
   mode = :output
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.banner = "Usage: #{File.basename($0)} [-c|-d|-s|--replace] [<file>...]"
-  opts.on('-c', '--check', 'Check if preprocess is needed.') {
-    mode = :check
-  }
-  opts.on('-d', '--diff', 'Show diff from current file.') {
-    mode = :diff
-  }
-  opts.on('--replace', 'Replace file by preprocessed one.') {
-    mode = :replace
-  }
-  opts.on('-s', '--strip', 'Strip preprocessor tags.') {
-    mode = :strip
-  }
-  opts.on('--final', 'Unfold text and strip preprocessor tags. (deprecated)') {
-    mode = :final
-  }
-  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.') {
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [-c|-d|-s|--replace] [<file>...]"
+  opts.on('-c', '--check', 'Check if preprocess is needed.') { mode = :check }
+  opts.on('-d', '--diff', 'Show diff from current file.') { mode = :diff }
+  opts.on('--replace', 'Replace file by preprocessed one.') { mode = :replace }
+  opts.on('-s', '--strip', 'Strip preprocessor tags.') { mode = :strip }
+  opts.on('--final', 'Unfold text and strip preprocessor tags. (deprecated)') { mode = :final }
+  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.') do
     puts opts.help
     exit 0
-  }
+  end
   begin
     opts.parse!
   rescue OptionParser::ParseError => err
-    $stderr.puts err.message
+    @logger.error err.message
     $stderr.puts opts.help
     exit 1
   end
@@ -84,9 +74,7 @@ def main
     current_file = path
     case mode
     when :output
-      File.open(path) {|f|
-        pp.process f, $stdout
-      }
+      File.open(path) { |f| pp.process f, $stdout }
     when :replace
       File.write "#{path}.pptmp", preproc(pp, path)
       File.rename "#{path}.pptmp", path
@@ -103,38 +91,30 @@ def main
         FileUtils.rm_f tmp
       end
     when :strip
-      File.open(path) {|f|
-        ReVIEW::Preprocessor::Strip.new(f).each do |line|
-          puts line
-        end
-      }
+      File.open(path) do |f|
+        ReVIEW::Preprocessor::Strip.new(f).each { |line| puts line }
+      end
     when :final
       u = ReVIEW::Unfold.new
-      File.open(path) {|f|
-        u.unfold ReVIEW::Preprocessor::Strip.new(f), $stdout
-      }
+      File.open(path) { |f| u.unfold ReVIEW::Preprocessor::Strip.new(f), $stdout }
     else
       raise "must not happen: #{mode}"
     end
   end
 rescue ReVIEW::Error => err
   raise if $DEBUG
-  $stderr.puts err.message
+  @logger.error err.message
   exit 1
 end
 
 def preproc(pp, path)
   buf = StringIO.new
-  File.open(path) {|f|
-    pp.process f, buf
-  }
+  File.open(path) { |f| pp.process f, buf }
   buf.string
 end
 
 def File.write(path, str)
-  File.open(path, 'w') {|f|
-    f.write str
-  }
+  File.open(path, 'w') { |f| f.write str }
 end
 
 sigmain

data/bin/review-validate

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-# Copyright (c) 2010-2016 Kenshi Muto
+# Copyright (c) 2010-2017 Kenshi Muto
 #
 # This program is free software
 # You can distribute or modify this program under the terms of
@@ -8,45 +8,46 @@
 #
 
 # simple validator for Re:VIEW
+require 'pathname'
+
+bindir = Pathname.new(__FILE__).realpath.dirname
+$LOAD_PATH.unshift((bindir + '../lib').realpath)
+require 'review/logger'
 
 block = nil
 maxcolcount = 0
 colcount = 0
 ln = 0
 
-ARGF.each {|line|
+@logger = ReVIEW.logger
+
+ARGF.each do |line|
   ln += 1
-  if line =~ /\A\/\/([a-z]+)\{\s*\Z/ || line =~ /\A\/\/([a-z]+)\[.+?\{\s*\Z/
+  if line =~ %r{\A//([a-z]+)\{\s*\Z} || line =~ %r{\A//([a-z]+)\[.+?\{\s*\Z}
     # block
     new_block = $1
-    puts "#{ln}: block #{new_block} started, but previous block #{block} didn't close yet." unless block.nil?
+    @logger.warn "#{ln}: block #{new_block} started, but previous block #{block} didn't close yet." if block
     block = new_block
-  elsif line =~ /\A\/\/\}/
-    puts "#{ln}: block ended, but not opened." if block.nil?
+  elsif line =~ %r{\A//\}}
+    @logger.warn "#{ln}: block ended, but not opened." if block.nil?
     block = nil
     maxcolcount = 0
     colcount = 0
   elsif line =~ /\A(\d+\.)\s+/
     # number
-    unless ["list", "emlist", "listnum", "emlistnum", "cmd", "image", "table"].include?(block)
-      puts "#{ln}: found '#{$1}' without the head space. Is it correct?"
-    end
+    @logger.warn "#{ln}: found '#{$1}' without the head space. Is it correct?" unless %w[list emlist listnum emlistnum cmd image table].include?(block)
   elsif line =~ /\A\*\s+/
     # itemize
-    unless ["list", "emlist", "listnum", "emlistnum", "cmd", "image", "table"].include?(block)
-      puts "#{ln}: found '*' without the head space. Is it correct?"
-    end
+    @logger.warn "#{ln}: found '*' without the head space. Is it correct?" unless %w[list emlist listnum emlistnum cmd image table].include?(block)
   elsif line =~ /\A\s+(\d+\.)\s+/ && line =~ /\A\s+\*\s+/
-    unless ["list", "emlist", "listnum", "emlistnum", "cmd", "image", "table"].include?(block)
-      puts "#{ln}: found itemized list or numbered list in #{block}. Is it correct?"
-    end
-  elsif block == "table"
+    @logger.warn "#{ln}: found itemized list or numbered list in #{block}. Is it correct?" unless Tw[list emlist listnum emlistnum cmd image table].include?(block)
+  elsif block == 'table'
     next if line.start_with?('#@')
     if line !~ /\A\-\-\-\-\-/
       # table
       colcount = line.split("\t").size
       maxcolcount = colcount if maxcolcount == 0
-      puts "#{ln}: the number of table columns seems mismatch. (#{maxcolcount} != #{colcount})" if colcount != maxcolcount
+      @logger.warn "#{ln}: the number of table columns seems mismatch. (#{maxcolcount} != #{colcount})" if colcount != maxcolcount
     end
   end
-}
+end

data/bin/review-vol

@@ -1,8 +1,7 @@
 #!/usr/bin/env ruby
 #
-# $Id: review-vol 3901 2008-02-11 20:04:59Z aamine $
-#
-# Copyright (c) 2003-2014 Minero Aoki
+# Copyright (c) 2014-2017 Minero Aoki, Kenshi Muto
+#               2003-2014 Minero Aoki
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -21,6 +20,7 @@ require 'optparse'
 include ReVIEW::TextUtils
 
 def main
+  @logger = ReVIEW.logger
   @config = ReVIEW::Configure.values
 
   part_sensitive = false
@@ -28,55 +28,43 @@ def main
   yamlfile = nil
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.on('--yaml=YAML', 'Read configurations from YAML file.') do |yaml|
-    yamlfile = yaml
-  end
-  opts.on('-P', '--part-sensitive', 'Prints volume of each parts.') {
-    part_sensitive = true
-  }
-  opts.on('--directory=DIR', 'Compile all chapters in DIR.') {|path|
-    basedir = path
-  }
-  opts.on('--help', 'Print this message and quit') {
+  opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| yamlfile = yaml }
+  opts.on('-P', '--part-sensitive', 'Prints volume of each parts.') { part_sensitive = true }
+  opts.on('--directory=DIR', 'Compile all chapters in DIR.') { |path| basedir = path }
+  opts.on('--help', 'Print this message and quit') do
     puts opts.help
     exit 0
-  }
+  end
   begin
     opts.parse!
   rescue OptionParser::ParseError => err
-    $stderr.puts err.message
+    @logger.error err.message
     $stderr.puts opts.help
     exit 1
   end
 
   book = basedir ? ReVIEW::Book.load(basedir) : ReVIEW::Book::Base.load
   book.config = @config
-  if yamlfile
-    book.load_config(yamlfile)
-  end
+  book.load_config(yamlfile) if yamlfile
 
   if part_sensitive
-    sep = ""
+    sep = ''
     book.each_part do |part|
       print sep
       sep = "\n"
       puts "Part #{part.number} #{part.name}" if part.number
-      part.each_chapter do |chap|
-        print_chapter_volume chap
-      end
+      part.each_chapter { |chap| print_chapter_volume chap }
       puts '    --------------------'
       print_volume part.volume
     end
   else
-    book.each_chapter do |chap|
-      print_chapter_volume chap
-    end
+    book.each_chapter { |chap| print_chapter_volume chap }
   end
   puts '============================='
-  print_volume book.volume #puts "Total #{book.volume}"
+  print_volume book.volume # puts "Total #{book.volume}"
 rescue ReVIEW::ApplicationError, Errno::ENOENT => err
   raise if $DEBUG
-  $stderr.puts "#{File.basename($0)}: #{err.message}"
+  @logger.error "#{File.basename($PROGRAM_NAME)}: #{err.message}"
   exit 1
 end
 

data/doc/config.yml.sample

@@ -134,8 +134,8 @@ secnolevel: 2
 # 表紙に配置し、書籍の影絵にも利用する画像ファイル。省略した場合はnull (画像を使わない)。画像ディレクトリ内に置いてもディレクトリ名は不要(例: cover.jpg)
 # coverimage: null
 #
-# 表紙の後に大扉ページを作成するか。省略した場合はnull (作成しない)
-# titlepage: null
+# 表紙の後に大扉ページを作成するか。省略した場合はtrue (作成する)
+# titlepage: true
 #
 # 自動生成される大扉ページを上書きするファイル。ファイル名を指定すると大扉として入る (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
 # titlefile: null
@@ -252,6 +252,9 @@ epubmaker:
   # verify_target_imagesがtrueの状態において、解析で発見されなくても強制的に取り込むファイルの相対パスの配列
   # force_include_images: []
   #
+  # 画像ファイルの縦x横の最大ピクセル数許容値
+  # image_maxpixels: 4000000
+  #
   # Re:VIEWファイル名を使わず、前付にpre01,pre02...、本文にchap01,chap02l...、後付にpost01,post02...という名前付けルールにするか
   # rename_for_legacy: null
   #

data/doc/format.ja.md

@@ -155,7 +155,7 @@ Re:VIEW フォーマットの文法について解説します。Re:VIEW フォ
 @<命令>{対象の内容}
 ```
 
-内容に「}」という文字が必要であれば、`\}` でリテラルを表現できます。
+内容に「}」という文字が必要であれば、`\}` でリテラルを表現できます。なお、内容の末尾を「\」としたい場合は、`\\` と記述する必要があります（たとえば `@<tt>{\\}`）。
 
 記法および処理の都合で、次のような制約があります。
 
@@ -163,6 +163,25 @@ Re:VIEW フォーマットの文法について解説します。Re:VIEW フォ
 * ブロック命令内には見出しや箇条書きを格納できません。
 * インライン命令には別のインライン命令をネストできません。
 
+### インライン命令のフェンス記法
+
+インライン命令において `}` や 末尾 `\` を多用したい場合、それぞれ `\}` や `\\` のようにエスケープするのはわずらわしいことがあります。そのようなときには、インライン命令の囲みの `{ }` の代わりに `$ $` あるいは `| |` を使って内容を囲むことで、エスケープ表記せずに記述できます。
+
+```
+@<命令>$対象の内容$
+@<命令>|対象の内容|
+```
+
+例:
+
+```review
+@<m>$\Delta = \frac{\partial^2}{\partial x_1^2}+\frac{\partial^2}{\partial x_2^2} + \cdots + \frac{\partial^2}{\partial x_n^2}$
+@<tt>|if (exp) then { ... } else { ... }|
+@<b>|\|
+```
+
+あくまでも代替であり、推奨する記法ではありません。濫用は避けてください。
+
 ## ソースコードなどのリスト
 
 ソースコードなどのリストには`//list`を使います。連番を付けたくない場合は先頭に `em`（embedded の略）、行番号を付ける場合は末尾に `num` を付加します。まとめると、以下の4種類になります。

data/doc/format.md

@@ -115,7 +115,6 @@ They aren't nested.
 
 Usage:
 
-
 ```
 1. 1st condition
 2. 2nd condition
@@ -185,7 +184,7 @@ Inline commands are used in block,  paragraphes, headings, block contents and bl
 @<command>{content}
 ```
 
-When you want to use a character `}` in inline content, you must use escaping `\}`.
+When you want to use a character `}` in inline content, you must use escaping `\}`. If the content ends with `\`, it must be written `\\`. (ex. `@<tt>{\\}`)
 
 There are some limitations in blocks and inlines.
 
@@ -193,6 +192,24 @@ There are some limitations in blocks and inlines.
 * You cannot write headings and itemize in block contents.
 * Inline commands also do not support nestins.  You cannot write inlines in another inline.
 
+### Fence notation for inline commands
+You may be tired of escaping when you use a large number of inline commands including `{` and `\`. By surrounding the contents with `$ $` or `| |` instead of `{ }`, you can write without escaping.
+
+```
+@<command>$content$
+@<command>|content|
+```
+
+Example:
+
+```review
+@<m>$\Delta = \frac{\partial^2}{\partial x_1^2}+\frac{\partial^2}{\partial x_2^2} + \cdots + \frac{\partial^2}{\partial x_n^2}$
+@<tt>|if (exp) then { ... } else { ... }|
+@<b>|\|
+```
+
+Since this notation is substitute, please avoid abuse.
+
 ## Code List
 
 Code list like source codes is `//list`. If you don't need numbers, you can use ``em`` prefix (as embedded). If you need line numbers, you can use ``num`` postfix.  So you can use four types of lists.
@@ -518,10 +535,9 @@ is in footnotes.
 
 Note that In LATEXBuilder, you should use `footnotetext` option to use `@<fn>{...}` in columns and tables.
 
-### `--footnotetext` option
+### `footnotetext` option
 
-When you want to use `footnotetext` option, you can add `--footnotetext` with `params` in config.yml.
-With this option, you can use footnote in tables and short notes.
+By adding `footnotetext:true` in config.yml, you can use footnote in tables and short notes.
 
 Note that there are some constraints that (because of normal footnote )
 

data/lib/epubmaker.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # = epubmaker.rb -- EPUB production set.
 #
 # Copyright (c) 2010-2017 Kenshi Muto
@@ -12,7 +10,7 @@
 # == Quick usage
 #  require 'epubmaker'
 #  producer = EPUBMaker::Producer.new
-#  params = producer.load("config.yml")
+#  config = producer.load("config.yml")
 #  producer.contents.push(EPUBMaker::Content.new({"file" => "ch01.xhtml"}))
 #  producer.contents.push(EPUBMaker::Content.new({"file" => "ch02.xhtml"}))
 #   ...

data/lib/epubmaker/content.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # = content.rb -- Content object for EPUBMaker.
 #
 # Copyright (c) 2010-2017 Kenshi Muto
@@ -11,7 +9,6 @@
 #
 
 module EPUBMaker
-
   # EPUBMaker::Content represents a content data for EPUBMaker.
   # EPUBMaker#contents takes an array of Content.
   class Content
@@ -32,22 +29,26 @@ module EPUBMaker
     # Chapter type (pre/post/part/nil(body))
     attr_accessor :chaptype
 
+    def inspect
+      "<Content id=#{@id}, file=#{@file}, media=#{@media}, title=#{@title}, level=#{@level}, notoc=#{@notoc}, properties=#{@properties}, chaptype=#{@chaptype}>"
+    end
+
     # :call-seq:
     #    initialize(file, id, media, title, level, notoc)
     #    initialize(hash)
     # 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, properties=nil, chaptype=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"]
-        @media = fileorhash["media"]
-        @title = fileorhash["title"]
-        @level = fileorhash["level"]
-        @notoc = fileorhash["notoc"]
-        @properties = fileorhash["properties"] || []
-        @chaptype = fileorhash["chaptype"]
+        @id = fileorhash['id']
+        @file = fileorhash['file']
+        @media = fileorhash['media']
+        @title = fileorhash['title']
+        @level = fileorhash['level']
+        @notoc = fileorhash['notoc']
+        @properties = fileorhash['properties'] || []
+        @chaptype = fileorhash['chaptype']
       else
         @file = fileorhash
         @id = id
@@ -62,9 +63,7 @@ module EPUBMaker
     end
 
     def ==(other)
-      if self.class != other.class
-        return false
-      end
+      return false unless self.class == other.class
       [self.id, self.file, self.media, self.title, self.level, self.notoc, self.chaptype, self.properties] ==
         [other.id, other.file, other.media, other.title, other.level, other.notoc, other.chaptype, other.properties]
     end
@@ -73,22 +72,20 @@ module EPUBMaker
 
     # Complement other parameters by using file parameter.
     def complement
-      @id = @file.gsub(/[\\\/\. ]/, '-') if @id.nil?
+      @id = @file.gsub(%r{[\\/\. ]}, '-') if @id.nil?
       @id = "rv-#{@id}" if @id =~ /\A[^a-z]/i
       @media = @file.sub(/.+\./, '').downcase if !@file.nil? && @media.nil?
 
-      @media = "application/xhtml+xml" if @media == "xhtml" || @media == "xml" || @media == "html"
-      @media = "text/css" if @media == "css"
-      @media = "image/jpeg" if @media == "jpg" || @media == "jpeg" || @media == "image/jpg"
-      @media = "image/png" if @media == "png"
-      @media = "image/gif" if @media == "gif"
-      @media = "image/svg+xml" if @media == "svg" || @media == "image/svg"
-      @media = "application/vnd.ms-opentype" if @media == "ttf" || @media == "otf"
-      @media = "application/font-woff" if @media == "woff"
+      @media = 'application/xhtml+xml' if @media == 'xhtml' || @media == 'xml' || @media == 'html'
+      @media = 'text/css' if @media == 'css'
+      @media = 'image/jpeg' if @media == 'jpg' || @media == 'jpeg' || @media == 'image/jpg'
+      @media = 'image/png' if @media == 'png'
+      @media = 'image/gif' if @media == 'gif'
+      @media = 'image/svg+xml' if @media == 'svg' || @media == 'image/svg'
+      @media = 'application/vnd.ms-opentype' if @media == 'ttf' || @media == 'otf'
+      @media = 'application/font-woff' if @media == 'woff'
 
-      if @id.nil? || @file.nil? || @media.nil?
-        raise "Type error: #{id}, #{file}, #{media}, #{title}, #{notoc}"
-      end
+      raise "Type error: #{id}, #{file}, #{media}, #{title}, #{notoc}" if @id.nil? || @file.nil? || @media.nil?
     end
   end
 end