review 4.1.0 → 5.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ruby-tex.yml +35 -0
- data/.github/workflows/ruby-win.yml +19 -9
- data/.github/workflows/ruby.yml +7 -3
- data/.rubocop.yml +138 -34
- data/NEWS.ja.md +285 -0
- data/NEWS.md +285 -1
- data/README.md +7 -6
- data/Rakefile +7 -2
- data/bin/review +2 -4
- data/bin/review-catalog-converter +4 -4
- data/bin/review-check +8 -12
- data/bin/review-checkdep +2 -5
- data/bin/review-compile +18 -34
- data/bin/review-epub2html +1 -4
- data/bin/review-epubmaker +3 -4
- data/bin/review-idgxmlmaker +1 -3
- data/bin/review-index +5 -86
- data/bin/review-init +1 -4
- data/bin/review-pdfmaker +1 -3
- data/bin/review-preproc +30 -38
- data/bin/review-textmaker +1 -3
- data/bin/review-update +1 -4
- data/bin/review-validate +4 -4
- data/bin/review-vol +5 -82
- data/bin/review-webmaker +1 -3
- data/doc/config.yml.sample +45 -11
- data/doc/config.yml.sample-simple +3 -3
- data/doc/format.ja.md +103 -13
- data/doc/format.md +104 -16
- data/doc/makeindex.ja.md +2 -2
- data/doc/pdfmaker.ja.md +42 -0
- data/doc/pdfmaker.md +41 -0
- data/doc/quickstart.ja.md +19 -6
- data/doc/quickstart.md +18 -6
- data/doc/writing_vertical.ja.md +6 -0
- data/lib/review.rb +1 -1
- data/lib/review/book.rb +2 -2
- data/lib/review/book/base.rb +67 -29
- data/lib/review/book/bib.rb +21 -0
- data/lib/review/book/book_unit.rb +158 -0
- data/lib/review/book/chapter.rb +33 -26
- data/lib/review/book/index.rb +24 -185
- data/lib/review/book/index/item.rb +7 -1
- data/lib/review/book/page_metric.rb +7 -7
- data/lib/review/book/part.rb +26 -11
- data/lib/review/book/volume.rb +5 -5
- data/lib/review/builder.rb +121 -52
- data/lib/review/call_hook.rb +20 -0
- data/lib/review/catalog.rb +3 -2
- data/lib/review/compiler.rb +230 -111
- data/lib/review/configure.rb +91 -7
- data/lib/review/converter.rb +1 -1
- data/lib/review/epub2html.rb +6 -1
- data/lib/review/epubmaker.rb +124 -152
- data/lib/review/epubmaker/content.rb +113 -0
- data/lib/review/epubmaker/epubcommon.rb +372 -0
- data/lib/review/epubmaker/epubv2.rb +178 -0
- data/lib/review/epubmaker/epubv3.rb +231 -0
- data/lib/review/epubmaker/producer.rb +167 -0
- data/lib/review/epubmaker/reviewheaderlistener.rb +12 -2
- data/lib/review/epubmaker/zip_exporter.rb +84 -0
- data/lib/review/exception.rb +13 -0
- data/lib/review/htmlbuilder.rb +176 -89
- data/lib/review/htmlutils.rb +8 -11
- data/lib/review/i18n.rb +2 -1
- data/lib/review/idgxmlbuilder.rb +165 -75
- data/lib/review/idgxmlmaker.rb +24 -28
- data/lib/review/img_math.rb +238 -0
- data/lib/review/index_builder.rb +645 -0
- data/lib/review/init.rb +9 -17
- data/lib/review/latexbox.rb +58 -0
- data/lib/review/latexbuilder.rb +193 -75
- data/lib/review/latexutils.rb +9 -1
- data/lib/review/lineinput.rb +112 -2
- data/lib/review/loggable.rb +27 -0
- data/lib/review/logger.rb +90 -3
- data/lib/review/makerhelper.rb +17 -188
- data/lib/review/markdownbuilder.rb +54 -4
- data/lib/review/pdfmaker.rb +76 -84
- data/lib/review/plaintextbuilder.rb +106 -22
- data/lib/review/preprocessor.rb +107 -303
- data/lib/review/preprocessor/directive.rb +35 -0
- data/lib/review/preprocessor/line.rb +34 -0
- data/lib/review/preprocessor/repository.rb +177 -0
- data/lib/review/rstbuilder.rb +27 -8
- data/lib/review/sec_counter.rb +14 -0
- data/lib/review/template.rb +11 -1
- data/lib/review/textmaker.rb +27 -32
- data/lib/review/textutils.rb +3 -12
- data/lib/review/tocprinter.rb +242 -97
- data/lib/review/topbuilder.rb +98 -31
- data/lib/review/update.rb +12 -13
- data/lib/review/version.rb +1 -1
- data/lib/review/volumeprinter.rb +97 -0
- data/lib/review/webmaker.rb +40 -47
- data/lib/review/webtocprinter.rb +39 -35
- data/lib/review/yamlloader.rb +2 -1
- data/review.gemspec +5 -3
- data/samples/sample-book/src/config-epub2.yml +1 -1
- data/samples/sample-book/src/config.yml +3 -3
- data/samples/sample-book/src/lib/tasks/review.rake +19 -1
- data/samples/sample-book/src/lib/tasks/z01_copy_sty.rake +2 -1
- data/samples/syntax-book/Gemfile +1 -1
- data/samples/syntax-book/ch01.re +1 -1
- data/samples/syntax-book/ch02.re +21 -6
- data/samples/syntax-book/ch03.re +1 -1
- data/samples/syntax-book/config.yml +1 -1
- data/samples/syntax-book/images/img3-2.png +0 -0
- data/samples/syntax-book/lib/tasks/z01_copy_sty.rake +2 -1
- data/templates/html/_colophon.html.erb +23 -0
- data/templates/html/_colophon_history.html.erb +9 -0
- data/templates/html/_cover.html.erb +10 -0
- data/templates/html/_part_body.html.erb +6 -0
- data/templates/html/_titlepage.html.erb +20 -0
- data/templates/html/layout-html5.html.erb +6 -0
- data/templates/html/layout-xhtml1.html.erb +6 -0
- data/templates/latex/config.erb +35 -23
- data/templates/latex/review-jlreq/README.md +3 -1
- data/templates/latex/review-jlreq/review-base.sty +36 -23
- data/templates/latex/review-jlreq/review-jlreq.cls +18 -25
- data/templates/latex/review-jlreq/review-style.sty +6 -1
- data/templates/latex/review-jlreq/review-tcbox.sty +348 -0
- data/templates/latex/review-jlreq/reviewmacro.sty +5 -0
- data/templates/latex/review-jsbook/README.md +7 -5
- data/templates/latex/review-jsbook/review-base.sty +40 -24
- data/templates/latex/review-jsbook/review-jsbook.cls +13 -3
- data/templates/latex/review-jsbook/review-style.sty +6 -1
- data/templates/latex/review-jsbook/review-tcbox.sty +348 -0
- data/templates/latex/review-jsbook/reviewmacro.sty +5 -0
- data/templates/opf/epubv2.opf.erb +7 -7
- data/templates/opf/epubv3.opf.erb +7 -7
- data/templates/opf/opf_manifest_epubv2.opf.erb +10 -0
- data/templates/opf/opf_manifest_epubv3.opf.erb +10 -0
- data/templates/opf/opf_metainfo_epubv2.opf.erb +17 -0
- data/templates/opf/opf_metainfo_epubv3.opf.erb +49 -0
- data/templates/opf/opf_tocx_epubv2.opf.erb +9 -0
- data/templates/opf/opf_tocx_epubv3.opf.erb +17 -0
- data/templates/web/html/layout-html5.html.erb +9 -8
- data/templates/web/html/layout-xhtml1.html.erb +6 -0
- data/test/assets/header_listener.html +35 -0
- data/test/assets/img_math/img1.png +0 -0
- data/test/assets/img_math/img2.png +0 -0
- data/test/assets/img_math/img3.png +0 -0
- data/test/assets/syntax_book_index_detail.txt +58 -0
- data/test/assets/test_template.tex +6 -3
- data/test/assets/test_template_backmatter.tex +6 -3
- data/test/book_test_helper.rb +11 -5
- data/test/run_test.rb +1 -1
- data/test/test_book.rb +54 -63
- data/test/test_book_chapter.rb +95 -54
- data/test/test_book_part.rb +3 -3
- data/test/test_builder.rb +29 -20
- data/test/test_catalog_converter_cmd.rb +1 -1
- data/test/test_converter.rb +1 -0
- data/test/test_epub3maker.rb +170 -126
- data/test/test_epubmaker.rb +254 -129
- data/test/test_epubmaker_cmd.rb +15 -4
- data/test/test_helper.rb +12 -5
- data/test/test_htmlbuilder.rb +926 -76
- data/test/test_htmlutils.rb +0 -12
- data/test/test_i18n.rb +33 -33
- data/test/test_idgxmlbuilder.rb +531 -20
- data/test/test_idgxmlmaker_cmd.rb +7 -3
- data/test/test_img_math.rb +111 -0
- data/test/test_index.rb +62 -52
- data/test/test_indexbuilder.rb +52 -0
- data/test/test_latexbuilder.rb +891 -20
- data/test/test_latexbuilder_v2.rb +56 -10
- data/test/test_lineinput.rb +20 -93
- data/test/test_logger.rb +7 -7
- data/test/test_makerhelper.rb +0 -12
- data/test/test_markdownbuilder.rb +32 -0
- data/test/test_pdfmaker.rb +100 -11
- data/test/test_pdfmaker_cmd.rb +3 -3
- data/test/test_plaintextbuilder.rb +546 -32
- data/test/test_preprocessor.rb +188 -1
- data/test/test_review_ext.rb +2 -1
- data/test/test_reviewheaderlistener.rb +49 -0
- data/test/test_rstbuilder.rb +25 -1
- data/test/test_sec_counter.rb +156 -0
- data/test/test_template.rb +12 -2
- data/test/test_textmaker_cmd.rb +5 -1
- data/test/test_tocprinter.rb +46 -0
- data/test/test_topbuilder.rb +324 -20
- data/test/test_update.rb +44 -44
- data/test/test_webtocprinter.rb +75 -43
- data/test/test_zip_exporter.rb +5 -6
- data/vendor/gentombow/LICENSE +1 -1
- data/vendor/gentombow/Makefile +0 -1
- data/vendor/gentombow/bounddvi-en.pdf +0 -0
- data/vendor/gentombow/bounddvi-en.tex +1 -0
- data/vendor/gentombow/bounddvi.pdf +0 -0
- data/vendor/gentombow/bounddvi.sty +30 -7
- data/vendor/gentombow/bounddvi.tex +1 -0
- data/vendor/gentombow/create_archive.sh +1 -0
- data/vendor/gentombow/gentombow-ja.pdf +0 -0
- data/vendor/gentombow/gentombow-ja.tex +9 -0
- data/vendor/gentombow/gentombow.pdf +0 -0
- data/vendor/gentombow/gentombow.sty +32 -10
- data/vendor/gentombow/gentombow.tex +8 -0
- data/vendor/gentombow/tests/gentombow-01-pdfx.tex +8 -0
- data/vendor/gentombow/tests/gentombow-02-pdfx.tex +8 -0
- data/vendor/jsclasses/Makefile +3 -2
- data/vendor/jsclasses/create_archive.sh +5 -5
- data/vendor/jsclasses/jis/Makefile +3 -2
- data/vendor/jsclasses/jis/jsarticle.cls +22 -18
- data/vendor/jsclasses/jis/jsbook.cls +22 -18
- data/vendor/jsclasses/jis/jsclasses.dtx +94 -13
- data/vendor/jsclasses/jis/jsclasses.ins +15 -5
- data/vendor/jsclasses/jis/jslogo.ins +9 -0
- data/vendor/jsclasses/jis/jslogo.sty +1 -13
- data/vendor/jsclasses/jis/jspf.cls +22 -18
- data/vendor/jsclasses/jis/jsreport.cls +22 -18
- data/vendor/jsclasses/jis/jsverb.ins +9 -0
- data/vendor/jsclasses/jis/jsverb.sty +1 -13
- data/vendor/jsclasses/jis/kiyou.cls +22 -18
- data/vendor/jsclasses/jis/minijs.sty +65 -22
- data/vendor/jsclasses/jis/okumacro.ins +9 -0
- data/vendor/jsclasses/jis/okumacro.sty +1 -13
- data/vendor/jsclasses/jis/okuverb.ins +9 -0
- data/vendor/jsclasses/jis/okuverb.sty +1 -13
- data/vendor/jsclasses/jis/winjis.sty +23 -19
- data/vendor/jsclasses/jsarticle.cls +22 -18
- data/vendor/jsclasses/jsbook.cls +22 -18
- data/vendor/jsclasses/jsclasses.dtx +94 -13
- data/vendor/jsclasses/jsclasses.ins +15 -5
- data/vendor/jsclasses/jsclasses.pdf +0 -0
- data/vendor/jsclasses/jslogo.ins +9 -0
- data/vendor/jsclasses/jslogo.pdf +0 -0
- data/vendor/jsclasses/jslogo.sty +1 -13
- data/vendor/jsclasses/jspf.cls +22 -18
- data/vendor/jsclasses/jsreport.cls +22 -18
- data/vendor/jsclasses/jsverb.ins +9 -0
- data/vendor/jsclasses/jsverb.pdf +0 -0
- data/vendor/jsclasses/jsverb.sty +1 -13
- data/vendor/jsclasses/kiyou.cls +22 -18
- data/vendor/jsclasses/minijs.sty +68 -22
- data/vendor/jsclasses/okumacro.ins +9 -0
- data/vendor/jsclasses/okumacro.pdf +0 -0
- data/vendor/jsclasses/okumacro.sty +1 -13
- data/vendor/jsclasses/okuverb.ins +9 -0
- data/vendor/jsclasses/okuverb.pdf +0 -0
- data/vendor/jsclasses/okuverb.sty +1 -13
- data/vendor/jsclasses/tests/relfont.tex +10 -0
- data/vendor/jsclasses/winjis.sty +23 -19
- metadata +106 -22
- data/.rubocop_todo.yml +0 -7
- data/lib/epubmaker.rb +0 -23
- data/lib/epubmaker/content.rb +0 -110
- data/lib/epubmaker/epubcommon.rb +0 -441
- data/lib/epubmaker/epubv2.rb +0 -143
- data/lib/epubmaker/epubv3.rb +0 -233
- data/lib/epubmaker/producer.rb +0 -375
- data/lib/epubmaker/zip_exporter.rb +0 -81
- data/lib/lineinput.rb +0 -155
- data/lib/review/book/compilable.rb +0 -178
- data/lib/review/tocparser.rb +0 -275
- data/test/test_tocparser.rb +0 -25
data/bin/review-init
CHANGED
@@ -7,10 +7,7 @@
|
|
7
7
|
# the GNU LGPL, Lesser General Public License version 2.1.
|
8
8
|
# For details of the GNU LGPL, see the file "COPYING".
|
9
9
|
|
10
|
-
|
11
|
-
|
12
|
-
bindir = Pathname.new(__FILE__).realpath.dirname
|
13
|
-
$LOAD_PATH.unshift((bindir + '../lib').realpath)
|
10
|
+
$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
|
14
11
|
|
15
12
|
require 'review/init'
|
16
13
|
|
data/bin/review-pdfmaker
CHANGED
@@ -7,9 +7,7 @@
|
|
7
7
|
# For details of the GNU LGPL, see the file "COPYING".
|
8
8
|
#
|
9
9
|
|
10
|
-
|
11
|
-
bindir = Pathname.new(__FILE__).realpath.dirname
|
12
|
-
$LOAD_PATH.unshift((bindir + '../lib').realpath)
|
10
|
+
$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
|
13
11
|
|
14
12
|
require 'review/pdfmaker'
|
15
13
|
|
data/bin/review-preproc
CHANGED
@@ -9,19 +9,20 @@
|
|
9
9
|
# For details of the GNU LGPL, see the file "COPYING".
|
10
10
|
#
|
11
11
|
|
12
|
-
|
13
|
-
|
14
|
-
bindir = Pathname.new(__FILE__).realpath.dirname
|
15
|
-
$LOAD_PATH.unshift((bindir + '../lib').realpath)
|
12
|
+
$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
|
16
13
|
|
17
14
|
require 'review/preprocessor'
|
18
15
|
require 'review/version'
|
19
16
|
require 'review/extentions'
|
20
17
|
require 'review/logger'
|
21
|
-
require 'lineinput'
|
18
|
+
require 'review/lineinput'
|
19
|
+
require 'review/loggable'
|
22
20
|
require 'stringio'
|
23
21
|
require 'fileutils'
|
24
22
|
require 'optparse'
|
23
|
+
require 'tempfile'
|
24
|
+
|
25
|
+
include ReVIEW::Loggable
|
25
26
|
|
26
27
|
def sigmain
|
27
28
|
Signal.trap(:INT) { exit 1 }
|
@@ -33,16 +34,7 @@ rescue Errno::EPIPE
|
|
33
34
|
exit 0
|
34
35
|
end
|
35
36
|
|
36
|
-
def
|
37
|
-
@logger = ReVIEW.logger
|
38
|
-
if File.file?('review-preproc-ext.rb')
|
39
|
-
if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
|
40
|
-
@logger.warn 'review-preproc-ext.rb is prohibited in safe mode. ignored.'
|
41
|
-
else
|
42
|
-
Kernel.load(File.expand_path('review-preproc-ext.rb'))
|
43
|
-
end
|
44
|
-
end
|
45
|
-
|
37
|
+
def parse_options
|
46
38
|
param = {}
|
47
39
|
|
48
40
|
mode = :output
|
@@ -60,32 +52,42 @@ def main
|
|
60
52
|
begin
|
61
53
|
opts.parse!
|
62
54
|
rescue OptionParser::ParseError => e
|
63
|
-
|
55
|
+
error e.message
|
64
56
|
$stderr.puts opts.help
|
65
57
|
exit 1
|
66
58
|
end
|
67
59
|
|
68
|
-
|
69
|
-
|
60
|
+
[param, mode]
|
61
|
+
end
|
62
|
+
|
63
|
+
def main
|
64
|
+
@logger = ReVIEW.logger
|
65
|
+
if File.file?('review-preproc-ext.rb')
|
66
|
+
if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
|
67
|
+
warn 'review-preproc-ext.rb is prohibited in safe mode. ignored.'
|
68
|
+
else
|
69
|
+
Kernel.load(File.expand_path('review-preproc-ext.rb'))
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
param, mode = parse_options
|
74
|
+
pp = ReVIEW::Preprocessor.new(param)
|
70
75
|
ARGV.each do |path|
|
71
|
-
current_file = path
|
72
76
|
case mode
|
73
77
|
when :output
|
74
|
-
|
78
|
+
$stdout.write(pp.process(path))
|
75
79
|
when :replace
|
76
|
-
|
77
|
-
File.
|
80
|
+
output = pp.process(path)
|
81
|
+
File.write(path, output)
|
78
82
|
when :diff, :check
|
79
|
-
|
80
|
-
|
81
|
-
|
83
|
+
Tempfile.create('review.pptmp') do |tmp_io|
|
84
|
+
tmp = tmp_io.path
|
85
|
+
tmp_io.write(pp.process(path))
|
82
86
|
if mode == :check
|
83
87
|
system("diff -qu #{path} #{tmp} >/dev/null || echo #{path}")
|
84
88
|
else
|
85
89
|
system("diff -u #{path} #{tmp}")
|
86
90
|
end
|
87
|
-
ensure
|
88
|
-
FileUtils.rm_f(tmp)
|
89
91
|
end
|
90
92
|
else
|
91
93
|
raise "must not happen: #{mode}"
|
@@ -93,18 +95,8 @@ def main
|
|
93
95
|
end
|
94
96
|
rescue ReVIEW::Error => e
|
95
97
|
raise if $DEBUG
|
96
|
-
@logger.error e.message
|
97
|
-
exit 1
|
98
|
-
end
|
99
|
-
|
100
|
-
def preproc(pp, path)
|
101
|
-
buf = StringIO.new
|
102
|
-
File.open(path) { |f| pp.process(f, buf) }
|
103
|
-
buf.string
|
104
|
-
end
|
105
98
|
|
106
|
-
|
107
|
-
File.open(path, 'w') { |f| f.write str }
|
99
|
+
error! e.message
|
108
100
|
end
|
109
101
|
|
110
102
|
sigmain
|
data/bin/review-textmaker
CHANGED
@@ -7,9 +7,7 @@
|
|
7
7
|
# For details of the GNU LGPL, see the file "COPYING".
|
8
8
|
#
|
9
9
|
|
10
|
-
|
11
|
-
bindir = Pathname.new(__FILE__).realpath.dirname
|
12
|
-
$LOAD_PATH.unshift((bindir + '../lib').realpath)
|
10
|
+
$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
|
13
11
|
|
14
12
|
require 'review/textmaker'
|
15
13
|
|
data/bin/review-update
CHANGED
@@ -7,10 +7,7 @@
|
|
7
7
|
# the GNU LGPL, Lesser General Public License version 2.1.
|
8
8
|
# For details of the GNU LGPL, see the file "COPYING".
|
9
9
|
|
10
|
-
|
11
|
-
|
12
|
-
bindir = Pathname.new(__FILE__).realpath.dirname
|
13
|
-
$LOAD_PATH.unshift((bindir + '../lib').realpath)
|
10
|
+
$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
|
14
11
|
|
15
12
|
require 'review/update'
|
16
13
|
|
data/bin/review-validate
CHANGED
@@ -8,10 +8,9 @@
|
|
8
8
|
#
|
9
9
|
|
10
10
|
# simple validator for Re:VIEW
|
11
|
-
require 'pathname'
|
12
11
|
|
13
|
-
|
14
|
-
|
12
|
+
$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
|
13
|
+
|
15
14
|
require 'review/logger'
|
16
15
|
|
17
16
|
block = nil
|
@@ -53,7 +52,8 @@ ARGF.each do |line|
|
|
53
52
|
end
|
54
53
|
elsif block == 'table'
|
55
54
|
next if line.start_with?('#@')
|
56
|
-
|
55
|
+
|
56
|
+
if line !~ /\A-----/
|
57
57
|
# table
|
58
58
|
colcount = line.split("\t").size
|
59
59
|
if maxcolcount == 0
|
data/bin/review-vol
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
#!/usr/bin/env ruby
|
2
2
|
#
|
3
|
-
# Copyright (c) 2014-
|
3
|
+
# Copyright (c) 2014-2020 Minero Aoki, Kenshi Muto
|
4
4
|
# 2003-2014 Minero Aoki
|
5
5
|
#
|
6
6
|
# This program is free software.
|
@@ -9,87 +9,10 @@
|
|
9
9
|
# For details of the GNU LGPL, see the file "COPYING".
|
10
10
|
#
|
11
11
|
|
12
|
-
|
12
|
+
$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
|
13
13
|
|
14
|
-
|
15
|
-
$LOAD_PATH.unshift((bindir + '../lib').realpath)
|
14
|
+
require 'review/volumeprinter'
|
16
15
|
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
include ReVIEW::TextUtils
|
21
|
-
|
22
|
-
def main
|
23
|
-
@logger = ReVIEW.logger
|
24
|
-
@config = ReVIEW::Configure.values
|
25
|
-
|
26
|
-
part_sensitive = false
|
27
|
-
basedir = nil
|
28
|
-
yamlfile = 'config.yml'
|
29
|
-
opts = OptionParser.new
|
30
|
-
opts.version = ReVIEW::VERSION
|
31
|
-
opts.on('--yaml=YAML', 'Read configurations from YAML file.') { |yaml| yamlfile = yaml }
|
32
|
-
opts.on('-P', '--part-sensitive', 'Prints volume of each parts.') { part_sensitive = true }
|
33
|
-
opts.on('--directory=DIR', 'Compile all chapters in DIR.') { |path| basedir = path }
|
34
|
-
opts.on('--help', 'Print this message and quit') do
|
35
|
-
puts opts.help
|
36
|
-
exit 0
|
37
|
-
end
|
38
|
-
begin
|
39
|
-
opts.parse!
|
40
|
-
rescue OptionParser::ParseError => e
|
41
|
-
@logger.error e.message
|
42
|
-
$stderr.puts opts.help
|
43
|
-
exit 1
|
44
|
-
end
|
45
|
-
|
46
|
-
book = basedir ? ReVIEW::Book.load(basedir) : ReVIEW::Book::Base.load
|
47
|
-
book.config = @config
|
48
|
-
if yamlfile
|
49
|
-
book.load_config(yamlfile)
|
50
|
-
end
|
51
|
-
|
52
|
-
if part_sensitive
|
53
|
-
sep = ''
|
54
|
-
book.each_part do |part|
|
55
|
-
print sep
|
56
|
-
sep = "\n"
|
57
|
-
if part.number
|
58
|
-
puts "Part #{part.number} #{part.name}"
|
59
|
-
end
|
60
|
-
part.each_chapter do |chap|
|
61
|
-
print_chapter_volume chap
|
62
|
-
end
|
63
|
-
puts ' --------------------'
|
64
|
-
print_volume part.volume
|
65
|
-
end
|
66
|
-
else
|
67
|
-
book.each_chapter do |chap|
|
68
|
-
print_chapter_volume chap
|
69
|
-
end
|
70
|
-
end
|
71
|
-
puts '============================='
|
72
|
-
print_volume(book.volume) # puts "Total #{book.volume}"
|
73
|
-
rescue ReVIEW::ApplicationError, Errno::ENOENT => e
|
74
|
-
raise if $DEBUG
|
75
|
-
@logger.error e.message
|
76
|
-
exit 1
|
77
|
-
end
|
78
|
-
|
79
|
-
def print_chapter_volume(chap)
|
80
|
-
vol = chap.volume
|
81
|
-
title = chap.title
|
82
|
-
printf("%s %3dKB %6dC %5dL %3dP %s %-s\n",
|
83
|
-
chapnumstr(chap.number), vol.kbytes, vol.chars, vol.lines, vol.page,
|
84
|
-
"#{chap.name} ".ljust(25, '.'), title)
|
85
|
-
end
|
86
|
-
|
87
|
-
def print_volume(vol)
|
88
|
-
printf(" %3dKB %6dC %5dL %3dP\n", vol.kbytes, vol.chars, vol.lines, vol.page)
|
16
|
+
if File.basename($PROGRAM_NAME) == File.basename(__FILE__)
|
17
|
+
ReVIEW::VolumePrinter.execute(*ARGV)
|
89
18
|
end
|
90
|
-
|
91
|
-
def chapnumstr(n)
|
92
|
-
n ? sprintf('%2d.', n) : ' '
|
93
|
-
end
|
94
|
-
|
95
|
-
main
|
data/bin/review-webmaker
CHANGED
@@ -6,9 +6,7 @@
|
|
6
6
|
# For details of the GNU LGPL, see the file "COPYING".
|
7
7
|
#
|
8
8
|
|
9
|
-
|
10
|
-
bindir = Pathname.new(__FILE__).realpath.dirname
|
11
|
-
$LOAD_PATH.unshift((bindir + '../lib').realpath)
|
9
|
+
$LOAD_PATH.unshift(File.realpath('../lib', __dir__))
|
12
10
|
|
13
11
|
require 'review/webmaker'
|
14
12
|
|
data/doc/config.yml.sample
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
# このファイルはUTF-8エンコーディングで記述してください。
|
6
6
|
|
7
7
|
# この設定ファイルでサポートするRe:VIEWのバージョン番号。
|
8
|
-
review_version:
|
8
|
+
review_version: 5.0
|
9
9
|
|
10
10
|
# ほかの設定ファイルの継承を指定できる。同じパラメータに異なる値がある場合は、
|
11
11
|
# 呼び出し元の値が優先される。
|
@@ -74,7 +74,7 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
|
|
74
74
|
# 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
|
75
75
|
# history: [["2016-04-20 v1.0.0版発行", "2018-11-11 v3.0.0版発行"]]
|
76
76
|
# 権利表記(配列で複数指定可)
|
77
|
-
# rights: (C) 2016-
|
77
|
+
# rights: (C) 2016-2020 Re:VIEW Developers
|
78
78
|
# description: 説明
|
79
79
|
# subject: 短い説明用タグ(配列で複数指定可)
|
80
80
|
# type: 書籍のカテゴリーなど(配列で複数指定可)
|
@@ -87,11 +87,14 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
|
|
87
87
|
debug: null
|
88
88
|
|
89
89
|
# 固有IDに使用するドメイン。指定しない場合には、時刻に基づくランダムUUIDが入る
|
90
|
-
# urnid: urn:
|
90
|
+
# urnid: urn:uuid:http://example.com/book-title/
|
91
91
|
#
|
92
92
|
# ISBN。省略した場合はurnidが入る
|
93
93
|
# isbn: null
|
94
94
|
#
|
95
|
+
# @<chap>, @<chapref>, @<title>, @<hd>命令をハイパーリンクにする(nullでハイパーリンクにしない)
|
96
|
+
# chapterlink: true
|
97
|
+
|
95
98
|
# HTMLファイルの拡張子(省略した場合はhtml)
|
96
99
|
# htmlext: html
|
97
100
|
#
|
@@ -184,19 +187,35 @@ toc: true
|
|
184
187
|
# //table命令における列の区切り文字。tabs (1文字以上のタブ文字区切り。デフォルト), singletab (1文字のタブ文字区切り), spaces (1文字以上のスペースまたはタブ文字の区切り), verticalbar ("0個以上の空白 | 0個以上の空白"の区切り)
|
185
188
|
# table_row_separator: tabs
|
186
189
|
|
187
|
-
#
|
188
|
-
#
|
190
|
+
# 複数行から段落を結合する際、前後のUnicode文字種に基づき必要に応じて空白文字を挿入するか
|
191
|
+
# 省略した場合はnull (挿入しない)。別途unicode-eaw gemファイルが必要
|
192
|
+
# join_lines_by_lang: null
|
193
|
+
|
194
|
+
# 図・表・コードリスト・数式のキャプション位置。
|
195
|
+
# 値はtop(上)またはbottom(下)でデフォルトは以下のとおり
|
196
|
+
# caption_position:
|
197
|
+
# image: bottom
|
198
|
+
# table: top
|
199
|
+
# list: top
|
200
|
+
# equation: top
|
201
|
+
|
202
|
+
# review-toc向けのヒント情報
|
203
|
+
# (文字幅を考慮した行数計測には、別途unicode-eaw gemファイルが必要)
|
204
|
+
# ページあたりの行数文字数を用紙サイズで指定する(A5 or B5)
|
189
205
|
# page_metric: A5
|
190
206
|
#
|
191
207
|
# あるいは、配列で指定することもできる
|
192
|
-
# 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1
|
193
|
-
# page_metric: [40,
|
208
|
+
# 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数
|
209
|
+
# page_metric: [40,34,29,34]
|
194
210
|
|
195
|
-
#
|
196
|
-
# TeX
|
197
|
-
#
|
211
|
+
# @<m>, //texequation に記述したTeX数式の表現方法 (PDFMaker (LaTeX) 以外)
|
212
|
+
# null: TeX式をそのまま文字列として出力 (デフォルト)
|
213
|
+
# mathml: MathML変換。別途math_ml gemファイルが必要。EPUBMaker/WebMakerのみ効果
|
214
|
+
# imgmath: 画像化。オプションはimgmath_optionsで設定する
|
215
|
+
# mathjax: MathJax変換。EPUBMaker/WebMakerのみ効果。なお、MathJaxに必要なデータはインターネットから取得される。EPUBで利用できるかはEPUBリーダ依存
|
216
|
+
# math_format: null
|
198
217
|
|
199
|
-
# imgmath
|
218
|
+
# math_formatがimgmathの場合の設定
|
200
219
|
# 以下のパラメータを有効にするときには、
|
201
220
|
# imgmath_options:
|
202
221
|
# パラメータ: 値
|
@@ -322,6 +341,8 @@ epubmaker:
|
|
322
341
|
#
|
323
342
|
# 脚注に「戻る」リンクを追加する(trueで追加)。脚注の記号および戻るリンクの記号はlocale.ymlで変更可能
|
324
343
|
# back_footnote: null
|
344
|
+
# 見出しに応じて<section>で囲むようにする(trueで<section>を利用)
|
345
|
+
# use_section: null
|
325
346
|
# epubmaker:階層を使うものはここまで
|
326
347
|
|
327
348
|
# LaTeX用のスタイルファイル(styディレクトリ以下に置くこと)
|
@@ -407,4 +428,17 @@ pdfmaker:
|
|
407
428
|
colophon: true
|
408
429
|
# 表紙挿入時に表紙のページ番号名を「cover」とし、偶数ページ扱いにして大扉前に白ページが入るのを防ぐ。デフォルトはtrue
|
409
430
|
# use_cover_nombre: true
|
431
|
+
#
|
432
|
+
# 囲み表現の切り替え設定
|
433
|
+
# column, note, memo, tip, info, warning, important, caution, noticeを設定可
|
434
|
+
# styleはreview-tcbox.styまたは独自に作成したスタイルで定義済みの囲みスタイル名
|
435
|
+
# optionsはキャプションなし囲みに対するtcolorboxの追加・上書きオプション
|
436
|
+
# options_with_captionはキャプション付き囲みのtcolorboxの追加・上書きオプション(省略した場合はoptionsと同じ)
|
437
|
+
#
|
438
|
+
# boxsetting:
|
439
|
+
# note:
|
440
|
+
# style: squarebox
|
441
|
+
# options: "colback=black!5!white"
|
442
|
+
# options_with_caption: "colbacktitle=black!25!white"
|
443
|
+
#
|
410
444
|
# pdfmaker:階層を使うものはここまで
|
@@ -1,5 +1,5 @@
|
|
1
1
|
# simple sample of config.yml
|
2
|
-
review_version:
|
2
|
+
review_version: 5.0
|
3
3
|
|
4
4
|
# debug: true
|
5
5
|
|
@@ -23,9 +23,9 @@ prt: "Re:VIEW Printing inc."
|
|
23
23
|
contact: "https://reviewml.org/"
|
24
24
|
date: 2018-11-11
|
25
25
|
history: [["2012-01-30"],["2016-04-20","2016-05-03"],["2018-11-11"]]
|
26
|
-
rights: (C) 2016-
|
26
|
+
rights: (C) 2016-2020 Re:VIEW Commiters, some rights reserved.
|
27
27
|
description: sample config.yml file for Re:VIEW book
|
28
|
-
urnid: urn:
|
28
|
+
urnid: urn:uuid:http://reviewml.org/review-sample-book
|
29
29
|
# isbn: null
|
30
30
|
|
31
31
|
## Book Structure
|
data/doc/format.ja.md
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
Re:VIEW フォーマットの文法について解説します。Re:VIEW フォーマットはアスキー社(現カドカワ)の EWB を基本としながら、一部に RD や各種 Wiki の文法を取り入れて簡素化しています。
|
4
4
|
|
5
|
-
このドキュメントは、Re:VIEW
|
5
|
+
このドキュメントは、Re:VIEW 5.1 に基づいています。
|
6
6
|
|
7
7
|
## 段落
|
8
8
|
|
@@ -255,7 +255,6 @@ puts "hello world!"
|
|
255
255
|
//}
|
256
256
|
```
|
257
257
|
|
258
|
-
|
259
258
|
### ソースコード専用の引用
|
260
259
|
|
261
260
|
ソースコードを引用するには次のように記述します。
|
@@ -346,7 +345,7 @@ V1 --> V6 --|
|
|
346
345
|
```
|
347
346
|
|
348
347
|
* `<imgdir>` はデフォルトでは images ディレクトリです。
|
349
|
-
* `<builder>` は利用しているビルダ名(ターゲット名)で、たとえば `--target=html` としているのであれば、images/html
|
348
|
+
* `<builder>` は利用しているビルダ名(ターゲット名)で、たとえば `--target=html` としているのであれば、images/html ディレクトリとなります。各 Maker におけるビルダ名は epubmaker および webmaker の場合は `html`、pdfmaker の場合は `latex`、textmaker の場合は `top` です。
|
350
349
|
* `<chapid>` は章 ID です。たとえば ch01.re という名前であれば「ch01」です。
|
351
350
|
* `<id>` は //image[〜] の最初に入れた「〜」のことです(つまり、ID に日本語や空白交じりの文字を使ってしまうと、後で画像ファイル名の名前付けに苦労することになります!)。
|
352
351
|
* `<ext>` は Re:VIEW が自動で判別する拡張子です。ビルダによってサポートおよび優先する拡張子は異なります。
|
@@ -355,7 +354,7 @@ V1 --> V6 --|
|
|
355
354
|
|
356
355
|
* HTMLBuilder (EPUBMaker、WEBMaker)、MARKDOWNBuilder: .png、.jpg、.jpeg、.gif、.svg
|
357
356
|
* LATEXBuilder (PDFMaker): .ai、.eps、.pdf、.tif、.tiff、.png、.bmp、.jpg、.jpeg、.gif
|
358
|
-
*
|
357
|
+
* それ以外のビルダ・Maker: .ai、.psd、.eps、.pdf、.tif、.tiff、.png、.bmp、.jpg、.jpeg、.gif、.svg
|
359
358
|
|
360
359
|
### インラインの画像挿入
|
361
360
|
|
@@ -503,6 +502,19 @@ complexmatrixという識別子に基づく画像ファイルが貼り込まれ
|
|
503
502
|
|
504
503
|
内容には、空行で区切って複数の段落を記述可能です。
|
505
504
|
|
505
|
+
Re:VIEW 5.0 以降では、囲み記事に箇条書きや図表・リストを含めることもできます。
|
506
|
+
|
507
|
+
```
|
508
|
+
//note{
|
509
|
+
|
510
|
+
箇条書きを含むノートです。
|
511
|
+
|
512
|
+
1. 箇条書き1
|
513
|
+
2. 箇条書き2
|
514
|
+
|
515
|
+
//}
|
516
|
+
```
|
517
|
+
|
506
518
|
## 脚注
|
507
519
|
|
508
520
|
脚注は「`//footnote`」を使って記述します。
|
@@ -589,7 +601,7 @@ LaTeX の式を挿入するには、`//texequation{ 〜 //}` を使います。
|
|
589
601
|
「式1.1」のように連番を付けたいときには、識別子とキャプションを指定します。
|
590
602
|
|
591
603
|
```
|
592
|
-
//
|
604
|
+
//texequation[emc][質量とエネルギーの等価性]{
|
593
605
|
\sum_{i=1}^nf_n(x)
|
594
606
|
//}
|
595
607
|
```
|
@@ -600,7 +612,7 @@ LaTeX の式を挿入するには、`//texequation{ 〜 //}` を使います。
|
|
600
612
|
|
601
613
|
LaTeX の数式が正常に整形されるかどうかは処理系に依存します。LaTeX を利用する PDFMaker では問題なく利用できます。
|
602
614
|
|
603
|
-
EPUBMaker および WEBMaker では、MathML
|
615
|
+
EPUBMaker および WEBMaker では、MathML に変換する方法、MathJax に変換する方法、画像化する方法から選べます。
|
604
616
|
|
605
617
|
### MathML の場合
|
606
618
|
MathML ライブラリをインストールしておきます(`gem install math_ml`)。
|
@@ -608,11 +620,20 @@ MathML ライブラリをインストールしておきます(`gem install mat
|
|
608
620
|
さらに config.yml に以下のように指定します。
|
609
621
|
|
610
622
|
```
|
611
|
-
|
623
|
+
math_format: mathml
|
612
624
|
```
|
613
625
|
|
614
626
|
なお、MathML で正常に表現されるかどうかは、ビューアやブラウザに依存します。
|
615
627
|
|
628
|
+
### MathJax の場合
|
629
|
+
config.yml に以下のように指定します。
|
630
|
+
|
631
|
+
```
|
632
|
+
math_format: mathjax
|
633
|
+
```
|
634
|
+
|
635
|
+
MathJax の JavaScript モジュールはインターネットから読み込まれます。現時点で EPUB の仕様では外部からの読み込みを禁止しているため、MathJax を有効にすると EPUB ファイルの検証を通りません。また、ほぼすべての EPUB リーダーで MathJax は動作しません。CSS 組版との組み合わせでは利用できる可能性があります。
|
636
|
+
|
616
637
|
### 画像化の場合
|
617
638
|
|
618
639
|
LaTeX を内部で呼び出し、外部ツールを使って画像化する方法です。画像化された数式は、`images/_review_math` フォルダに配置されます。
|
@@ -627,7 +648,7 @@ TeXLive などの LaTeX 環境が必要です。必要に応じて config.yml
|
|
627
648
|
config.yml で以下のように設定すると、
|
628
649
|
|
629
650
|
```
|
630
|
-
|
651
|
+
math_format: imgmath
|
631
652
|
```
|
632
653
|
|
633
654
|
デフォルト値として以下が使われます。
|
@@ -662,7 +683,7 @@ imgmath_options:
|
|
662
683
|
たとえば SVG を利用するには、次のようにします。
|
663
684
|
|
664
685
|
```
|
665
|
-
|
686
|
+
math_format: imgmath
|
666
687
|
imgmath_options:
|
667
688
|
format: svg
|
668
689
|
pdfcrop_pixelize_cmd: "pdftocairo -svg -r 90 -f %p -l %p -singlefile %i %o"
|
@@ -673,7 +694,7 @@ imgmath_options:
|
|
673
694
|
単一のページの処理を前提とする `sips` コマンドや `magick` コマンドを使う場合、入力 PDF から指定のページを抽出するように `extract_singlepage: true` として挙動を変更します。単一ページの抽出はデフォルトで TeXLive の `pdfjam` コマンドが使われます。
|
674
695
|
|
675
696
|
```
|
676
|
-
|
697
|
+
math_format: imgmath
|
677
698
|
imgmath_options:
|
678
699
|
extract_singlepage: true
|
679
700
|
# pdfjamの代わりに外部ツールのpdftkを使う場合(Windowsなど)
|
@@ -687,7 +708,7 @@ imgmath_options:
|
|
687
708
|
textmaker 向けに PDF 形式の数式ファイルを作成したいときには、たとえば以下のように設定します(ページの抽出には pdftk を利用)。
|
688
709
|
|
689
710
|
```
|
690
|
-
|
711
|
+
math_format: imgmath
|
691
712
|
imgmath_options:
|
692
713
|
format: pdf
|
693
714
|
extract_singlepage: true
|
@@ -698,7 +719,7 @@ imgmath_options:
|
|
698
719
|
Re:VIEW 2 以前の dvipng の設定に合わせるには、次のようにします。
|
699
720
|
|
700
721
|
```
|
701
|
-
|
722
|
+
math_format: imgmath
|
702
723
|
imgmath_options:
|
703
724
|
converter: dvipng
|
704
725
|
fontsize: 12
|
@@ -912,9 +933,76 @@ LaTeXビルダを使用している場合:
|
|
912
933
|
|
913
934
|
```
|
914
935
|
|
915
|
-
|
916
936
|
`//raw`、`//embed`、`@<raw>` および `@<embed>` は、HTML、XML や TeX の文書構造を容易に壊す可能性があります。使用には十分に注意してください。
|
917
937
|
|
938
|
+
### 入れ子の箇条書き
|
939
|
+
|
940
|
+
Re:VIEW の箇条書きは `*` 型の箇条書きを除き、基本的に入れ子を表現できません。いずれの箇条書きも、別の箇条書き、あるいは図表・リストを箇条書きの途中に配置することを許容していません。
|
941
|
+
|
942
|
+
この対策として、Re:VIEW 4.2 では試験的に `//beginchild`、`//endchild` というブロック命令を追加しています。箇条書きの途中に何かを含めたいときには、それを `//beginchild` 〜 `//endchild` で囲んで配置します。多重に入れ子にすることも可能です。
|
943
|
+
|
944
|
+
```
|
945
|
+
* UL1
|
946
|
+
|
947
|
+
//beginchild
|
948
|
+
#@# ここからUL1の子
|
949
|
+
|
950
|
+
1. UL1-OL1
|
951
|
+
|
952
|
+
//beginchild
|
953
|
+
#@# ここからUL1-OL1の子
|
954
|
+
|
955
|
+
UL1-OL1-PARAGRAPH
|
956
|
+
|
957
|
+
* UL1-OL1-UL1
|
958
|
+
* UL1-OL1-UL2
|
959
|
+
|
960
|
+
//endchild
|
961
|
+
#@# ここまでUL1-OL1の子
|
962
|
+
|
963
|
+
2. UL1-OL2
|
964
|
+
|
965
|
+
: UL1-DL1
|
966
|
+
UL1-DD1
|
967
|
+
: UL1-DL2
|
968
|
+
UL1-DD2
|
969
|
+
|
970
|
+
//endchild
|
971
|
+
#@# ここまでUL1の子
|
972
|
+
|
973
|
+
* UL2
|
974
|
+
```
|
975
|
+
|
976
|
+
これをたとえば HTML に変換すると、次のようになります。
|
977
|
+
|
978
|
+
```
|
979
|
+
<ul>
|
980
|
+
<li>UL1
|
981
|
+
<ol>
|
982
|
+
<li>UL1-OL1
|
983
|
+
<p>UL1-OL1-PARAGRAPH</p>
|
984
|
+
<ul>
|
985
|
+
<li>UL1-OL1-UL1</li>
|
986
|
+
<li>UL1-OL1-UL2</li>
|
987
|
+
</ul>
|
988
|
+
</li>
|
989
|
+
|
990
|
+
<li>UL1-OL2</li>
|
991
|
+
</ol>
|
992
|
+
<dl>
|
993
|
+
<dt>UL1-DL1</dt>
|
994
|
+
<dd>UL1-DD1</dd>
|
995
|
+
<dt>UL1-DL2</dt>
|
996
|
+
<dd>UL1-DD2</dd>
|
997
|
+
</dl>
|
998
|
+
</li>
|
999
|
+
|
1000
|
+
<li>UL2</li>
|
1001
|
+
</ul>
|
1002
|
+
```
|
1003
|
+
|
1004
|
+
(試験実装のため、命令名や挙動は今後のバージョンで変更になる可能性があります。)
|
1005
|
+
|
918
1006
|
## インライン命令
|
919
1007
|
主なインライン命令を次に示します。
|
920
1008
|
|
@@ -934,6 +1022,8 @@ LaTeXビルダを使用している場合:
|
|
934
1022
|
* `@<ttb>{〜}` : 等幅+太字にします。
|
935
1023
|
* `@<code>{〜}` : 等幅にします(コードの引用という性質)。
|
936
1024
|
* `@<tcy>{〜}` : 縦書きの文書において文字を縦中横にします。
|
1025
|
+
* `@<ins>{〜}` : 挿入箇所を明示します(デフォルトでは下線が引かれます)。
|
1026
|
+
* `@<del>{〜}` : 削除箇所を明示します(デフォルトでは打ち消し線が引かれます)。
|
937
1027
|
|
938
1028
|
### 参照
|
939
1029
|
* `@<chap>{章ファイル名}` : 「第17章」のような、章番号を含むテキストに置換されます。
|