review 4.2.0 → 5.0.0

data/bin/review-catalog-converter

@@ -109,7 +109,7 @@ def parse_postdef(str, to_appendix = false)
 end
 
 def parse_parts(parts_str, chaps_str)
-  if parts_str.blank? or chaps_str.blank?
+  if parts_str.blank? || chaps_str.blank?
     return "CHAPS:\n\n"
   end
 

data/bin/review-check

@@ -31,9 +31,7 @@ end
 
 def main
   @config = ReVIEW::Configure.values
-  @book = ReVIEW::Book::Base.load
-  @book.config = @config
-
+  @book = ReVIEW::Book::Base.new(config: @config)
   @logger = ReVIEW.logger
 
   modes = nil
@@ -87,7 +85,7 @@ def check_text(files)
         s = para.join
         m = re.match(s)
         next if m.nil? || m[0] == @review_utils_word_ok
-        next if neg and neg =~ s
+        next if neg && neg =~ s
         str, offset = find_line(para, re)
         out = sprintf("%s:%d: %s\n", path, lineno + offset, str)
         print out

data/bin/review-checkdep

@@ -30,7 +30,7 @@ def main
     when /\A\#@provide\((.*)\)/
       provide($1)
     else
-      line.scan(/@<kw>\{(.*?)[,\}]/) { provide $1 }
+      line.scan(/@<kw>\{(.*?)[,}]/) { provide($1) }
     end
   end
 end

data/bin/review-compile

@@ -79,32 +79,30 @@ def _main
       error('no input') if ARGV.empty?
 
       @basedir = File.dirname(ARGV[0])
-      book = ReVIEW::Book::Base.load(@basedir)
-      book.config = @config # needs only at the first time
+      book = ReVIEW::Book::Base.new(@basedir, config: @config)
       ARGV.each do |item|
         error("file not found: #{item}") unless File.exist?(File.join(book.config['contentdir'], item))
         chap_name = File.basename(item, '.*')
         chap = book.chapter(chap_name)
-        compiler = ReVIEW::Compiler.new(load_strategy_class(@target, @check_only))
+        compiler = ReVIEW::Compiler.new(load_builder_class(@target, @check_only))
         result = compiler.compile(chap)
         if @output_filename
-          write(@output_filename, result)
+          File.write(@output_filename, result)
         else
           puts result unless @check_only
         end
       end
     when :dir
-      book = @basedir ? ReVIEW::Book.load(@basedir) : ReVIEW::Book::Base.load
-      book.config = @config
-      compiler = ReVIEW::Compiler.new(load_strategy_class(@target, @check_only))
+      book = @basedir ? ReVIEW::Book::Base.new(@basedir, config: @config) : ReVIEW::Book::Base.new(config: @config)
+      compiler = ReVIEW::Compiler.new(load_builder_class(@target, @check_only))
       book.chapters.each do |chap|
         str = compiler.compile(chap)
-        write("#{chap.name}#{compiler.strategy.extname}", str) unless @check_only
+        File.write("#{chap.name}#{compiler.builder.extname}", str) unless @check_only
       end
       # PART
       book.parts_in_file.each do |part|
         str = compiler.compile(part)
-        write("#{part.name}#{compiler.strategy.extname}", str) unless @check_only
+        File.write("#{part.name}#{compiler.builder.extname}", str) unless @check_only
       end
     else
       raise "must not happen: #{@mode}"
@@ -178,13 +176,9 @@ def warn(msg)
   @logger.warn msg
 end
 
-def load_strategy_class(target, strict)
+def load_builder_class(target, strict)
   require "review/#{target}builder"
   ReVIEW.const_get("#{target.upcase}Builder").new(strict)
 end
 
-def write(path, str)
-  File.open(path, 'w') { |f| f.puts str }
-end
-
 main

data/bin/review-validate

@@ -53,7 +53,7 @@ ARGF.each do |line|
     end
   elsif block == 'table'
     next if line.start_with?('#@')
-    if line !~ /\A\-\-\-\-\-/
+    if line !~ /\A-----/
       # table
       colcount = line.split("\t").size
       if maxcolcount == 0

data/doc/config.yml.sample

@@ -5,7 +5,7 @@
 # このファイルはUTF-8エンコーディングで記述してください。
 
 # この設定ファイルでサポートするRe:VIEWのバージョン番号。
-review_version: 4.0
+review_version: 5.0
 
 # ほかの設定ファイルの継承を指定できる。同じパラメータに異なる値がある場合は、
 # 呼び出し元の値が優先される。
@@ -92,6 +92,9 @@ debug: null
 # ISBN。省略した場合はurnidが入る
 # isbn: null
 #
+# @<chap>, @<chapref>, @<title>, @<hd>命令をハイパーリンクにする(nullでハイパーリンクにしない)
+# chapterlink: true
+
 # HTMLファイルの拡張子(省略した場合はhtml)
 # htmlext: html
 #

data/doc/config.yml.sample-simple

@@ -1,5 +1,5 @@
 # simple sample of config.yml
-review_version: 4.0
+review_version: 5.0
 
 # debug: true
 

data/doc/format.ja.md

@@ -2,7 +2,7 @@
 
 Re:VIEW フォーマットの文法について解説します。Re:VIEW フォーマットはアスキー社（現カドカワ）の EWB を基本としながら、一部に RD や各種 Wiki の文法を取り入れて簡素化しています。
 
-このドキュメントは、Re:VIEW 3.0 に基づいています。
+このドキュメントは、Re:VIEW 5.0 に基づいています。
 
 ## 段落
 
@@ -255,7 +255,6 @@ puts "hello world!"
 //}
 ```
 
-
 ### ソースコード専用の引用
 
 ソースコードを引用するには次のように記述します。
@@ -503,6 +502,19 @@ complexmatrixという識別子に基づく画像ファイルが貼り込まれ
 
 内容には、空行で区切って複数の段落を記述可能です。
 
+Re:VIEW 5.0 以降では、囲み記事に箇条書きや図表・リストを含めることもできます。
+
+```
+//note{
+
+箇条書きを含むノートです。
+
+ 1. 箇条書き1
+ 2. 箇条書き2
+
+//}
+```
+
 ## 脚注
 
 脚注は「`//footnote`」を使って記述します。
@@ -589,7 +601,7 @@ LaTeX の式を挿入するには、`//texequation{ 〜 //}` を使います。
 「式1.1」のように連番を付けたいときには、識別子とキャプションを指定します。
 
 ```
-//texequationl[emc][質量とエネルギーの等価性]{
+//texequation[emc][質量とエネルギーの等価性]{
 \sum_{i=1}^nf_n(x)
 //}
 ```
@@ -912,9 +924,76 @@ LaTeXビルダを使用している場合:
 
 ```
 
-
 `//raw`、`//embed`、`@<raw>` および `@<embed>` は、HTML、XML や TeX の文書構造を容易に壊す可能性があります。使用には十分に注意してください。
 
+### 入れ子の箇条書き
+
+Re:VIEW の箇条書きは `*` 型の箇条書きを除き、基本的に入れ子を表現できません。いずれの箇条書きも、別の箇条書き、あるいは図表・リストを箇条書きの途中に配置することを許容していません。
+
+この対策として、Re:VIEW 4.2 では試験的に `//beginchild`、`//endchild` というブロック命令を追加しています。箇条書きの途中に何かを含めたいときには、それを `//beginchild` 〜 `//endchild` で囲んで配置します。多重に入れ子にすることも可能です。
+
+```
+ * UL1
+
+//beginchild
+#@# ここからUL1の子
+
+ 1. UL1-OL1
+
+//beginchild
+#@# ここからUL1-OL1の子
+
+UL1-OL1-PARAGRAPH
+
+ * UL1-OL1-UL1
+ * UL1-OL1-UL2
+
+//endchild
+#@# ここまでUL1-OL1の子
+
+ 2. UL1-OL2
+
+ : UL1-DL1
+        UL1-DD1
+ : UL1-DL2
+        UL1-DD2
+
+//endchild
+#@# ここまでUL1の子
+
+ * UL2
+```
+
+これをたとえば HTML に変換すると、次のようになります。
+
+```
+<ul>
+<li>UL1
+<ol>
+<li>UL1-OL1
+<p>UL1-OL1-PARAGRAPH</p>
+<ul>
+<li>UL1-OL1-UL1</li>
+<li>UL1-OL1-UL2</li>
+</ul>
+</li>
+
+<li>UL1-OL2</li>
+</ol>
+<dl>
+<dt>UL1-DL1</dt>
+<dd>UL1-DD1</dd>
+<dt>UL1-DL2</dt>
+<dd>UL1-DD2</dd>
+</dl>
+</li>
+
+<li>UL2</li>
+</ul>
+```
+
+（試験実装のため、命令名や挙動は今後のバージョンで変更になる可能性があります。）
+
 ## インライン命令
 主なインライン命令を次に示します。
 

data/doc/format.md

@@ -4,8 +4,7 @@ The document is a brief guide for Re:VIEW markup syntax.
 
 Re:VIEW is based on EWB of ASCII (now KADOKAWA), influenced RD and other Wiki system's syntax.
 
-This document explains about the format of Re:VIEW 3.0.
-
+This document explains about the format of Re:VIEW 5.0.
 
 ## Paragraph
 
@@ -284,7 +283,6 @@ puts "hello world!"
 //}
 ```
 
-
 ### Quoting Source Code
 
 `//source` is for quoting source code. filename is mandatory.
@@ -339,7 +337,6 @@ You can use `//image{ ... //}` for figures.
 You can write comments or Ascii art in the block as an alternative description.
 When publishing, it's simply ignored.
 
-
 Usage:
 
 ```
@@ -532,6 +529,19 @@ Some block commands are used for short column.
 
 The content is like paragraph; separated by empty lines.
 
+From Re:VIEW 5.0, it is also possible to include itemize, figures and tables in short columns.
+
+```
+//note{
+
+With ordered itemize.
+
+ 1. item1
+ 2. item2
+
+//}
+```
+
 ## Footnotes
 
 You can use `//footnote` to write footnotes.
@@ -624,7 +634,7 @@ Usage:
 If you'd like to assign a number like 'Equation 1.1`, specify the identifier and caption.
 
 ```
-//texequationl[emc][The Equivalence of Mass and Energy]{
+//texequation[emc][The Equivalence of Mass and Energy]{
 \sum_{i=1}^nf_n(x)
 //}
 ```
@@ -956,6 +966,75 @@ this is a special line.
 
 (In other formats, it is just ignored.)
 
+### Nested itemize block
+
+Re:VIEW itemize blocks basically cannot express nested items. Also, none of itemize blocks allow to contain another itemize block or paragraph/image/table/list.
+
+As a workaround, Re:VIEW 4.2 provides an experimental `//beginchild` and `//endchild`. If you want to include something in an itemize block, enclose it with `//beginchild` and `//endchild`. It is also possible to create a multiple nest.
+
+```
+ * UL1
+
+//beginchild
+#@# child of UL1 start
+
+ 1. UL1-OL1
+
+//beginchild
+#@# child of UL1-OL1 start
+
+UL1-OL1-PARAGRAPH
+
+ * UL1-OL1-UL1
+ * UL1-OL1-UL2
+
+//endchild
+#@# child of UL1-OL1 end
+
+ 2. UL1-OL2
+
+ : UL1-DL1
+        UL1-DD1
+ : UL1-DL2
+        UL1-DD2
+
+//endchild
+#@# child of UL1 end
+
+ * UL2
+```
+
+Output:
+
+(In HTML:)
+
+```
+<ul>
+<li>UL1
+<ol>
+<li>UL1-OL1
+<p>UL1-OL1-PARAGRAPH</p>
+<ul>
+<li>UL1-OL1-UL1</li>
+<li>UL1-OL1-UL2</li>
+</ul>
+</li>
+
+<li>UL1-OL2</li>
+</ol>
+<dl>
+<dt>UL1-DL1</dt>
+<dd>UL1-DD1</dd>
+<dt>UL1-DL2</dt>
+<dd>UL1-DD2</dd>
+</dl>
+</li>
+
+<li>UL2</li>
+</ul>
+```
+
+(This is an experimental implementation. Names and behaviors may change in future versions.)
 
 ## Inline Commands
 
@@ -1106,13 +1185,11 @@ C
 A,B,C
 ```
 
-
 ## HTML/LaTeX Layout
 
 `layouts/layout.html.erb` and `layouts/layout.tex.erb` are used as layout file.
 You can use ERb tags in the layout files.
 
-
 Sample layout file(layout.html.erb):
 
 ```html

data/doc/makeindex.ja.md

@@ -35,7 +35,7 @@ re ファイル内に、`@<idx>` または `@<hidx>` インラインタグを使
 
 [索引]
 ひ
-表示もする索引です....1
+表示もする索引....1
 ```
 
 ```
@@ -50,7 +50,7 @@ re ファイル内に、`@<idx>` または `@<hidx>` インラインタグを使
 
 
 ひ
- 表示もする索引です....1
+ 表示しない索引....1
 ```
 
 ## 読み辞書

data/doc/quickstart.ja.md

@@ -232,8 +232,8 @@ Re:VIEW は定期的に更新されています。おおむね後方互換性を
 
 ```bash
 $ review-update
-** review-update はプロジェクトを 4.1.0 に更新します **
-config.yml: 'review_version' を '4.0' に更新しますか? [y]/n ←Enterで実行
+** review-update はプロジェクトを 5.0.0 に更新します **
+config.yml: 'review_version' を '5.0' に更新しますか? [y]/n ←Enterで実行
 Rakefile は Re:VIEW バージョンのもの (/.../review/samples/sample-book/src/Rakefile) で置き換えられます。本当に進めますか? [y]/n
 lib/tasks/review.rake は Re:VIEW バージョンのもの (/.../review/samples/sample-book/src/lib/tasks/review.rake) で置き換えられます。本当に進めますか? [y]/n
 INFO: 新しいファイル /.../sty/plistings.sty が作成されました。
@@ -249,7 +249,7 @@ INFO: 新しいファイル /.../sty/gentombow.sty が作成されました。
 
 ## クレジット
 
-Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2020年3月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
+Re:VIEW は、青木峰郎によって最初に作成されました。武藤健志がこの開発・保守を引き継ぎ、2020年10月時点では、武藤健志、高橋征義、角征典が開発・保守を継続しています。
 
 バグ・パッチの報告、その他の情報は、
 

data/doc/quickstart.md

@@ -235,8 +235,8 @@ Re:VIEW is updated regularly. We Re:VIEW team watch the backward compatibility c
 
 ```bash
 $ review-update
-** review-update updates your project to 4.1.0 **
-config.yml: Update 'review_version' to '4.0'? [y]/n
+** review-update updates your project to 5.0.0 **
+config.yml: Update 'review_version' to '5.0'? [y]/n
 Rakefile will be overridden with Re:VIEW version (/.../review/samples/sample-book/src/Rakefile). Do you really proceed? [y]/n
 lib/tasks/review.rake will be overridden with Re:VIEW version (/.../review/samples/sample-book/src/lib/tasks/review.rake). Do you really proceed? [y]/n
 INFO: new file /.../sty/plistings.sty is created.

data/lib/epubmaker/content.rb

@@ -1,6 +1,6 @@
 # = content.rb -- Content object for EPUBMaker.
 #
-# Copyright (c) 2010-2017 Kenshi Muto
+# Copyright (c) 2010-2020 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -73,11 +73,12 @@ module EPUBMaker
     # Complement other parameters by using file parameter.
     def complement
       if @id.nil?
-        @id = @file.gsub(%r{[\\/\. ]}, '-')
+        @id = @file.gsub(%r{[\\/. ]}, '-')
       end
       if @id =~ /\A[^a-z]/i
         @id = "rv-#{@id}"
       end
+      @id = CGI.escape(@id).gsub('%', '_25_')
 
       if !@file.nil? && @media.nil?
         @media = @file.sub(/.+\./, '').downcase