review 4.0.0 → 5.1.1

data/doc/quickstart.md

@@ -9,7 +9,7 @@ Re:VIEW is free software under the terms of the GNU Lesser General Public Licens
 
 This article describes how to setup Re:VIEW and use it.
 
-The supported version of the article is Re:VIEW 3.0.
+The supported version of the article is Re:VIEW 5.1.
 
 ## Set up Re:VIEW
 
@@ -59,7 +59,7 @@ $ git pull
 
 ## Writing Re:VIEW Document
 
-### Generating template fiels
+### Generating template files
 
 After setup, you can use `review-init` command to generate Re:VIEW project directory.
 
@@ -72,14 +72,23 @@ $ ls hello
 Rakefile     catalog.yml  config.yml   hello.re     images/      layouts/     sty/         style.css
 ```
 
+If your purpose is to create a PDF using TeX, it is a good idea to use the wizard mode for basic layouting in a web browser. Add `-w` option to review-init.
+
+(notice: currently wizard UI supports only Japanese language)
+
+```bash
+$ review-init -w hello
+(access http://localhost:18000 on Web browser)
+```
+
 In `hello` directory, many files are generated.
 
 * `*.re` : Re:VIEW format file.
 * config.yml : configuration file
+* config-ebook.yml : configuration file for ebook (when using the wizard mode)
 * catalog.yml : catalog file (for TOC)
 * Rakefile : rule file for `rake` command
 * images : folder for images
-* layouts : forlder for layout files
 * style.css : sample stylesheet
 * sty : style files for LaTeX
 * doc : various documents (including this document)
@@ -116,33 +125,52 @@ The web site of Re:VIEW is @<tt>{https://reviewml.org/}.
 
 You should use UTF-8 as encodings in text files.
 
-### generating PDF, EPUB, and plain-text
+### generating PDF, EPUB, plain-text, and InDesign XML
+
+To convert files in the project, use review-*maker command.
 
-You can generate a PDF file with `review-pdfmaker` command.  Also you can generate an EPUB file with `review-epubmaker` command, and can generate an plain-text file with 'review-textmaker' command.
+- review-pdfmaker: generate PDF
+- review-epubmaker: generate EPUB
+- review-textmaker: genrate plaintext
+- review-idgxmlmaker: genrate InDesign XML
 
-To generate PDF, you should install TeXLive 2012 or later.  To generate EPUB, you should install zip command.
+To generate PDF, you should install TeXLive 2012 or later. To generate EPUB, you should install zip command.
 When you want to use MathML, you should install [MathML library](http://www.hinet.mydns.jp/?mathml.rb)
 
-Each maker need `config.yml`, configuration YAML files.  `review-init` command generates `config.yml` in default.
+Each maker need `config.yml`, configuration YAML files. `review-init` command generates `config.yml` in default.
 
 ```bash
-$ review-pdfmaker config.yml     ## generate PDF
-$ review-epubmaker config.yml    ## generate EPUB
-$ review-textmaker config.yml    ## generate text with decoration
-$ review-textmaker -n config.yml ## generate text without decoration
+$ review-pdfmaker config.yml       ## generate PDF
+$ review-pdfmaker config-ebook.yml ## generate PDF (for ebook)
+$ review-epubmaker config.yml      ## generate EPUB
+$ review-textmaker config.yml      ## generate text with decoration
+$ review-textmaker -n config.yml   ## generate text without decoration
+$ review-idgxmlmaker config.yml    ## generate InDesign XML
 ```
 
 You also can generate them with Rake.
 
 ```bash
 $ rake pdf       ## generate PDF
+$ REVIEW_CONFIG_FILE=config-ebook.yml rake pdf       ## generate PDF (for ebook)
 $ rake epub      ## generate EPUB
 $ rake text      ## generate text with decoration
 $ rake plaintext ## generate text without decoration
+$ rake idgxml    ## generate InDesign XML
 ```
 
 There is a sample YAML file [config.yml.sample](https://github.com/kmuto/review/blob/master/doc/config.yml.sample) in the same directory of this document.
 
+#### generate PDF using Vivliostyle CLI
+
+Instead of using TeX (`review-pdfmaker` or `rake pdf`), you can also create a PDF use [Vivliostyle CLI](https://github.com/vivliostyle/vivliostyle-cli). Re:VIEW creates EPUB first and then converts it to PDF with Vivliostyle CLI.
+
+```bash
+$ rake vivliostyle:build    ## build PDF using Viliostyle
+$ rake vivliostyle:preview  ## preview pages in Chrome/Chromium browser
+$ rake vivliostyle          ## shortcut of vivliostyle:build
+```
+
 ### add chapters and modify them
 
 `catalog.yml` file is a catalog of Re:VIEW format files.
@@ -164,7 +192,6 @@ POSTDEF:
 
 The first item in CHAPS is the first chapter, and the second item (if you add) is the second chapter. PREDEF is for front matter, APPENDIX is for appendix, and POSTDEF is for back matter.  You can see in detail with [catalog.md](https://github.com/kmuto/review/blob/master/doc/catalog.ja.md).
 
-
 ### more information
 
 For more information about Re:VIEW format, see [format.md](https://github.com/kmuto/review/blob/master/doc/format.md).
@@ -205,17 +232,20 @@ $ review-vol
 You can also use `review-index` command to generate header list.
 
 ```bash
-$ review-index --level <heading level> -a
+$ review-index --level <heading level>
+$ review-index --level <heading level> -d  ## show volumes also
 ```
 
+review-vol and review-index can have large differences in the number of characters, lines, and pages. While review-vol only estimates from the file, review-index actually compiles and calculates.
+
 ## how to update the document folder to the new Re:VIEW version
 
-Re:VIEW is updated regularly. We Re:VIEW team watch the backward compatibility carefully, but if you want to use the features in the new version, you can use review-update command to update the document folder.
+Re:VIEW is updated regularly. We Re:VIEW team watch the backward compatibility carefully, but if you want to use the features in the new version, you can use review-update command to update the project folder.
 
 ```bash
 $ review-update
-** review-update updates your project to 3.0.0 **
-config.yml: Update 'review_version' to '3.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.
@@ -231,7 +261,7 @@ Finished.
 
 ## Copyright
 
-The original author of Re:VIEW is Minero Aoki. The current maintainer is Kenshi Muto(@kmuto), and committers are Masayoshi Takahashi and Masanori Kado (February 2019).
+The original author of Re:VIEW is Minero Aoki. The current maintainer is Kenshi Muto(@kmuto), and committers are Masayoshi Takahashi and Masanori Kado (March 2020).
 
 If you want to report bugs and patches, or to get more information, see:
 

data/lib/review.rb

@@ -1,3 +1,3 @@
-Dir["#{File.dirname(__FILE__)}/review/*.rb"].sort.each do |path|
+Dir["#{__dir__}/review/*.rb"].sort.each do |path|
   require "review/#{File.basename(path, '.rb')}"
 end

data/lib/review/book.rb

@@ -18,8 +18,8 @@ require 'review/book/index'
 
 module ReVIEW
   module Book
-    def self.load(dir)
-      Base.load(dir)
+    def self.load(_dir)
+      raise NotImplementedError, 'ReVIEW::Book.load is obsoleted. Please use ReVIEW::Book::Base.new.'
     end
   end
 end

data/lib/review/book/base.rb

@@ -9,26 +9,34 @@
 #
 require 'review/configure'
 require 'review/catalog'
+require 'review/book/bib'
 
 module ReVIEW
   module Book
     class Base
       attr_accessor :config
       attr_writer :parts
-      attr_writer :catalog
+      attr_accessor :catalog
       attr_reader :basedir
+      attr_accessor :bibpaper_index
 
-      def self.load(dir = '.')
-        new(dir)
+      def self.load(basedir = '.', config: nil)
+        new(basedir, config: config)
       end
 
-      def initialize(basedir = '.')
+      def initialize(basedir = '.', config: nil)
         @basedir = basedir
         @logger = ReVIEW.logger
         @parts = nil
         @chapter_index = nil
-        @config = ReVIEW::Configure.values
+        @config = config || ReVIEW::Configure.values
         @catalog = nil
+        @bibpaper_index = nil
+        catalog_path = filename_join(@basedir, @config['catalogfile'])
+        if catalog_path && File.file?(catalog_path)
+          parse_catalog_file(catalog_path)
+        end
+
         @warn_old_files = {} # XXX for checking CHAPS, PREDEF, POSTDEF
         @basedir_seen = {}
         update_rubyenv
@@ -44,6 +52,14 @@ module ReVIEW
         end
       end
 
+      def execute_indexer
+        return unless @catalog
+
+        parts.each do |part|
+          part.chapters.each(&:execute_indexer)
+        end
+      end
+
       def bib_file
         config['bib_file']
       end
@@ -79,7 +95,7 @@ module ReVIEW
       def page_metric
         if config['page_metric'].respond_to?(:downcase) && config['page_metric'].upcase =~ /\A[A-Z0-9_]+\Z/
           ReVIEW::Book::PageMetric.const_get(config['page_metric'].upcase)
-        elsif config['page_metric'].is_a?(Array) && config['page_metric'].size == 5
+        elsif config['page_metric'].is_a?(Array) && (config['page_metric'].size == 5 || config['page_metric'].size == 4)
           ReVIEW::Book::PageMetric.new(*config['page_metric'])
         else
           config['page_metric']
@@ -94,6 +110,30 @@ module ReVIEW
         end
       end
 
+      def create_chapter_index
+        chapter_index = ChapterIndex.new
+        each_chapter do |chap|
+          chapter_index.add_item(Index::Item.new(chap.id, chap.number, chap))
+        end
+        parts.each do |prt|
+          if prt.id.present?
+            chapter_index.add_item(Index::Item.new(prt.id, prt.number, prt))
+          end
+        end
+        chapter_index
+      end
+
+      def generate_indexes
+        if bib_exist?
+          bib = ReVIEW::Book::Bib.new(file_content: bib_content, book: self)
+          bib.generate_indexes(use_bib: true)
+          @bibpaper_index = bib.bibpaper_index
+        end
+        self.each_chapter(&:generate_indexes)
+        self.parts.map(&:generate_indexes)
+        @chapter_index = create_chapter_index
+      end
+
       def parts
         @parts ||= read_parts
       end
@@ -101,7 +141,7 @@ module ReVIEW
       def parts_in_file
         # TODO: should be `parts.find_all{|part| part.present? and part.file?}` ?
         parts.find_all do |part|
-          part if part.present? and part.file?
+          part if part.present? && part.file?
         end
       end
 
@@ -137,24 +177,19 @@ module ReVIEW
       def chapter_index
         return @chapter_index if @chapter_index
 
-        contents = chapters
-        # TODO: contents += parts.find_all { |prt| prt.id.present? }
-        parts.each do |prt|
-          if prt.id.present?
-            contents << prt
-          end
-        end
-        @chapter_index = ChapterIndex.new(contents)
+        @chapter_index = create_chapter_index
+        @chapter_index
       end
 
       def chapter(id)
-        chapter_index[id]
+        chapter_index[id].content
       end
 
       def next_chapter(chapter)
         finded = false
         each_chapter do |c|
           return c if finded
+
           if c == chapter
             finded = true
           end
@@ -166,6 +201,7 @@ module ReVIEW
         finded = false
         each_chapter_r do |c|
           return c if finded
+
           if c == chapter
             finded = true
           end
@@ -174,9 +210,7 @@ module ReVIEW
       end
 
       def volume
-        vol = Volume.sum(chapters.map(&:volume))
-        vol.page_per_kbyte = page_metric.page_per_kbyte
-        vol
+        Volume.sum(parts.map(&:volume) + chapters.map(&:volume))
       end
 
       def load_config(filename)
@@ -184,17 +218,15 @@ module ReVIEW
         @config.merge!(new_conf)
       end
 
-      def catalog
-        return @catalog if @catalog.present?
-
-        catalogfile_path = filename_join(@basedir, config['catalogfile'])
-        if File.file?(catalogfile_path)
-          @catalog = File.open(catalogfile_path, 'rt:BOM|utf-8') { |f| Catalog.new(f) }
+      def parse_catalog_file(path)
+        unless File.file?(path)
+          raise FileNotFound, "catalog.yml is not found #{path}"
         end
-        if @catalog
+
+        File.open(path, 'rt:BOM|utf-8') do |f|
+          @catalog = Catalog.new(f)
           @catalog.validate!(@config, basedir)
         end
-        @catalog
       end
 
       def read_chaps
@@ -253,6 +285,10 @@ module ReVIEW
         File.exist?(File.join(contentdir, bib_file))
       end
 
+      def bib_content
+        File.read(File.join(contentdir, bib_file))
+      end
+
       def prefaces
         if catalog
           return Part.mkpart_from_namelist(self, catalog.predef)
@@ -334,8 +370,8 @@ module ReVIEW
           end
         end
 
-        chap = read_chaps.map(&:strip).join("\n").split(/\n{2,}/).
-               map do |part_chunk|
+        # rubocop:disable Style/RedundantAssignment
+        chap = read_chaps.map(&:strip).join("\n").split(/\n{2,}/).map do |part_chunk|
           chaps = part_chunk.split.map { |chapid| Chapter.new(self, num += 1, chapid, File.join(contentdir, chapid)) }
           if part_exist? && read_part.size > part
             Part.new(self, part += 1, chaps, read_part[part - 1])
@@ -343,6 +379,8 @@ module ReVIEW
             Part.new(self, nil, chaps)
           end
         end
+        # rubocop:enable Style/RedundantAssignment
+
         chap
       end
 
@@ -356,7 +394,8 @@ module ReVIEW
         res = ''
         File.open(filename_join(@basedir, filename), 'rt:BOM|utf-8') do |f|
           f.each_line do |line|
-            next if /\A#/ =~ line
+            next if line.start_with?('#')
+
             line.gsub!(/#.*\Z/, '')
             res << line
           end

data/lib/review/book/bib.rb

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2009-2020 Minero Aoki, Kenshi Muto
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+require 'review/book/book_unit'
+require 'review/lineinput'
+require 'review/preprocessor'
+
+module ReVIEW
+  module Book
+    class Bib < BookUnit
+      def number
+        nil
+      end
+    end
+  end
+end

data/lib/review/book/book_unit.rb

@@ -0,0 +1,158 @@
+# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+#               2002-2008 Minero Aoki
+#
+# This program is free software.
+# You can distribute or modify this program under the terms of
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+require 'review/textutils'
+require 'review/index_builder'
+
+module ReVIEW
+  module Book
+    class BookUnit
+      include TextUtils
+      attr_reader :book
+      attr_reader :path
+      attr_reader :lines
+      attr_accessor :content
+
+      attr_reader :list_index, :table_index, :equation_index, :footnote_index,
+                  :numberless_image_index, :image_index, :icon_index, :indepimage_index,
+                  :headline_index, :column_index
+
+      def initialize(file_content: nil, book: nil)
+        if book
+          @book = book
+        end
+        if file_content
+          @content = file_content
+        end
+        if @content
+          @lines = @content.lines
+        end
+      end
+
+      def execute_indexer(force: false)
+        if @index_builder && !force
+          return @index_builder
+        end
+
+        @index_builder = ReVIEW::IndexBuilder.new
+        compiler = ReVIEW::Compiler.new(@index_builder)
+        compiler.compile(self)
+        @index_builder
+      end
+
+      def generate_indexes(use_bib: false)
+        return unless content
+
+        @lines = content.lines
+
+        @indexes = execute_indexer
+
+        @list_index = @indexes.list_index
+        @table_index = @indexes.table_index
+        @equation_index = @indexes.equation_index
+        @footnote_index = @indexes.footnote_index
+        @headline_index = @indexes.headline_index
+        @column_index = @indexes.column_index
+        if use_bib
+          @book.bibpaper_index = @indexes.bibpaper_index
+        end
+      end
+
+      def dirname
+        @path && File.dirname(@path)
+      end
+
+      def basename
+        @path && File.basename(@path)
+      end
+
+      def name
+        @name && File.basename(@name, '.*')
+      end
+
+      alias_method :id, :name
+
+      def title
+        return @title if @title
+
+        @title = ''
+        return @title unless content
+
+        content.each_line do |line|
+          if line =~ /\A=+/
+            @title = line.sub(/\A=+(\[.+?\])?(\{.+?\})?/, '').strip
+            break
+          end
+        end
+        @title
+      end
+
+      def size
+        content.size
+      end
+
+      def volume
+        @volume ||= Volume.count_file(path)
+      end
+
+      def list(id)
+        list_index[id]
+      end
+
+      def table(id)
+        table_index[id]
+      end
+
+      def equation(id)
+        equation_index[id]
+      end
+
+      def footnote(id)
+        footnote_index[id]
+      end
+
+      def image(id)
+        return image_index[id] if image_index.key?(id)
+        return icon_index[id] if icon_index.key?(id)
+        return numberless_image_index[id] if numberless_image_index.key?(id)
+
+        indepimage_index[id]
+      end
+
+      def bibpaper(id)
+        bibpaper_index[id]
+      end
+
+      def bibpaper_index
+        raise FileNotFound, "no such bib file: #{@book.bib_file}" unless @book.bib_exist?
+
+        @book.bibpaper_index
+      end
+
+      def headline(caption)
+        headline_index[caption]
+      end
+
+      def column(id)
+        column_index[id]
+      end
+
+      def next_chapter
+        book.next_chapter(self)
+      end
+
+      def prev_chapter
+        book.prev_chapter(self)
+      end
+
+      def image_bound?(item_id)
+        image(item_id).path
+      end
+    end
+  end
+end