review 3.1.0 → 5.0.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-win.yml +45 -0
- data/.github/workflows/ruby.yml +27 -0
- data/.rubocop.yml +161 -34
- data/.travis.yml +16 -15
- data/Dockerfile +21 -5
- data/NEWS.ja.md +394 -0
- data/NEWS.md +395 -1
- data/README.md +10 -7
- data/appveyor.yml +1 -3
- data/bin/review-catalog-converter +5 -5
- data/bin/review-check +10 -12
- data/bin/review-checkdep +2 -2
- data/bin/review-compile +17 -23
- data/bin/review-epubmaker +3 -35
- data/bin/review-idgxmlmaker +16 -0
- data/bin/review-index +2 -89
- data/bin/review-preproc +13 -13
- data/bin/review-validate +4 -4
- data/bin/review-vol +4 -78
- data/doc/config.yml.sample +47 -12
- data/doc/config.yml.sample-simple +3 -2
- data/doc/format.ja.md +120 -17
- data/doc/format.md +119 -27
- data/doc/makeindex.ja.md +2 -2
- data/doc/pdfmaker.ja.md +43 -1
- data/doc/pdfmaker.md +42 -1
- data/doc/quickstart.ja.md +45 -25
- data/doc/quickstart.md +37 -16
- data/lib/epubmaker/content.rb +3 -2
- data/lib/epubmaker/epubcommon.rb +34 -27
- data/lib/epubmaker/epubv2.rb +5 -6
- data/lib/epubmaker/epubv3.rb +21 -18
- data/lib/epubmaker/producer.rb +2 -1
- data/lib/review/book.rb +2 -2
- data/lib/review/book/base.rb +91 -96
- data/lib/review/book/bib.rb +21 -0
- data/lib/review/book/book_unit.rb +155 -0
- data/lib/review/book/chapter.rb +48 -29
- data/lib/review/book/index.rb +46 -240
- data/lib/review/book/index/item.rb +46 -0
- data/lib/review/book/page_metric.rb +7 -7
- data/lib/review/book/part.rb +45 -10
- data/lib/review/book/volume.rb +4 -5
- data/lib/review/builder.rb +172 -56
- data/lib/review/catalog.rb +14 -17
- data/lib/review/compiler.rb +219 -121
- data/lib/review/configure.rb +39 -7
- data/lib/review/converter.rb +1 -1
- data/lib/review/epub2html.rb +43 -5
- data/lib/review/epubmaker.rb +69 -27
- data/lib/review/extentions/string.rb +0 -4
- data/lib/review/htmlbuilder.rb +112 -101
- data/lib/review/htmlutils.rb +9 -13
- data/lib/review/i18n.rb +3 -3
- data/lib/review/idgxmlbuilder.rb +202 -78
- data/lib/review/idgxmlmaker.rb +186 -0
- data/lib/review/index_builder.rb +653 -0
- data/lib/review/init-web/finish.html +10 -0
- data/lib/review/init-web/index.html +190 -0
- data/lib/review/init-web/review-layout-design.js +691 -0
- data/lib/review/init.rb +129 -46
- data/lib/review/latexbuilder.rb +255 -92
- data/lib/review/lineinput.rb +1 -1
- data/lib/review/location.rb +32 -0
- data/lib/review/logger.rb +4 -8
- data/lib/review/makerhelper.rb +35 -5
- data/lib/review/markdownbuilder.rb +50 -38
- data/lib/review/md2inaobuilder.rb +3 -5
- data/lib/review/pdfmaker.rb +60 -57
- data/lib/review/plaintextbuilder.rb +154 -87
- data/lib/review/preprocessor.rb +20 -42
- data/lib/review/rstbuilder.rb +57 -38
- data/lib/review/sec_counter.rb +13 -0
- data/lib/review/textmaker.rb +23 -15
- data/lib/review/textutils.rb +76 -2
- data/lib/review/tocprinter.rb +230 -102
- data/lib/review/topbuilder.rb +139 -60
- data/lib/review/update.rb +24 -24
- data/lib/review/version.rb +1 -1
- data/lib/review/volumeprinter.rb +98 -0
- data/lib/review/webmaker.rb +20 -24
- data/lib/review/webtocprinter.rb +38 -35
- data/lib/review/yamlloader.rb +26 -16
- data/review.gemspec +6 -4
- data/samples/sample-book/README.md +7 -2
- data/samples/sample-book/src/.gitignore +154 -0
- data/samples/sample-book/src/config-ebook.yml +4 -0
- data/samples/sample-book/src/config-jlreq-ebook.yml +4 -0
- data/samples/sample-book/src/config-jlreq.yml +6 -0
- data/samples/sample-book/src/config.yml +2 -2
- data/samples/sample-book/src/lib/tasks/review.rake +29 -14
- data/samples/sample-book/src/lib/tasks/z01_copy_sty.rake +14 -8
- data/samples/syntax-book/Gemfile +1 -1
- data/samples/syntax-book/ch01.re +4 -2
- data/samples/syntax-book/ch02.re +8 -16
- data/samples/syntax-book/ch03.re +3 -6
- data/samples/syntax-book/config-jlreq-lualatex.yml +4 -0
- data/samples/syntax-book/config-jlreq.yml +5 -0
- data/samples/syntax-book/config-print.yml +3 -0
- data/samples/syntax-book/config.yml +1 -1
- data/samples/syntax-book/lib/tasks/review.rake +30 -15
- data/samples/syntax-book/lib/tasks/z01_copy_sty.rake +14 -8
- data/templates/latex/config.erb +39 -25
- data/templates/latex/layout.tex.erb +1 -0
- data/templates/latex/review-jlreq/README.md +3 -1
- data/templates/latex/review-jlreq/review-base.sty +161 -50
- data/templates/latex/review-jlreq/review-jlreq.cls +21 -22
- data/templates/latex/review-jlreq/review-style.sty +4 -1
- data/templates/latex/review-jsbook/README.md +46 -5
- data/templates/latex/review-jsbook/review-base.sty +123 -35
- data/templates/latex/review-jsbook/review-jsbook.cls +10 -4
- data/templates/latex/review-jsbook/review-style.sty +5 -2
- data/templates/opf/epubv3.opf.erb +1 -0
- data/templates/web/html/layout-html5.html.erb +3 -3
- data/test/assets/test_template.tex +19 -7
- data/test/assets/test_template_backmatter.tex +19 -7
- data/test/book_test_helper.rb +11 -5
- data/test/test_book.rb +124 -79
- data/test/test_book_chapter.rb +97 -54
- data/test/test_book_part.rb +3 -3
- data/test/test_builder.rb +38 -13
- data/test/test_catalog.rb +24 -42
- data/test/test_catalog_converter_cmd.rb +1 -1
- data/test/test_converter.rb +1 -0
- data/test/test_epub3maker.rb +2 -2
- data/test/test_epubmaker.rb +8 -0
- data/test/test_epubmaker_cmd.rb +14 -7
- data/test/test_helper.rb +18 -7
- data/test/test_htmlbuilder.rb +1491 -205
- data/test/test_htmlutils.rb +0 -12
- data/test/test_i18n.rb +37 -37
- data/test/test_idgxmlbuilder.rb +744 -42
- data/test/test_idgxmlmaker_cmd.rb +46 -0
- data/test/test_image_finder.rb +52 -70
- data/test/test_index.rb +94 -44
- data/test/test_indexbuilder.rb +52 -0
- data/test/test_latexbuilder.rb +1784 -161
- data/test/test_latexbuilder_v2.rb +671 -102
- data/test/test_logger.rb +17 -4
- data/test/test_makerhelper.rb +2 -14
- data/test/test_markdownbuilder.rb +137 -16
- data/test/test_md2inaobuilder.rb +32 -9
- data/test/test_pdfmaker.rb +30 -12
- data/test/test_pdfmaker_cmd.rb +100 -6
- data/test/test_plaintextbuilder.rb +791 -30
- data/test/test_preprocessor.rb +2 -16
- data/test/test_review_ext.rb +2 -1
- data/test/test_rstbuilder.rb +274 -27
- data/test/test_sec_counter.rb +156 -0
- data/test/test_textmaker_cmd.rb +54 -0
- data/test/test_textutils.rb +109 -2
- data/test/test_topbuilder.rb +724 -34
- data/test/test_update.rb +20 -11
- data/test/test_webtocprinter.rb +75 -43
- data/test/test_yamlloader.rb +13 -0
- 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/LICENSE +1 -1
- 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 +74 -31
- data/vendor/jsclasses/jis/jsbook.cls +74 -31
- data/vendor/jsclasses/jis/jsclasses.dtx +176 -36
- data/vendor/jsclasses/jis/jsclasses.ins +15 -5
- data/vendor/jsclasses/jis/jslogo.dtx +4 -4
- data/vendor/jsclasses/jis/jslogo.ins +9 -0
- data/vendor/jsclasses/jis/jslogo.sty +4 -16
- data/vendor/jsclasses/jis/jspf.cls +73 -30
- data/vendor/jsclasses/jis/jsreport.cls +74 -31
- data/vendor/jsclasses/jis/jsverb.ins +9 -0
- data/vendor/jsclasses/jis/jsverb.sty +1 -13
- data/vendor/jsclasses/jis/kiyou.cls +74 -31
- data/vendor/jsclasses/jis/minijs.sty +65 -22
- data/vendor/jsclasses/jis/okumacro.dtx +4 -5
- data/vendor/jsclasses/jis/okumacro.ins +9 -0
- data/vendor/jsclasses/jis/okumacro.sty +4 -17
- 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 +74 -31
- data/vendor/jsclasses/jsbook.cls +74 -31
- data/vendor/jsclasses/jsclasses.dtx +176 -36
- data/vendor/jsclasses/jsclasses.ins +15 -5
- data/vendor/jsclasses/jsclasses.pdf +0 -0
- data/vendor/jsclasses/jslogo.dtx +4 -4
- data/vendor/jsclasses/jslogo.ins +9 -0
- data/vendor/jsclasses/jslogo.pdf +0 -0
- data/vendor/jsclasses/jslogo.sty +4 -16
- data/vendor/jsclasses/jspf.cls +73 -30
- data/vendor/jsclasses/jsreport.cls +74 -31
- 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 +74 -31
- data/vendor/jsclasses/minijs.sty +68 -22
- data/vendor/jsclasses/okumacro.dtx +4 -5
- data/vendor/jsclasses/okumacro.ins +9 -0
- data/vendor/jsclasses/okumacro.pdf +0 -0
- data/vendor/jsclasses/okumacro.sty +4 -17
- 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 +65 -12
- data/.rubocop_todo.yml +0 -7
- data/lib/review/book/compilable.rb +0 -173
- data/lib/review/tocparser.rb +0 -271
- data/samples/syntax-book/review-ext.rb +0 -14
- data/test/test_tocparser.rb +0 -25
data/bin/review-preproc
CHANGED
@@ -39,7 +39,7 @@ def main
|
|
39
39
|
if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
|
40
40
|
@logger.warn 'review-preproc-ext.rb is prohibited in safe mode. ignored.'
|
41
41
|
else
|
42
|
-
Kernel.load
|
42
|
+
Kernel.load(File.expand_path('review-preproc-ext.rb'))
|
43
43
|
end
|
44
44
|
end
|
45
45
|
|
@@ -59,8 +59,8 @@ def main
|
|
59
59
|
end
|
60
60
|
begin
|
61
61
|
opts.parse!
|
62
|
-
rescue OptionParser::ParseError =>
|
63
|
-
@logger.error
|
62
|
+
rescue OptionParser::ParseError => e
|
63
|
+
@logger.error e.message
|
64
64
|
$stderr.puts opts.help
|
65
65
|
exit 1
|
66
66
|
end
|
@@ -71,35 +71,35 @@ def main
|
|
71
71
|
current_file = path
|
72
72
|
case mode
|
73
73
|
when :output
|
74
|
-
File.open(path) { |f| pp.process
|
74
|
+
File.open(path) { |f| pp.process(f, $stdout) }
|
75
75
|
when :replace
|
76
|
-
File.write
|
77
|
-
File.rename
|
76
|
+
File.write("#{path}.pptmp", preproc(pp, path))
|
77
|
+
File.rename("#{path}.pptmp", path)
|
78
78
|
when :diff, :check
|
79
79
|
tmp = '/tmp/review.pptmp'
|
80
80
|
begin
|
81
|
-
File.write
|
81
|
+
File.write(tmp, preproc(pp, path))
|
82
82
|
if mode == :check
|
83
|
-
system
|
83
|
+
system("diff -qu #{path} #{tmp} >/dev/null || echo #{path}")
|
84
84
|
else
|
85
|
-
system
|
85
|
+
system("diff -u #{path} #{tmp}")
|
86
86
|
end
|
87
87
|
ensure
|
88
|
-
FileUtils.rm_f
|
88
|
+
FileUtils.rm_f(tmp)
|
89
89
|
end
|
90
90
|
else
|
91
91
|
raise "must not happen: #{mode}"
|
92
92
|
end
|
93
93
|
end
|
94
|
-
rescue ReVIEW::Error =>
|
94
|
+
rescue ReVIEW::Error => e
|
95
95
|
raise if $DEBUG
|
96
|
-
@logger.error
|
96
|
+
@logger.error e.message
|
97
97
|
exit 1
|
98
98
|
end
|
99
99
|
|
100
100
|
def preproc(pp, path)
|
101
101
|
buf = StringIO.new
|
102
|
-
File.open(path) { |f| pp.process
|
102
|
+
File.open(path) { |f| pp.process(f, buf) }
|
103
103
|
buf.string
|
104
104
|
end
|
105
105
|
|
data/bin/review-validate
CHANGED
@@ -1,5 +1,5 @@
|
|
1
1
|
#!/usr/bin/env ruby
|
2
|
-
# Copyright (c) 2010-
|
2
|
+
# Copyright (c) 2010-2019 Kenshi Muto
|
3
3
|
#
|
4
4
|
# This program is free software
|
5
5
|
# You can distribute or modify this program under the terms of
|
@@ -30,7 +30,7 @@ ARGF.each do |line|
|
|
30
30
|
@logger.warn "#{ln}: block #{new_block} started, but previous block #{block} didn't close yet."
|
31
31
|
end
|
32
32
|
block = new_block
|
33
|
-
elsif line
|
33
|
+
elsif line.start_with?('//}')
|
34
34
|
if block.nil?
|
35
35
|
@logger.warn "#{ln}: block ended, but not opened."
|
36
36
|
end
|
@@ -48,12 +48,12 @@ ARGF.each do |line|
|
|
48
48
|
@logger.warn "#{ln}: found '*' without the head space. Is it correct?"
|
49
49
|
end
|
50
50
|
elsif line =~ /\A\s+(\d+\.)\s+/ && line =~ /\A\s+\*\s+/
|
51
|
-
unless
|
51
|
+
unless %w[list emlist listnum emlistnum cmd image table].include?(block)
|
52
52
|
@logger.warn "#{ln}: found itemized list or numbered list in #{block}. Is it correct?"
|
53
53
|
end
|
54
54
|
elsif block == 'table'
|
55
55
|
next if line.start_with?('#@')
|
56
|
-
if line !~ /\A
|
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.
|
@@ -14,82 +14,8 @@ require 'pathname'
|
|
14
14
|
bindir = Pathname.new(__FILE__).realpath.dirname
|
15
15
|
$LOAD_PATH.unshift((bindir + '../lib').realpath)
|
16
16
|
|
17
|
-
require 'review'
|
18
|
-
require 'optparse'
|
17
|
+
require 'review/volumeprinter'
|
19
18
|
|
20
|
-
|
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 => err
|
41
|
-
@logger.error err.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 => err
|
74
|
-
raise if $DEBUG
|
75
|
-
@logger.error "#{File.basename($PROGRAM_NAME)}: #{err.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
|
19
|
+
if File.basename($PROGRAM_NAME) == File.basename(__FILE__)
|
20
|
+
ReVIEW::VolumePrinter.execute(*ARGV)
|
85
21
|
end
|
86
|
-
|
87
|
-
def print_volume(vol)
|
88
|
-
printf " %3dKB %6dC %5dL %3dP\n", vol.kbytes, vol.chars, vol.lines, vol.page
|
89
|
-
end
|
90
|
-
|
91
|
-
def chapnumstr(n)
|
92
|
-
n ? sprintf('%2d.', n) : ' '
|
93
|
-
end
|
94
|
-
|
95
|
-
main
|
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
|
# 呼び出し元の値が優先される。
|
@@ -64,6 +64,8 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
|
|
64
64
|
# a-trc, trc: 筆記・タイプ作業者
|
65
65
|
# a-trl, trl: 翻訳者
|
66
66
|
|
67
|
+
# contact: 連絡先
|
68
|
+
|
67
69
|
# 刊行日(省略した場合は実行時の日付)
|
68
70
|
# date: 2018-11-11
|
69
71
|
# 発行年月。YYYY-MM-DD形式による配列指定。省略した場合はdateを使用する
|
@@ -72,7 +74,7 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
|
|
72
74
|
# 日付の後ろを空白文字で区切り、任意の文字列を置くことも可能。
|
73
75
|
# history: [["2016-04-20 v1.0.0版発行", "2018-11-11 v3.0.0版発行"]]
|
74
76
|
# 権利表記(配列で複数指定可)
|
75
|
-
# rights: (C) 2016-
|
77
|
+
# rights: (C) 2016-2020 Re:VIEW Developers
|
76
78
|
# description: 説明
|
77
79
|
# subject: 短い説明用タグ(配列で複数指定可)
|
78
80
|
# type: 書籍のカテゴリーなど(配列で複数指定可)
|
@@ -90,6 +92,9 @@ debug: null
|
|
90
92
|
# ISBN。省略した場合はurnidが入る
|
91
93
|
# isbn: null
|
92
94
|
#
|
95
|
+
# @<chap>, @<chapref>, @<title>, @<hd>命令をハイパーリンクにする(nullでハイパーリンクにしない)
|
96
|
+
# chapterlink: true
|
97
|
+
|
93
98
|
# HTMLファイルの拡張子(省略した場合はhtml)
|
94
99
|
# htmlext: html
|
95
100
|
#
|
@@ -111,7 +116,7 @@ toclevel: 3
|
|
111
116
|
secnolevel: 2
|
112
117
|
|
113
118
|
# 本文中に目次ページを作成するか。省略した場合はnull (作成しない)
|
114
|
-
|
119
|
+
toc: true
|
115
120
|
|
116
121
|
# EPUB2標準の目次(NCX)以外に物理目次ファイルを作成するか。省略した場合はnull (作成しない)
|
117
122
|
# ePUB3においてはこの設定によらず必ず作成される
|
@@ -137,7 +142,10 @@ secnolevel: 2
|
|
137
142
|
# creditfile: null
|
138
143
|
|
139
144
|
# 奥付を作成するか。デフォルトでは作成されない。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
|
145
|
+
# デフォルトの奥付における各項目の名前(「著 者」など)を変えたいときにはlocale.ymlで文字列を設定する(詳細はdoc/format.ja.mdを参照)
|
140
146
|
# colophon: null
|
147
|
+
# デフォルトの奥付における、各項目の記載順序
|
148
|
+
# colophon_order: ["aut", "csl", "trl", "dsr", "ill", "cov", "edt", "pbl", "contact", "prt"]
|
141
149
|
|
142
150
|
# 裏表紙データファイル (PDFMaker向けにはLaTeXソース断片、EPUBMaker向けにはHTMLファイル)
|
143
151
|
# backcover: null
|
@@ -173,18 +181,34 @@ secnolevel: 2
|
|
173
181
|
# reファイルを格納するディレクトリ。省略した場合は以下 (. はカレントディレクトリを示す)
|
174
182
|
# contentdir: .
|
175
183
|
|
176
|
-
# @<w
|
184
|
+
# @<w>命令で使用する単語ファイルのパス。["common.csv", "mybook.csv"]のように配列指定も可
|
177
185
|
# words_file: words.csv
|
178
186
|
|
179
|
-
#
|
180
|
-
#
|
187
|
+
# //table命令における列の区切り文字。tabs (1文字以上のタブ文字区切り。デフォルト), singletab (1文字のタブ文字区切り), spaces (1文字以上のスペースまたはタブ文字の区切り), verticalbar ("0個以上の空白 | 0個以上の空白"の区切り)
|
188
|
+
# table_row_separator: tabs
|
189
|
+
|
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)
|
181
205
|
# page_metric: A5
|
182
206
|
#
|
183
207
|
# あるいは、配列で指定することもできる
|
184
|
-
# 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1
|
185
|
-
# page_metric: [40,
|
208
|
+
# 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数
|
209
|
+
# page_metric: [40,34,29,34]
|
186
210
|
|
187
|
-
# EPUB
|
211
|
+
# EPUB・Web、およびテキスト生成時における数式の画像化指定
|
188
212
|
# TeXの数式を画像化するか。省略した場合はnull (作成しない)
|
189
213
|
# imgmath: true
|
190
214
|
|
@@ -211,14 +235,20 @@ secnolevel: 2
|
|
211
235
|
# pdfcrop_cmd: "pdfcrop --hires %i %o"
|
212
236
|
# PDFから画像化するコマンドのコマンドライン。プレースホルダは
|
213
237
|
# %i: 入力ファイル、%o: 出力ファイル、%O: 出力ファイルから拡張子を除いたもの
|
214
|
-
# %p:
|
215
|
-
# pdfcrop_pixelize_cmd: "pdftocairo
|
238
|
+
# %p: 対象ページ番号、%t: フォーマット
|
239
|
+
# pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p -singlefile %i %O"
|
216
240
|
# pdfcrop_pixelize_cmdが複数ページの処理に対応していない場合に単ページ化するか
|
217
241
|
# extract_singlepage: null
|
218
242
|
# extract_singlepageがtrueの場合に単ページ化するコマンドのコマンドライン
|
219
243
|
# pdfextract_cmd: "pdfjam -q --outfile %o %i %p"
|
220
244
|
# converterにdvipngを指定したときのdvipngコマンドのコマンドライン
|
221
245
|
# dvipng_cmd: "dvipng -T tight -z 9 -p %p -l %p -o %o %i"
|
246
|
+
#
|
247
|
+
# PDFで保存したいときにはたとえば以下のようにする
|
248
|
+
# format: pdf
|
249
|
+
# extract_singlepage: true
|
250
|
+
# pdfextract_cmd: "pdftk A=%i cat A%p output %o"
|
251
|
+
# pdfcrop_pixelize_cmd: "mv %i %o"
|
222
252
|
|
223
253
|
# EPUBにおけるページ送りの送り方向、page-progression-directionの値("ltr"|"rtl"|"default")
|
224
254
|
# direction: "ltr"
|
@@ -322,7 +352,7 @@ epubmaker:
|
|
322
352
|
# texcommand: "uplatex"
|
323
353
|
#
|
324
354
|
# LaTeXのコマンドに渡すオプションを指定する
|
325
|
-
# texoptions: "-interaction=nonstopmode -file-line-error"
|
355
|
+
# texoptions: "-interaction=nonstopmode -file-line-error -halt-on-error"
|
326
356
|
#
|
327
357
|
# LaTeX用のdvi変換コマンドを指定する(dvipdfmx)
|
328
358
|
# dvicommand: "dvipdfmx"
|
@@ -367,6 +397,9 @@ pdfmaker:
|
|
367
397
|
# 画像のscale=X.Xという指定を画像拡大縮小率からページ最大幅の相対倍率に変換する
|
368
398
|
# image_scale2width: true
|
369
399
|
#
|
400
|
+
# 画像のデフォルトのサイズを、版面横幅合わせではなく、原寸をそのまま利用する
|
401
|
+
# use_original_image_size: null
|
402
|
+
#
|
370
403
|
# PDFやIllustratorファイル(.ai)の画像のBoudingBoxの抽出に指定のボックスを採用する
|
371
404
|
# cropbox(デフォルト), mediabox, artbox, trimbox, bleedboxから選択する。
|
372
405
|
# Illustrator CC以降のIllustratorファイルに対してはmediaboxを指定する必要がある
|
@@ -388,4 +421,6 @@ pdfmaker:
|
|
388
421
|
# makeindex_mecab_opts: "-Oyomi"
|
389
422
|
# 奥付を作成するか。trueを指定するとデフォルトの奥付、ファイル名を指定するとそれがcolophon.htmlとしてコピーされる
|
390
423
|
colophon: true
|
424
|
+
# 表紙挿入時に表紙のページ番号名を「cover」とし、偶数ページ扱いにして大扉前に白ページが入るのを防ぐ。デフォルトはtrue
|
425
|
+
# use_cover_nombre: true
|
391
426
|
# 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
|
|
@@ -20,9 +20,10 @@ aut: ["Masayoshi Takahashi"]
|
|
20
20
|
# edt: null
|
21
21
|
pbl: "Re:VIEW Publishing inc."
|
22
22
|
prt: "Re:VIEW Printing inc."
|
23
|
+
contact: "https://reviewml.org/"
|
23
24
|
date: 2018-11-11
|
24
25
|
history: [["2012-01-30"],["2016-04-20","2016-05-03"],["2018-11-11"]]
|
25
|
-
rights: (C) 2016-
|
26
|
+
rights: (C) 2016-2020 Re:VIEW Commiters, some rights reserved.
|
26
27
|
description: sample config.yml file for Re:VIEW book
|
27
28
|
urnid: urn:uid:http://reviewml.org/review-sample-book
|
28
29
|
# isbn: null
|
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.0 に基づいています。
|
6
6
|
|
7
7
|
## 段落
|
8
8
|
|
@@ -20,9 +20,9 @@ Re:VIEW フォーマットの文法について解説します。Re:VIEW フォ
|
|
20
20
|
* 2行以上空けても、1行空きと同じ意味になります。
|
21
21
|
* 空行せずに改行して段落の記述を続ける際、英文の単語間スペースについては考慮されないことに注意してください。Re:VIEW は各行を単純に連結するだけであり、TeX のように前後の単語を判断してスペースを入れるようなことはしません。
|
22
22
|
|
23
|
-
##
|
23
|
+
## 章・節・項・目・段(見出し)
|
24
24
|
|
25
|
-
|
25
|
+
章・節・項・目といった見出しは「`=`」「`==`」「`===`」「`====`」「`=====`」で表します。7 レベル以上は使えません。`=`のあとにはスペースを入れます。
|
26
26
|
|
27
27
|
例:
|
28
28
|
|
@@ -33,9 +33,11 @@ Re:VIEW フォーマットの文法について解説します。Re:VIEW フォ
|
|
33
33
|
|
34
34
|
=== 項のキャプション
|
35
35
|
|
36
|
-
====
|
36
|
+
==== 目のキャプション
|
37
37
|
|
38
|
-
=====
|
38
|
+
===== 段のキャプション
|
39
|
+
|
40
|
+
====== 小段のキャプション
|
39
41
|
```
|
40
42
|
|
41
43
|
見出しは行の先頭から始める必要があります。行頭に空白を入れると、ただの本文と見なされます。
|
@@ -253,7 +255,6 @@ puts "hello world!"
|
|
253
255
|
//}
|
254
256
|
```
|
255
257
|
|
256
|
-
|
257
258
|
### ソースコード専用の引用
|
258
259
|
|
259
260
|
ソースコードを引用するには次のように記述します。
|
@@ -262,11 +263,23 @@ puts "hello world!"
|
|
262
263
|
|
263
264
|
```review
|
264
265
|
//source[/hello/world.rb]{
|
265
|
-
puts "hello world!"
|
266
|
+
puts "hello world!" # キャプションあり
|
267
|
+
//}
|
268
|
+
|
269
|
+
//source{
|
270
|
+
puts "hello world!" # キャプションなし
|
271
|
+
//}
|
272
|
+
|
273
|
+
//source[/hello/world.rb][ruby]{
|
274
|
+
puts "hello world!" # キャプションあり、ハイライトあり
|
275
|
+
//}
|
276
|
+
|
277
|
+
//source[][ruby]{
|
278
|
+
puts "hello world!" # キャプションなし、ハイライトあり
|
266
279
|
//}
|
267
280
|
```
|
268
281
|
|
269
|
-
|
282
|
+
ソースコードの引用は、`//emlist` とほぼ同じです。HTML の CSS などでは区別した表現ができます。
|
270
283
|
|
271
284
|
## 本文中でのソースコード引用
|
272
285
|
|
@@ -310,7 +323,7 @@ V1 --> V6 --|
|
|
310
323
|
//}
|
311
324
|
```
|
312
325
|
|
313
|
-
3番目の引数として、画像の倍率・大きさを指定することができます。今のところ「scale=X」で倍率(X 倍)を指定でき、HTML、TeX ともに紙面(画面)幅に対しての倍率となります(0.5 なら半分の幅になります)。
|
326
|
+
3番目の引数として、画像の倍率・大きさを指定することができます。今のところ「scale=X」で倍率(X 倍)を指定でき、HTML、TeX ともに紙面(画面)幅に対しての倍率となります(0.5 なら半分の幅になります)。3番目の引数をたとえば HTML と TeX で分けたい場合は、`html::style="transform: scale(0.5);",latex::scale=0.5` のように `::` でビルダを明示し、`,` でオプションを区切って指定できます。
|
314
327
|
|
315
328
|
※TeX において原寸からの倍率にしたいときには、`config.yml` に `image_scale2width: false` を指定してください。
|
316
329
|
|
@@ -489,6 +502,19 @@ complexmatrixという識別子に基づく画像ファイルが貼り込まれ
|
|
489
502
|
|
490
503
|
内容には、空行で区切って複数の段落を記述可能です。
|
491
504
|
|
505
|
+
Re:VIEW 5.0 以降では、囲み記事に箇条書きや図表・リストを含めることもできます。
|
506
|
+
|
507
|
+
```
|
508
|
+
//note{
|
509
|
+
|
510
|
+
箇条書きを含むノートです。
|
511
|
+
|
512
|
+
1. 箇条書き1
|
513
|
+
2. 箇条書き2
|
514
|
+
|
515
|
+
//}
|
516
|
+
```
|
517
|
+
|
492
518
|
## 脚注
|
493
519
|
|
494
520
|
脚注は「`//footnote`」を使って記述します。
|
@@ -503,14 +529,13 @@ complexmatrixという識別子に基づく画像ファイルが貼り込まれ
|
|
503
529
|
|
504
530
|
本文中のインライン命令「`@<fn>{site}`」は脚注番号に置換され、「本書のサポートサイト……」という文は実際の脚注に変換されます。
|
505
531
|
|
506
|
-
注意: TeX PDF
|
532
|
+
注意: TeX PDF において、コラムの中で脚注を利用する場合、`//footnote` 行はコラムの終わり(`==[/column]` など)の後ろに記述することをお勧めします。Re:VIEW の標準提供のコラム表現では問題ありませんが、サードパーティのコラムの実装によってはおかしな採番表現になることがあります。
|
507
533
|
|
508
534
|
### footnotetext オプション
|
535
|
+
TeX PDF において、コラム以外の `//note` などの囲み記事の中で「`@<fn>{~}`」を使うには、`footnotetext` オプションを使う必要があります。
|
509
536
|
|
510
537
|
`footnotetext` オプションを使うには、`config.yml` ファイルに`footnotetext: true` を追加します。
|
511
538
|
|
512
|
-
これで PDF のコラムや表のなかでも脚注が使えるようになります。
|
513
|
-
|
514
539
|
ただし、通常の脚注(footnote)ではなく、footnotemark と footnotetext を使うため、本文と脚注が別ページに分かれる可能性があるなど、いろいろな制約があります。また、採番が別々になるため、footnote と footnotemark/footnotetext を両立させることはできません。
|
515
540
|
|
516
541
|
## 参考文献の定義
|
@@ -576,7 +601,7 @@ LaTeX の式を挿入するには、`//texequation{ 〜 //}` を使います。
|
|
576
601
|
「式1.1」のように連番を付けたいときには、識別子とキャプションを指定します。
|
577
602
|
|
578
603
|
```
|
579
|
-
//
|
604
|
+
//texequation[emc][質量とエネルギーの等価性]{
|
580
605
|
\sum_{i=1}^nf_n(x)
|
581
606
|
//}
|
582
607
|
```
|
@@ -636,8 +661,8 @@ imgmath_options:
|
|
636
661
|
pdfcrop_cmd: "pdfcrop --hires %i %o"
|
637
662
|
# PDFから画像化するコマンドのコマンドライン。プレースホルダは
|
638
663
|
# %i: 入力ファイル、%o: 出力ファイル、%O: 出力ファイルから拡張子を除いたもの
|
639
|
-
# %p:
|
640
|
-
pdfcrop_pixelize_cmd: "pdftocairo
|
664
|
+
# %p: 対象ページ番号、%t: フォーマット
|
665
|
+
pdfcrop_pixelize_cmd: "pdftocairo -%t -r 90 -f %p -l %p -singlefile %i %O"
|
641
666
|
# pdfcrop_pixelize_cmdが複数ページの処理に対応していない場合に単ページ化するか
|
642
667
|
extract_singlepage: null
|
643
668
|
# 単ページ化するコマンドのコマンドライン
|
@@ -671,6 +696,17 @@ imgmath_options:
|
|
671
696
|
pdfcrop_pixelize_cmd: "sips -s format png --out %o %i"
|
672
697
|
```
|
673
698
|
|
699
|
+
textmaker 向けに PDF 形式の数式ファイルを作成したいときには、たとえば以下のように設定します(ページの抽出には pdftk を利用)。
|
700
|
+
|
701
|
+
```
|
702
|
+
imgmath: true
|
703
|
+
imgmath_options:
|
704
|
+
format: pdf
|
705
|
+
extract_singlepage: true
|
706
|
+
pdfextract_cmd: "pdftk A=%i cat A%p output %o"
|
707
|
+
pdfcrop_pixelize_cmd: "mv %i %o"
|
708
|
+
```
|
709
|
+
|
674
710
|
Re:VIEW 2 以前の dvipng の設定に合わせるには、次のようにします。
|
675
711
|
|
676
712
|
```
|
@@ -778,7 +814,7 @@ Web ハイパーリンクを記述するには、リンクに `@<href>`、アン
|
|
778
814
|
"i18n","""i""nternationalizatio""n"""
|
779
815
|
```
|
780
816
|
|
781
|
-
単語ファイルのファイルパスは、`config.yml` に `words_file: ファイルパス`
|
817
|
+
単語ファイルのファイルパスは、`config.yml` に `words_file: ファイルパス` で指定します。`word_file: ["common.csv", "mybook.csv"]` のように複数のファイルも指定可能です(同一のキーがあるときには後に指定したファイルの値が優先されます)。
|
782
818
|
|
783
819
|
例:
|
784
820
|
|
@@ -888,9 +924,76 @@ LaTeXビルダを使用している場合:
|
|
888
924
|
|
889
925
|
```
|
890
926
|
|
891
|
-
|
892
927
|
`//raw`、`//embed`、`@<raw>` および `@<embed>` は、HTML、XML や TeX の文書構造を容易に壊す可能性があります。使用には十分に注意してください。
|
893
928
|
|
929
|
+
### 入れ子の箇条書き
|
930
|
+
|
931
|
+
Re:VIEW の箇条書きは `*` 型の箇条書きを除き、基本的に入れ子を表現できません。いずれの箇条書きも、別の箇条書き、あるいは図表・リストを箇条書きの途中に配置することを許容していません。
|
932
|
+
|
933
|
+
この対策として、Re:VIEW 4.2 では試験的に `//beginchild`、`//endchild` というブロック命令を追加しています。箇条書きの途中に何かを含めたいときには、それを `//beginchild` 〜 `//endchild` で囲んで配置します。多重に入れ子にすることも可能です。
|
934
|
+
|
935
|
+
```
|
936
|
+
* UL1
|
937
|
+
|
938
|
+
//beginchild
|
939
|
+
#@# ここからUL1の子
|
940
|
+
|
941
|
+
1. UL1-OL1
|
942
|
+
|
943
|
+
//beginchild
|
944
|
+
#@# ここからUL1-OL1の子
|
945
|
+
|
946
|
+
UL1-OL1-PARAGRAPH
|
947
|
+
|
948
|
+
* UL1-OL1-UL1
|
949
|
+
* UL1-OL1-UL2
|
950
|
+
|
951
|
+
//endchild
|
952
|
+
#@# ここまでUL1-OL1の子
|
953
|
+
|
954
|
+
2. UL1-OL2
|
955
|
+
|
956
|
+
: UL1-DL1
|
957
|
+
UL1-DD1
|
958
|
+
: UL1-DL2
|
959
|
+
UL1-DD2
|
960
|
+
|
961
|
+
//endchild
|
962
|
+
#@# ここまでUL1の子
|
963
|
+
|
964
|
+
* UL2
|
965
|
+
```
|
966
|
+
|
967
|
+
これをたとえば HTML に変換すると、次のようになります。
|
968
|
+
|
969
|
+
```
|
970
|
+
<ul>
|
971
|
+
<li>UL1
|
972
|
+
<ol>
|
973
|
+
<li>UL1-OL1
|
974
|
+
<p>UL1-OL1-PARAGRAPH</p>
|
975
|
+
<ul>
|
976
|
+
<li>UL1-OL1-UL1</li>
|
977
|
+
<li>UL1-OL1-UL2</li>
|
978
|
+
</ul>
|
979
|
+
</li>
|
980
|
+
|
981
|
+
<li>UL1-OL2</li>
|
982
|
+
</ol>
|
983
|
+
<dl>
|
984
|
+
<dt>UL1-DL1</dt>
|
985
|
+
<dd>UL1-DD1</dd>
|
986
|
+
<dt>UL1-DL2</dt>
|
987
|
+
<dd>UL1-DD2</dd>
|
988
|
+
</dl>
|
989
|
+
</li>
|
990
|
+
|
991
|
+
<li>UL2</li>
|
992
|
+
</ul>
|
993
|
+
```
|
994
|
+
|
995
|
+
(試験実装のため、命令名や挙動は今後のバージョンで変更になる可能性があります。)
|
996
|
+
|
894
997
|
## インライン命令
|
895
998
|
主なインライン命令を次に示します。
|
896
999
|
|