review 1.3.0 → 1.4.0

data/lib/review/i18n.yml

@@ -17,6 +17,17 @@ ja:
   ruby_prefix: "（"
   ruby_postfix: "）"
   aut: "著　者"
+  csl: "監　修"
+  dsr: "デザイン"
+  ill: "イラスト"
+  cov: "表　紙"
+  edt: "編　集"
+  pht: "撮　影"
+  trl: "翻　訳"
+  ## XXX Backward Compatibility: `prt` should be "印刷所"
+  prt: "発行所"
+  pbl: "発行所"
+  contact: "連絡先"
   author_postfix: "　著"
   supervisor_postfix: "　監修"
   translator_postfix: "　訳"
@@ -39,6 +50,16 @@ en:
   caption_prefix_idgxml: "　"
   ruby_prefix: "("
   ruby_postfix: ")"
+  aut: "Author"
+  csl: "Consultant"
+  dsr: "Design"
+  ill: "Illustrator"
+  edt: "Editor"
+  pht: "Photographer"
+  trl: "Translator"
+  prt: "Printer"
+  pbl: "Publisher"
+  contact: "Contact"
   names_splitter: ", "
 
 zh_TW:

data/lib/review/idgxmlbuilder.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 #
 # Copyright (c) 2002-2007 Minero Aoki
-#               2008-2012 Minero Aoki, Kenshi Muto
+#               2008-2014 Minero Aoki, Kenshi Muto
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -160,7 +160,7 @@ module ReVIEW
           placeholder = if @chapter.is_a? ReVIEW::Book::Part
                           level = 0
                           'part'
-                        elsif @chapter.on_POSTDEF?
+                        elsif @chapter.on_APPENDIX?
                           'appendix'
                         else
                           'chapter'
@@ -181,7 +181,7 @@ module ReVIEW
         @section += 1
         print %Q(<sect id="sect:#{@chapter.number}.#{@section}">) unless @secttags.nil?
         if @book.config["secnolevel"] >= 2
-          if @chapter.number.blank? or @chapter.on_POSTDEF?
+          if @chapter.number.blank? or @chapter.on_APPENDIX?
             prefix = ""
           else
             prefix = "#{@chapter.number}.#{@section}#{I18n.t("chapter_postfix")}"
@@ -201,7 +201,7 @@ module ReVIEW
         @subsection += 1
         print %Q(<sect2 id="sect:#{@chapter.number}.#{@section}.#{@subsection}">) unless @secttags.nil?
         if @book.config["secnolevel"] >= 3
-          if @chapter.number.blank? or @chapter.on_POSTDEF?
+          if @chapter.number.blank? or @chapter.on_APPENDIX?
             prefix = ""
           else
             prefix = "#{@chapter.number}.#{@section}.#{@subsection}#{I18n.t("chapter_postfix")}"
@@ -219,7 +219,7 @@ module ReVIEW
         @subsubsection += 1
         print %Q(<sect3 id="sect:#{@chapter.number}.#{@section}.#{@subsection}.#{@subsubsection}">) unless @secttags.nil?
         if @book.config["secnolevel"] >= 4
-          if @chapter.number.blank? or @chapter.on_POSTDEF?
+          if @chapter.number.blank? or @chapter.on_APPENDIX?
             prefix = ""
           else
             prefix = "#{@chapter.number}.#{@section}.#{@subsection}.#{@subsubsection}#{I18n.t("chapter_postfix")}"
@@ -235,7 +235,7 @@ module ReVIEW
         @subsubsubsection += 1
         print %Q(<sect4 id="sect:#{@chapter.number}.#{@section}.#{@subsection}.#{@subsubsection}.#{@subsubsubsection}">) unless @secttags.nil?
         if @book.config["secnolevel"] >= 5
-          if @chapter.number.blank? or @chapter.on_POSTDEF?
+          if @chapter.number.blank? or @chapter.on_APPENDIX?
             prefix = ""
           else
             prefix = "#{@chapter.number}.#{@section}.#{@subsection}.#{@subsubsection}.#{@subsubsubsection}#{I18n.t("chapter_postfix")}"
@@ -518,6 +518,7 @@ module ReVIEW
       print %Q[</pre>]
       image_header id, caption
       puts "</img>"
+      warn "no such image: #{id}"
     end
 
     def image_header(id, caption)
@@ -1069,7 +1070,7 @@ module ReVIEW
       rescue
         warn %Q[no such image: #{id}]
       end
-      puts %Q[<caption>#{compile_inline(caption)}</caption>] if !caption.nil? && !caption.empty?
+      puts %Q[<caption>#{compile_inline(caption)}</caption>] if caption.present?
       puts "</img>"
     end
 
@@ -1156,10 +1157,11 @@ module ReVIEW
     end
 
     def inline_title(id)
+      title = super
       if @book.config["chapterlink"]
-        %Q(<link href="#{id}">#{@chapter.env.chapter_index.title(id)}</link>)
+        %Q(<link href="#{id}">#{title}</link>)
       else
-        @chapter.env.chapter_index.title(id)
+        title
       end
     rescue KeyError
       error "unknown chapter: #{id}"

data/lib/review/latexbuilder.rb

@@ -603,10 +603,11 @@ module ReVIEW
     end
 
     def inline_title(id)
+      title = super
       if @book.config["chapterlink"]
-        "\\hyperref[chap:#{id}]{#{@chapter.env.chapter_index.title(id)}}"
+        "\\hyperref[chap:#{id}]{#{title}}"
       else
-        @chapter.env.chapter_index.title(id)
+        title
       end
     rescue KeyError
       error "unknown chapter: #{id}"

data/lib/review/{review.tex.erb → layout.tex.erb}

@@ -157,7 +157,6 @@
  }
 
 \newcommand{\reviewcolophon}[0]{%
-  \backmatter
   \clearpage}
 \newcommand{\reviewappendix}[0]{%
   \appendix}
@@ -227,7 +226,16 @@
 <%= values["chap_str"] %>
 \renewcommand{\chaptermark}[1]{\markboth{\appendixname\thechapter~#1}{}}
 \reviewappendix
+<%= values["appendix_str"] %>
+
+%% backmatter begins
+<% if values["post_str"] or values["colophon"] %>
+\backmatter
+<% end %>
+
+<% if values["post_str"] %>
 <%= values["post_str"] %>
+<% end %>
 
 <% if values["colophon"] %>
 %% okuduke

data/lib/review/markdownbuilder.rb

@@ -15,6 +15,12 @@ module ReVIEW
       '.md'
     end
 
+    def builder_init_file
+      @ul_indent = 0
+      @chapter.book.image_types = %w( .png .jpg .jpeg .gif .svg )
+    end
+    private :builder_init_file
+
     def puts(str)
       @blank_seen = false
       super
@@ -26,8 +32,10 @@ module ReVIEW
     end
 
     def headline(level, label, caption)
+      blank
       prefix = "#" * level
       puts "#{prefix} #{caption}"
+      blank
     end
 
     def quote(lines)
@@ -42,15 +50,24 @@ module ReVIEW
     end
 
     def ul_begin
-      blank
+      blank if @ul_indent == 0
+      @ul_indent += 1
     end
 
     def ul_item(lines)
-      puts "- #{lines.join}"
+      puts "  " * (@ul_indent - 1) + "* " + "#{lines.join}"
+    end
+
+    def ul_item_begin(lines)
+      puts "  " * (@ul_indent - 1) + "* " + "#{lines.join}"
+    end
+
+    def ul_item_end
     end
 
     def ul_end
-      blank
+      @ul_indent -= 1
+      blank if @ul_indent == 0
     end
 
     def ol_begin
@@ -67,6 +84,9 @@ module ReVIEW
 
     def emlist(lines, caption = nil)
       blank
+      if caption
+        puts caption
+      end
       puts "```"
       lines.each do |line|
         puts detab(line)
@@ -104,9 +124,14 @@ module ReVIEW
       "`#{str}`"
     end
 
+    def inline_tt(str)
+      "`#{str}`"
+    end
+
+
     def image_image(id, caption, metric)
       blank
-      puts "![#{caption}](/images/#{id}.#{image_ext})"
+      puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(/\A\.\//, "")})"
       blank
     end
 
@@ -121,6 +146,12 @@ module ReVIEW
       nofunc_text("[UnknownImage:#{id}]")
     end
 
+    def indepimage(id, caption="", metric=nil)
+      blank
+      puts "![#{compile_inline(caption)}](#{@chapter.image(id).path.sub(/\A\.\//, "")})"
+      blank
+    end
+
     def pagebreak
       puts "{pagebreak}"
     end
@@ -129,6 +160,97 @@ module ReVIEW
       "jpg"
     end
 
+    def cmd(lines)
+      puts "```"
+      lines.each do |line|
+        puts detab(line)
+      end
+      puts "```"
+    end
+
+    def table(lines, id = nil, caption = nil)
+      rows = []
+      sepidx = nil
+      lines.each_with_index do |line, idx|
+        if /\A[\=\-]{12}/ =~ line
+          # just ignore
+          #error "too many table separator" if sepidx
+          sepidx ||= idx
+          next
+        end
+        rows.push line.strip.split(/\t+/).map {|s| s.sub(/\A\./, '') }
+      end
+      rows = adjust_n_cols(rows)
+
+      begin
+        table_header id, caption unless caption.nil?
+      rescue KeyError
+        error "no such table: #{id}"
+      end
+      table_begin rows.first.size
+      return if rows.empty?
+      if sepidx
+        sepidx.times do
+          tr rows.shift.map {|s| th(s) }
+        end
+        table_border rows.first.size
+        rows.each do |cols|
+          tr cols.map {|s| td(s) }
+        end
+      else
+        rows.each do |cols|
+          h, *cs = *cols
+          tr [th(h)] + cs.map {|s| td(s) }
+        end
+      end
+      table_end
+    end
+
+    def table_header(id, caption)
+      if get_chap.nil?
+        puts %Q[#{I18n.t("table")}#{I18n.t("format_number_header_without_chapter", [@chapter.table(id).number])}#{I18n.t("caption_prefix")}#{compile_inline(caption)}]
+      else
+        puts %Q[#{I18n.t("table")}#{I18n.t("format_number_header", [get_chap, @chapter.table(id).number])}#{I18n.t("caption_prefix")}#{compile_inline(caption)}]
+      end
+      blank
+    end
+
+    def table_begin(ncols)
+    end
+
+    def tr(rows)
+      puts "|#{rows.join("|")}|"
+    end
+
+    def table_border(ncols)
+      puts (0..ncols).map{"|"}.join(":--")
+    end
+
+    def th(str)
+      "#{str}"
+    end
+
+    def td(str)
+      "#{str}"
+    end
+
+    def table_end
+      blank
+    end
+
+    def footnote(id, str)
+      puts "[^#{id}]: #{compile_inline(str)}"
+      blank
+    end
+
+    def inline_fn(id)
+      "[^#{id}]"
+    end
+
+    def inline_br(str)
+      "\n"
+    end
+
     def nofunc_text(str)
       str
     end

data/lib/review/pdfmaker.rb

@@ -0,0 +1,291 @@
+# encoding: utf-8
+#
+# 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
+# the GNU LGPL, Lesser General Public License version 2.1.
+# For details of the GNU LGPL, see the file "COPYING".
+#
+require 'optparse'
+require 'yaml'
+require 'fileutils'
+require 'erb'
+
+require 'review'
+require 'review/i18n'
+
+
+module ReVIEW
+  class PDFMaker
+
+    include FileUtils
+    include ReVIEW::LaTeXUtils
+
+    def error(msg)
+      $stderr.puts "#{File.basename($0, '.*')}: error: #{msg}"
+      exit 1
+    end
+
+    def warn(msg)
+      $stderr.puts "#{File.basename($0, '.*')}: warning: #{msg}"
+    end
+
+    def check_book(config)
+      pdf_file = config["bookname"]+".pdf"
+      if File.exist? pdf_file
+        error "file already exists:#{pdf_file}"
+      end
+    end
+
+    def build_path(config)
+      "./#{config["bookname"]}-pdf"
+    end
+
+    def check_compile_status(ignore_errors)
+      return unless @compile_errors
+
+      if ignore_errors
+        $stderr.puts "compile error, but try to generate PDF file"
+      else
+        error "compile error, No PDF file output."
+      end
+    end
+
+    def self.execute(*args)
+      self.new.execute(*args)
+    end
+
+    def parse_opts(args)
+      cmd_config = Hash.new
+      opts = OptionParser.new
+
+      opts.banner = "Usage: review-pdfmaker configfile"
+      opts.version = ReVIEW::VERSION
+      opts.on('--help', 'Prints this message and quit.') do
+        puts opts.help
+        exit 0
+      end
+      opts.on('--[no-]debug', 'Keep temporary files.') do |debug|
+        cmd_config["debug"] = debug
+      end
+      opts.on('--ignore-errors', 'Ignore review-compile errors.') do
+        cmd_config["ignore-errors"] = true
+      end
+
+      opts.parse!(args)
+      if args.size != 1
+        puts opts.help
+        exit 0
+      end
+
+      return cmd_config, args[0]
+    end
+
+    def execute(*args)
+      config = ReVIEW::Configure.values
+      cmd_config, yamlfile = parse_opts(args)
+
+      config.merge!(YAML.load_file(yamlfile))
+      # YAML configs will be overridden by command line options.
+      config.merge!(cmd_config)
+      generate_pdf(config)
+    end
+
+    def generate_pdf(config)
+      check_book(config)
+      @basedir = Dir.pwd
+      @path = build_path(config)
+      bookname = config["bookname"]
+      Dir.mkdir(@path)
+
+      @chaps_fnames = Hash.new{|h, key| h[key] = ""}
+      @compile_errors = nil
+
+      ReVIEW::Book.load(@basedir).parts.each do |part|
+        if part.name.present?
+          if part.file?
+            output_parts(part.name, config)
+            @chaps_fnames["CHAPS"] << %Q|\\input{#{part.name}.tex}\n|
+          else
+            @chaps_fnames["CHAPS"] << %Q|\\part{#{part.name}}\n|
+          end
+        end
+
+        part.chapters.each do |chap|
+          filename = "#{File.basename(chap.path, ".*")}.tex"
+          output_chaps(filename, config)
+          @chaps_fnames["PREDEF"]  << "\\input{#{filename}}\n" if chap.on_PREDEF?
+          @chaps_fnames["CHAPS"]   << "\\input{#{filename}}\n" if chap.on_CHAPS?
+          @chaps_fnames["APPENDIX"] << "\\input{#{filename}}\n" if chap.on_APPENDIX?
+          @chaps_fnames["POSTDEF"] << "\\input{#{filename}}\n" if chap.on_POSTDEF?
+        end
+      end
+
+      check_compile_status(config["ignore-errors"])
+
+      config["pre_str"]  = @chaps_fnames["PREDEF"]
+      config["chap_str"] = @chaps_fnames["CHAPS"]
+      config["appendix_str"] = @chaps_fnames["APPENDIX"]
+      config["post_str"] = @chaps_fnames["POSTDEF"]
+
+      config["usepackage"] = ""
+      if config["texstyle"]
+        config["usepackage"] = "\\usepackage{#{config['texstyle']}}"
+      end
+
+      copy_images("./images", "#{@path}/images")
+      copyStyToDir(Dir.pwd + "/sty", @path)
+      copyStyToDir(Dir.pwd, @path, "tex")
+
+      Dir.chdir(@path) {
+        template = get_template(config)
+        File.open("./book.tex", "wb"){|f| f.write(template)}
+
+        ## do compile
+        enc = config["params"].to_s.split(/\s+/).find{|i| i =~ /\A--outencoding=/ }
+        kanji = 'utf8'
+        if enc
+          kanji = enc.split(/\=/).last.gsub(/-/, '').downcase
+        end
+        texcommand = config["texcommand"] || "platex"
+        3.times do
+          system("#{texcommand} -kanji=#{kanji} book.tex")
+        end
+        if File.exist?("book.dvi")
+          system("dvipdfmx -d 5 book.dvi")
+        end
+      }
+      FileUtils.cp("#{@path}/book.pdf", "#{@basedir}/#{bookname}.pdf")
+
+      unless config["debug"]
+        remove_entry_secure @path
+      end
+    end
+
+    def output_chaps(filename, config)
+      $stderr.puts "compiling #{filename}"
+      cmd = "#{ReVIEW::MakerHelper.bindir}/review-compile --target=latex --level=#{config["secnolevel"]} --toclevel=#{config["toclevel"]} #{config["params"]} #{filename} > #{@path}/#{filename}"
+      if system cmd
+        # OK
+      else
+        @compile_errors = true
+        warn cmd
+      end
+    end
+
+    def output_parts(filename, config)
+      $stderr.puts "compiling #{filename}.tex"
+      cmd = "review-compile --target=latex --level=#{config["secnolevel"]} --toclevel=#{config["toclevel"]} #{config["params"]} #{filename}.re | sed -e s/\\chapter{/\\part{/ > #{@path}/#{filename}.tex"
+      if system cmd
+        # OK
+      else
+        @compile_errors = true
+        warn cmd
+      end
+    end
+
+
+    def copy_images(from, to)
+      if File.exist?(from)
+        Dir.mkdir(to)
+        ReVIEW::MakerHelper.copy_images_to_dir(from, to)
+        Dir.chdir(to) do
+          images = Dir.glob("**/*").find_all{|f|
+            File.file?(f) and f =~ /\.(jpg|jpeg|png|pdf)\z/
+          }
+          system("extractbb", *images)
+          unless system("extractbb", "-m", *images)
+            system("ebb", *images)
+          end
+        end
+      end
+    end
+
+    def make_custom_titlepage(coverfile)
+      coverfile_sty = coverfile.to_s.sub(/\.[^.]+$/, ".tex")
+      if File.exist?(coverfile_sty)
+        File.read(coverfile_sty)
+      else
+        nil
+      end
+    end
+
+    def join_with_separator(value, sep)
+      if value.kind_of? Array
+        value.join(sep)
+      else
+        value
+      end
+    end
+
+    def make_colophon_role(role, config)
+      if config[role].present?
+        return "#{ReVIEW::I18n.t(role)} & #{escape_latex(join_with_separator(config[role], ReVIEW::I18n.t("names_splitter")))} \\\\\n"
+      else
+        ""
+      end
+    end
+
+    def make_colophon(config)
+      colophon = ""
+      config["colophon_order"].each do |role|
+        colophon += make_colophon_role(role, config)
+      end
+      colophon
+    end
+
+    def make_authors(config)
+      authors = ""
+      if config["aut"].present?
+        authors = join_with_separator(config["aut"], ReVIEW::I18n.t("names_splitter")) + ReVIEW::I18n.t("author_postfix")
+      end
+      if config["csl"].present?
+        authors += " \\\\\n"+join_with_separator(config["csl"], ReVIEW::I18n.t("names_splitter")) + ReVIEW::I18n.t("supervisor_postfix")
+      end
+      if config["trl"].present?
+        authors += " \\\\\n"+join_with_separator(config["trl"], ReVIEW::I18n.t("names_splitter")) + ReVIEW::I18n.t("translator_postfix")
+      end
+      authors
+    end
+
+    def get_template(config)
+      dclass = config["texdocumentclass"] || []
+      documentclass =  dclass[0] || "jsbook"
+      documentclassoption =  dclass[1] || "oneside"
+
+      okuduke = make_colophon(config)
+      authors = make_authors(config)
+
+      custom_titlepage = make_custom_titlepage(config["coverfile"])
+
+      template = File.expand_path('layout.tex.erb', File.dirname(__FILE__))
+      layout_file = File.join(@basedir, "layouts", "layout.tex.erb")
+      if File.exist?(layout_file)
+        template = layout_file
+      end
+
+      erb = ERB.new(File.open(template).read)
+      values = config # must be 'values' for legacy files
+      erb.result(binding)
+    end
+
+    def copyStyToDir(dirname, copybase, extname = "sty")
+      unless File.directory?(dirname)
+        $stderr.puts "No such directory - #{dirname}"
+        return
+      end
+
+      Dir.open(dirname) {|dir|
+        dir.each {|fname|
+          next if fname =~ /^\./
+          if fname =~ /\.(#{extname})$/i
+            Dir.mkdir(copybase) unless File.exist?(copybase)
+            FileUtils.cp "#{dirname}/#{fname}", copybase
+          end
+        }
+      }
+    end
+  end
+end
+