review 5.2.0 → 5.3.0

data/lib/review/index_builder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,
 #                         KADO Masanori
 #
 # This program is free software.
@@ -13,7 +13,8 @@ require 'review/sec_counter'
 
 module ReVIEW
   class IndexBuilder < Builder
-    attr_reader :list_index, :table_index, :equation_index, :footnote_index,
+    attr_reader :list_index, :table_index, :equation_index,
+                :footnote_index, :endnote_index,
                 :numberless_image_index, :image_index, :icon_index, :indepimage_index,
                 :headline_index, :column_index, :bibpaper_index
 
@@ -53,11 +54,16 @@ module ReVIEW
     def builder_init_file
       super
       @headline_stack = []
+      @crossref = {
+        footnote: {},
+        endnote: {}
+      }
 
       @list_index = ReVIEW::Book::ListIndex.new
       @table_index = ReVIEW::Book::TableIndex.new
       @equation_index = ReVIEW::Book::EquationIndex.new
       @footnote_index = ReVIEW::Book::FootnoteIndex.new
+      @endnote_index = ReVIEW::Book::EndnoteIndex.new
       @headline_index = ReVIEW::Book::HeadlineIndex.new(@chapter)
       @column_index = ReVIEW::Book::ColumnIndex.new
       @chapter_index = ReVIEW::Book::ChapterIndex.new
@@ -73,6 +79,14 @@ module ReVIEW
     private :builder_init_file
 
     def result
+      %i[footnote endnote].each do |name|
+        @crossref[name].each_pair do |k, v|
+          if v == 0
+            warn "#{@chapter.basename}: #{name} ID #{k} is not referred."
+          end
+        end
+      end
+
       nil
     end
 
@@ -100,6 +114,7 @@ module ReVIEW
 
       item = ReVIEW::Book::Index::Item.new(item_id, @sec_counter.number_list, caption)
       @headline_index.add_item(item)
+      compile_inline(caption)
     end
 
     def nonum_begin(level, label, caption)
@@ -247,56 +262,73 @@ module ReVIEW
 
     alias_method :lead, :read
 
-    def list(_lines, id, _caption, _lang = nil)
+    def list(lines, id, caption, _lang = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @list_index.size + 1)
       @list_index.add_item(item)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def source(_lines, _caption = nil, _lang = nil)
+    def source(lines, caption = nil, _lang = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def listnum(_lines, id, _caption, _lang = nil)
+    def listnum(lines, id, caption, _lang = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @list_index.size + 1)
       @list_index.add_item(item)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def emlist(lines, caption = nil, lang = nil)
+    def emlist(lines, caption = nil, _lang = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def emlistnum(lines, caption = nil, lang = nil)
+    def emlistnum(lines, caption = nil, _lang = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
     def cmd(lines, caption = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
     def quote(lines)
+      lines.each { |line| compile_inline(line) }
     end
 
     def image(_lines, id, caption, _metric = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @image_index.size + 1, caption)
       @image_index.add_item(item)
+      compile_inline(caption)
     end
 
-    def table(_lines, id = nil, caption = nil)
+    def table(lines, id = nil, caption = nil)
       check_id(id)
       if id
         item = ReVIEW::Book::Index::Item.new(id, @table_index.size + 1, caption)
         @table_index.add_item(item)
       end
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
-    def emtable(_lines, _caption = nil)
+    def emtable(_lines, caption = nil)
       # item = ReVIEW::Book::TableIndex::Item.new(id, @table_index.size + 1)
       # @table_index << item
+      compile_inline(caption)
     end
 
     def comment(lines, comment = nil)
     end
 
-    def imgtable(_lines, id, _caption = nil, _metric = nil)
+    def imgtable(_lines, id, caption = nil, _metric = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @table_index.size + 1)
       @table_index.add_item(item)
@@ -304,24 +336,37 @@ module ReVIEW
       ## to find image path
       item = ReVIEW::Book::Index::Item.new(id, @indepimage_index.size + 1)
       @indepimage_index.add_item(item)
+      compile_inline(caption)
     end
 
     def footnote(id, str)
       check_id(id)
+      @crossref[:footnote][id] ||= 0
       item = ReVIEW::Book::Index::Item.new(id, @footnote_index.size + 1, str)
       @footnote_index.add_item(item)
+      compile_inline(str)
     end
 
-    def indepimage(_lines, id, _caption = '', _metric = nil)
+    def endnote(id, str)
+      check_id(id)
+      @crossref[:endnote][id] ||= 0
+      item = ReVIEW::Book::Index::Item.new(id, @endnote_index.size + 1, str)
+      @endnote_index.add_item(item)
+      compile_inline(str)
+    end
+
+    def indepimage(_lines, id, caption = '', _metric = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @indepimage_index.size + 1)
       @indepimage_index.add_item(item)
+      compile_inline(caption)
     end
 
-    def numberlessimage(_lines, id, _caption = '', _metric = nil)
+    def numberlessimage(_lines, id, caption = '', _metric = nil)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @indepimage_index.size + 1)
       @indepimage_index.add_item(item)
+      compile_inline(caption)
     end
 
     def hr
@@ -334,10 +379,12 @@ module ReVIEW
     def blankline
     end
 
-    def flushright(_lines)
+    def flushright(lines)
+      lines.each { |line| compile_inline(line) }
     end
 
     def centering(lines)
+      lines.each { |line| compile_inline(line) }
     end
 
     def olnum(_num)
@@ -346,12 +393,16 @@ module ReVIEW
     def pagebreak
     end
 
-    def bpo(_lines)
+    def bpo(lines)
+      lines.each { |line| compile_inline(line) }
     end
 
     def noindent
     end
 
+    def printendnotes
+    end
+
     def compile_inline(s)
       @compiler.text(s)
     end
@@ -388,7 +439,13 @@ module ReVIEW
       ''
     end
 
-    def inline_fn(_id)
+    def inline_fn(id)
+      @crossref[:footnote][id] = @crossref[:footnote][id] ? @crossref[:footnote][id] + 1 : 1
+      ''
+    end
+
+    def inline_endnote(id)
+      @crossref[:endnote][id] = @crossref[:endnote][id] ? @crossref[:endnote][id] + 1 : 1
       ''
     end
 
@@ -464,10 +521,12 @@ module ReVIEW
       ''
     end
 
-    def bibpaper(_lines, id, caption)
+    def bibpaper(lines, id, caption)
       check_id(id)
       item = ReVIEW::Book::Index::Item.new(id, @bibpaper_index.size + 1, caption)
       @bibpaper_index.add_item(item)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
     end
 
     def inline_hd(_id)
@@ -602,12 +661,13 @@ module ReVIEW
       # ignore in indexing
     end
 
-    def texequation(_lines, id = nil, _caption = '')
+    def texequation(_lines, id = nil, caption = '')
       check_id(id)
       if id
         item = ReVIEW::Book::Index::Item.new(id, @equation_index.size + 1)
         @equation_index.add_item(item)
       end
+      compile_inline(caption)
     end
 
     def get_chap(_chapter = nil)
@@ -618,10 +678,16 @@ module ReVIEW
       ''
     end
 
-    def captionblock(_type, _lines, _caption, _specialstyle = nil)
+    def captionblock(_type, lines, caption, _specialstyle = nil)
+      compile_inline(caption)
+      lines.each { |line| compile_inline(line) }
       ''
     end
 
+    def graph(lines, id, _command, caption = '')
+      image(lines, id, caption)
+    end
+
     def tsize(_str)
       ''
     end

data/lib/review/latexbuilder.rb

@@ -98,6 +98,8 @@ module ReVIEW
     private :puts
 
     def result
+      check_printendnotes
+
       if @chapter.is_a?(ReVIEW::Book::Part) && !@book.config.check_version('2', exception: false)
         puts '\end{reviewpart}'
       end
@@ -1151,6 +1153,19 @@ module ReVIEW
       app_error "unknown footnote: #{id}"
     end
 
+    def inline_endnote(id)
+      macro('endnote', compile_inline(@chapter.endnote(id).content.strip))
+    rescue KeyError
+      app_error "unknown footnote: #{id}"
+    end
+
+    def printendnotes
+      @shown_endnotes = true
+      blank
+      puts '\theendnotes'
+      blank
+    end
+
     BOUTEN = '・'.freeze
 
     def inline_bou(str)
@@ -1345,7 +1360,7 @@ module ReVIEW
     end
 
     def inline_tcy(str)
-      macro('rensuji', escape(str))
+      macro('reviewtcy', escape(str))
     end
 
     def inline_balloon(str)

data/lib/review/markdownbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2013-2020 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
+# Copyright (c) 2013-2021 KADO Masanori, Masayoshi Takahashi, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -98,7 +98,7 @@ module ReVIEW
     end
 
     def ul_item_begin(lines)
-      puts '  ' * (@ul_indent - 1) + '* ' + join_lines_to_paragraph(lines)
+      puts ('  ' * (@ul_indent - 1)) + '* ' + join_lines_to_paragraph(lines)
     end
 
     def ul_item_end
@@ -361,6 +361,14 @@ module ReVIEW
       "[^#{id}]"
     end
 
+    def inline_endnote(id)
+      "<sup>#{I18n.t('html_endnote_refmark', @chapter.endnote(id).number)}</sup>"
+    end
+
+    def endnote_item(id)
+      puts "#{I18n.t('html_endnote_textmark', @chapter.endnote(id).number)}#{compile_inline(@chapter.endnote(id).content)}"
+    end
+
     def inline_br(_str)
       "\n"
     end

data/lib/review/pdfmaker.rb

@@ -318,12 +318,16 @@ module ReVIEW
     end
 
     def make_custom_page(file)
+      if file.nil?
+        return nil
+      end
+
       file_sty = file.to_s.sub(/\.[^.]+\Z/, '.tex')
       if File.exist?(file_sty)
-        return File.read(file_sty)
+        File.read(file_sty)
+      else
+        warn "File #{file_sty} is not found."
       end
-
-      nil
     end
 
     def join_with_separator(value, sep)
@@ -442,6 +446,10 @@ module ReVIEW
           end
       end
 
+      if @config['coverimage'] && !File.exist?(File.join(@config['imagedir'], @config['coverimage']))
+        raise ReVIEW::ConfigError, "coverimage #{@config['coverimage']} is not found."
+      end
+
       @locale_latex = {}
       part_tuple = I18n.get('part').split(/%[A-Za-z]{1,3}/, 2)
       chapter_tuple = I18n.get('chapter').split(/%[A-Za-z]{1,3}/, 2)
@@ -486,6 +494,13 @@ module ReVIEW
         template_path = 'layouts/layout.tex.erb'
       end
       ReVIEW::Template.generate(path: template_path, mode: '-', binding: binding, template_dir: template_dir)
+    rescue => e
+      if defined?(e.full_message)
+        error! "template or configuration error: #{e.full_message(highlight: false)}"
+      else
+        # <= Ruby 2.4
+        error! "template or configuration error: #{e.message}"
+      end
     end
 
     def copy_sty(dirname, copybase, extname = 'sty')

data/lib/review/plaintextbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2018-2020 Kenshi Muto
+# Copyright (c) 2018-2021 Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -74,6 +74,7 @@ module ReVIEW
     private :blank
 
     def result
+      check_printendnotes
       solve_nest(@output.string)
     end
 
@@ -89,7 +90,7 @@ module ReVIEW
           clevel.pop
           lines.push("\x01→END←\x01")
         else
-          lines.push("\t" * clevel.size + l)
+          lines.push(("\t" * clevel.size) + l)
         end
       end
 

data/lib/review/rstbuilder.rb

@@ -86,6 +86,7 @@ module ReVIEW
     private :blank
 
     def result
+      check_printendnotes
       solve_nest(@output.string)
     end
 
@@ -124,7 +125,7 @@ module ReVIEW
     end
 
     def ul_item(lines)
-      puts '  ' * (@ul_indent - 1) + "* #{join_lines_to_paragraph(lines)}"
+      puts ('  ' * (@ul_indent - 1)) + "* #{join_lines_to_paragraph(lines)}"
     end
 
     def ul_end
@@ -138,7 +139,7 @@ module ReVIEW
     end
 
     def ol_item(lines, _num)
-      puts '  ' * (@ol_indent - 1) + "#. #{join_lines_to_paragraph(lines)}"
+      puts ('  ' * (@ol_indent - 1)) + "#. #{join_lines_to_paragraph(lines)}"
     end
 
     def ol_end
@@ -367,6 +368,14 @@ module ReVIEW
       " [##{id.sub(' ', '_')}]_ "
     end
 
+    def inline_endnote(id)
+      " [(#{@chapter.endnote(id).number})]_ "
+    end
+
+    def endnote_item(id)
+      puts ".. [(#{@chapter.endnote(id).number})] #{compile_inline(@chapter.endnote(id).content)}"
+    end
+
     def compile_ruby(base, ruby)
       " :ruby:`#{base}`<#{ruby}>`_ "
     end

data/lib/review/textutils.rb

@@ -15,7 +15,7 @@ module ReVIEW
       add = 0
       len = nil
       str.gsub("\t") do
-        len = ts - ($`.size + add) % ts
+        len = ts - (($`.size + add) % ts)
         add += len - 1
         ' ' * len
       end
@@ -72,12 +72,13 @@ module ReVIEW
         end
 
         # lazy than rule 3, but it looks better
-        if lazy &&
-           (%i[F W H].include?(Unicode::Eaw.property(tail)) &&
-            tail !~ /\p{Hangul}/) ||
-           (%i[F W H].include?(Unicode::Eaw.property(head)) &&
-            head !~ /\p{Hangul}/)
-          space = nil
+        if lazy
+          if (%i[F W H].include?(Unicode::Eaw.property(tail)) &&
+              tail !~ /\p{Hangul}/) ||
+             (%i[F W H].include?(Unicode::Eaw.property(head)) &&
+              head !~ /\p{Hangul}/)
+            space = nil
+          end
         end
       end
       space

data/lib/review/tocprinter.rb

@@ -69,12 +69,17 @@ module ReVIEW
 
     def execute(*args)
       parse_options(args)
-      @config = ReVIEW::Configure.create(yamlfile: @yamlfile)
-      @book = ReVIEW::Book::Base.new('.', config: @config)
-      unless File.readable?(@yamlfile)
-        @logger.error("No such fiile or can't open #{@yamlfile}.")
+      begin
+        @config = ReVIEW::Configure.create(yamlfile: @yamlfile)
+        @book = ReVIEW::Book::Base.new('.', config: @config)
+        unless File.readable?(@yamlfile)
+          raise ReVIEW::FileNotFound, "No such fiile or can't open #{@yamlfile}."
+        end
+      rescue ReVIEW::ConfigError, ReVIEW::FileNotFound, ReVIEW::CompileError, ReVIEW::ApplicationError => e
+        @logger.error e.message
         exit 1
       end
+
       I18n.setup(@config['language'])
 
       if @detail
@@ -226,9 +231,9 @@ module ReVIEW
 
       case mode
       when :list
-        (calc_linesize(line) - 1) / @book.page_metric.list.n_columns + 1
+        ((calc_linesize(line) - 1) / @book.page_metric.list.n_columns) + 1
       else # mode == :text
-        (calc_linesize(line) - 1) / @book.page_metric.text.n_columns + 1
+        ((calc_linesize(line) - 1) / @book.page_metric.text.n_columns) + 1
       end
     end
 

data/lib/review/topbuilder.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2008-2020 Minero Aoki, Kenshi Muto
+# Copyright (c) 2008-2021 Minero Aoki, Kenshi Muto
 #               2002-2006 Minero Aoki
 #
 # This program is free software.
@@ -290,6 +290,24 @@ module ReVIEW
       app_error "unknown footnote: #{id}"
     end
 
+    def inline_endnote(id)
+      "【後注#{@chapter.endnote(id).number}】"
+    rescue KeyError
+      app_error "unknown endnote: #{id}"
+    end
+
+    def endnote_begin
+      puts '◆→開始:後注←◆'
+    end
+
+    def endnote_end
+      puts '◆→終了:後注←◆'
+    end
+
+    def endnote_item(id)
+      puts "【後注#{@chapter.endnote(id).number}】#{compile_inline(@chapter.endnote(id).content)}"
+    end
+
     def compile_ruby(base, ruby)
       "#{base}◆→DTP連絡:「#{base}」に「#{ruby}」とルビ←◆"
     end

data/lib/review/version.rb

@@ -1,3 +1,3 @@
 module ReVIEW
-  VERSION = '5.2.0'.freeze
+  VERSION = '5.3.0'.freeze
 end

data/lib/review/volumeprinter.rb

@@ -27,15 +27,15 @@ module ReVIEW
 
     def execute(*args)
       parse_options(args)
-      @config = ReVIEW::Configure.create(yamlfile: @yamlfile)
-      @book = ReVIEW::Book::Base.new('.', config: @config)
-      unless File.readable?(@yamlfile)
-        @logger.error("No such fiile or can't open #{@yamlfile}.")
-        exit 1
-      end
-      I18n.setup(@book.config['language'])
-
       begin
+        @config = ReVIEW::Configure.create(yamlfile: @yamlfile)
+        @book = ReVIEW::Book::Base.new('.', config: @config)
+        unless File.readable?(@yamlfile)
+          raise ReVIEW::FileNotFound, "No such fiile or can't open #{@yamlfile}."
+        end
+
+        I18n.setup(@book.config['language'])
+
         @book.each_part do |part|
           if part.number
             print_chapter_volume(part)
@@ -44,7 +44,7 @@ module ReVIEW
             print_chapter_volume(chap)
           end
         end
-      rescue ReVIEW::FileNotFound, ReVIEW::CompileError, ReVIEW::ApplicationError => e
+      rescue ReVIEW::ConfigError, ReVIEW::FileNotFound, ReVIEW::CompileError, ReVIEW::ApplicationError => e
         @logger.error e.message
         exit 1
       end

data/samples/syntax-book/ch02.re

@@ -254,6 +254,12 @@ Tips。@<b>{太字bold}@<i>{italicイタ}@<tt>{等幅code}
 
 #@# doorquote、bpo、talk、graph、address、box、linebreak、pagebreak、hr、comment、abbr、acronym、dfn、kbd、q、samp、var、big、small、del、ins、recipe、dtp、raw、embed、include
 
+== 後注
+後注は脚注と同様の書式で、@<tt>{//endnote}で内容@<endnote>{end1}、@<tt>{@}@<tt>{<endnote>}で参照します@<endnote>{end2}。後注は@<tt>{//printendnotes}を書いた箇所にまとめて書き出されます。ここではファイル末尾に置いています。
+
+//endnote[end1][後注その1です。]
+//endnote[end2][後注その2です。]
+
 == LaTeX式
 LaTeX式はTeX紙面以外は保証されません。EPUBではMathML（@<tt>{math_format: mathml}）を使えますが、表現や互換性が不足しており、LaTeXをバックエンドとして画像化する@<tt>{math_format: imgmath}のほうがよさそうです。
 
@@ -361,3 +367,6 @@ labelで定義したラベルへの参照の例です。EPUBだと@<href>{#inlin
 @<hidx>{|}@<hidx>{{}@<hidx>$}$
 
 idx, hidxいずれも=見出しの中には入れないようにし、後続の段落先頭にhidxで入れるように注意します（入れてしまうと目次などがおかしくなります）。
+
+==== 後注
+//printendnotes

data/templates/latex/config.erb

@@ -124,6 +124,9 @@
   \ifdefined\reviewchapref\else% for 5.1.0 compatibility
     \newcommand{\reviewchapref}[2]{\hyperref[##2]{##1}}
   \fi
+  \ifdefined\reviewtcy\else% for 5.3.0 compatibility
+    \DeclareRobustCommand{\reviewtcy}[1]{\rensuji{##1}}
+  \fi
 }
 
 \makeatother

data/templates/latex/review-jlreq/review-base.sty

@@ -1,4 +1,4 @@
-\ProvidesClass{review-base}[2021/06/28]
+\ProvidesClass{review-base}[2021/09/06]
 % jlreq用基本設定
 \def\recls@tmp{luatex}\ifx\recls@tmp\recls@driver
   \hypersetup{
@@ -186,6 +186,7 @@
 \DeclareRobustCommand{\reviewunderline}[1]{\underline{#1}}% ulemかjumolineで上書き。デフォルトはulemにしている
 \DeclareRobustCommand{\reviewit}[1]{\textit{#1}}
 \DeclareRobustCommand{\reviewbold}[1]{\textbf{#1}}
+\DeclareRobustCommand{\reviewtcy}[1]{\tatechuyoko{#1}}
 
 % allow break line in tt
 % contributed by @zr_tex8r