review 4.0.0 → 5.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (268) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ruby-tex.yml +31 -0
  3. data/.github/workflows/ruby-win.yml +45 -0
  4. data/.github/workflows/ruby.yml +27 -0
  5. data/.rubocop.yml +141 -38
  6. data/Dockerfile +21 -5
  7. data/NEWS.ja.md +338 -1
  8. data/NEWS.md +339 -2
  9. data/README.md +11 -7
  10. data/Rakefile +7 -2
  11. data/appveyor.yml +0 -20
  12. data/bin/review +2 -4
  13. data/bin/review-catalog-converter +4 -4
  14. data/bin/review-check +8 -12
  15. data/bin/review-checkdep +2 -5
  16. data/bin/review-compile +11 -20
  17. data/bin/review-epub2html +1 -4
  18. data/bin/review-epubmaker +3 -4
  19. data/bin/review-idgxmlmaker +1 -3
  20. data/bin/review-index +5 -86
  21. data/bin/review-init +1 -4
  22. data/bin/review-pdfmaker +1 -3
  23. data/bin/review-preproc +3 -5
  24. data/bin/review-textmaker +1 -3
  25. data/bin/review-update +1 -4
  26. data/bin/review-validate +5 -5
  27. data/bin/review-vol +5 -82
  28. data/bin/review-webmaker +1 -3
  29. data/doc/config.yml.sample +55 -12
  30. data/doc/config.yml.sample-simple +4 -3
  31. data/doc/format.ja.md +119 -17
  32. data/doc/format.md +106 -17
  33. data/doc/makeindex.ja.md +2 -2
  34. data/doc/pdfmaker.ja.md +42 -0
  35. data/doc/pdfmaker.md +41 -0
  36. data/doc/quickstart.ja.md +55 -25
  37. data/doc/quickstart.md +47 -17
  38. data/lib/review.rb +1 -1
  39. data/lib/review/book.rb +2 -2
  40. data/lib/review/book/base.rb +69 -30
  41. data/lib/review/book/bib.rb +21 -0
  42. data/lib/review/book/book_unit.rb +158 -0
  43. data/lib/review/book/chapter.rb +33 -26
  44. data/lib/review/book/index.rb +39 -206
  45. data/lib/review/book/index/item.rb +8 -2
  46. data/lib/review/book/page_metric.rb +7 -7
  47. data/lib/review/book/part.rb +26 -11
  48. data/lib/review/book/volume.rb +5 -5
  49. data/lib/review/builder.rb +124 -27
  50. data/lib/review/call_hook.rb +20 -0
  51. data/lib/review/catalog.rb +3 -2
  52. data/lib/review/compiler.rb +197 -91
  53. data/lib/review/configure.rb +95 -9
  54. data/lib/review/converter.rb +1 -1
  55. data/lib/review/epub2html.rb +6 -1
  56. data/lib/review/epubmaker.rb +116 -117
  57. data/lib/review/epubmaker/content.rb +113 -0
  58. data/lib/review/epubmaker/epubcommon.rb +372 -0
  59. data/lib/review/epubmaker/epubv2.rb +178 -0
  60. data/lib/review/epubmaker/epubv3.rb +231 -0
  61. data/lib/review/epubmaker/producer.rb +168 -0
  62. data/lib/review/epubmaker/reviewheaderlistener.rb +12 -2
  63. data/lib/review/epubmaker/zip_exporter.rb +84 -0
  64. data/lib/review/exception.rb +6 -0
  65. data/lib/review/extentions/string.rb +0 -4
  66. data/lib/review/htmlbuilder.rb +132 -87
  67. data/lib/review/htmlutils.rb +8 -11
  68. data/lib/review/i18n.rb +2 -1
  69. data/lib/review/idgxmlbuilder.rb +156 -76
  70. data/lib/review/idgxmlmaker.rb +22 -18
  71. data/lib/review/img_math.rb +245 -0
  72. data/lib/review/index_builder.rb +654 -0
  73. data/lib/review/init.rb +17 -18
  74. data/lib/review/latexbox.rb +58 -0
  75. data/lib/review/latexbuilder.rb +173 -43
  76. data/lib/review/latexutils.rb +9 -1
  77. data/lib/review/lineinput.rb +112 -2
  78. data/lib/review/logger.rb +42 -3
  79. data/lib/review/makerhelper.rb +12 -187
  80. data/lib/review/markdownbuilder.rb +51 -2
  81. data/lib/review/pdfmaker.rb +78 -73
  82. data/lib/review/plaintextbuilder.rb +98 -14
  83. data/lib/review/preprocessor.rb +18 -12
  84. data/lib/review/rstbuilder.rb +28 -9
  85. data/lib/review/sec_counter.rb +14 -0
  86. data/lib/review/template.rb +6 -0
  87. data/lib/review/textmaker.rb +21 -19
  88. data/lib/review/textutils.rb +3 -12
  89. data/lib/review/tocprinter.rb +242 -97
  90. data/lib/review/topbuilder.rb +91 -24
  91. data/lib/review/update.rb +12 -13
  92. data/lib/review/version.rb +1 -1
  93. data/lib/review/volumeprinter.rb +97 -0
  94. data/lib/review/webmaker.rb +34 -33
  95. data/lib/review/webtocprinter.rb +39 -35
  96. data/lib/review/yamlloader.rb +2 -1
  97. data/review.gemspec +5 -3
  98. data/samples/sample-book/src/.gitignore +1 -0
  99. data/samples/sample-book/src/config-ebook.yml +4 -0
  100. data/samples/sample-book/src/config-epub2.yml +1 -1
  101. data/samples/sample-book/src/config-jlreq-ebook.yml +4 -0
  102. data/samples/sample-book/src/config.yml +3 -3
  103. data/samples/sample-book/src/lib/tasks/review.rake +26 -6
  104. data/samples/syntax-book/Gemfile +1 -1
  105. data/samples/syntax-book/ch01.re +3 -1
  106. data/samples/syntax-book/ch02.re +28 -21
  107. data/samples/syntax-book/ch03.re +1 -1
  108. data/samples/syntax-book/config-jlreq-lualatex.yml +4 -0
  109. data/samples/syntax-book/config-print.yml +3 -0
  110. data/samples/syntax-book/config.yml +1 -1
  111. data/samples/syntax-book/images/img3-2.png +0 -0
  112. data/samples/syntax-book/lib/tasks/review.rake +23 -8
  113. data/templates/html/_colophon.html.erb +23 -0
  114. data/templates/html/_colophon_history.html.erb +9 -0
  115. data/templates/html/_cover.html.erb +10 -0
  116. data/templates/html/_part_body.html.erb +6 -0
  117. data/templates/html/_titlepage.html.erb +20 -0
  118. data/templates/html/layout-html5.html.erb +6 -0
  119. data/templates/html/layout-xhtml1.html.erb +6 -0
  120. data/templates/latex/config.erb +41 -29
  121. data/templates/latex/review-jlreq/README.md +3 -1
  122. data/templates/latex/review-jlreq/review-base.sty +47 -22
  123. data/templates/latex/review-jlreq/review-jlreq.cls +25 -24
  124. data/templates/latex/review-jlreq/review-style.sty +6 -1
  125. data/templates/latex/review-jlreq/review-tcbox.sty +348 -0
  126. data/templates/latex/review-jlreq/reviewmacro.sty +5 -0
  127. data/templates/latex/review-jsbook/README.md +7 -5
  128. data/templates/latex/review-jsbook/review-base.sty +47 -21
  129. data/templates/latex/review-jsbook/review-jsbook.cls +12 -2
  130. data/templates/latex/review-jsbook/review-style.sty +6 -1
  131. data/templates/latex/review-jsbook/review-tcbox.sty +348 -0
  132. data/templates/latex/review-jsbook/reviewmacro.sty +5 -0
  133. data/templates/opf/epubv2.opf.erb +7 -7
  134. data/templates/opf/epubv3.opf.erb +7 -7
  135. data/templates/opf/opf_manifest_epubv2.opf.erb +10 -0
  136. data/templates/opf/opf_manifest_epubv3.opf.erb +10 -0
  137. data/templates/opf/opf_metainfo_epubv2.opf.erb +17 -0
  138. data/templates/opf/opf_metainfo_epubv3.opf.erb +49 -0
  139. data/templates/opf/opf_tocx_epubv2.opf.erb +9 -0
  140. data/templates/opf/opf_tocx_epubv3.opf.erb +17 -0
  141. data/templates/web/html/layout-html5.html.erb +9 -8
  142. data/templates/web/html/layout-xhtml1.html.erb +6 -0
  143. data/test/assets/header_listener.html +35 -0
  144. data/test/assets/img_math/img1.png +0 -0
  145. data/test/assets/img_math/img2.png +0 -0
  146. data/test/assets/img_math/img3.png +0 -0
  147. data/test/assets/syntax_book_index_detail.txt +58 -0
  148. data/test/assets/test_template.tex +12 -9
  149. data/test/assets/test_template_backmatter.tex +12 -9
  150. data/test/book_test_helper.rb +11 -5
  151. data/test/run_test.rb +1 -1
  152. data/test/test_book.rb +62 -63
  153. data/test/test_book_chapter.rb +99 -56
  154. data/test/test_book_part.rb +3 -3
  155. data/test/test_builder.rb +24 -15
  156. data/test/test_catalog.rb +1 -0
  157. data/test/test_catalog_converter_cmd.rb +1 -1
  158. data/test/test_converter.rb +1 -0
  159. data/test/test_epub3maker.rb +170 -126
  160. data/test/test_epubmaker.rb +249 -129
  161. data/test/test_epubmaker_cmd.rb +14 -7
  162. data/test/test_helper.rb +23 -11
  163. data/test/test_htmlbuilder.rb +956 -76
  164. data/test/test_htmlutils.rb +0 -12
  165. data/test/test_i18n.rb +33 -33
  166. data/test/test_idgxmlbuilder.rb +568 -10
  167. data/test/test_idgxmlmaker_cmd.rb +50 -0
  168. data/test/test_image_finder.rb +52 -70
  169. data/test/test_img_math.rb +111 -0
  170. data/test/test_index.rb +62 -52
  171. data/test/test_indexbuilder.rb +52 -0
  172. data/test/test_latexbuilder.rb +1056 -30
  173. data/test/test_latexbuilder_v2.rb +52 -12
  174. data/test/test_lineinput.rb +20 -93
  175. data/test/test_logger.rb +7 -7
  176. data/test/test_makerhelper.rb +0 -12
  177. data/test/test_markdownbuilder.rb +32 -0
  178. data/test/test_pdfmaker.rb +100 -11
  179. data/test/test_pdfmaker_cmd.rb +101 -7
  180. data/test/test_plaintextbuilder.rb +531 -25
  181. data/test/test_review_ext.rb +2 -1
  182. data/test/test_reviewheaderlistener.rb +49 -0
  183. data/test/test_rstbuilder.rb +25 -1
  184. data/test/test_sec_counter.rb +156 -0
  185. data/test/test_template.rb +12 -2
  186. data/test/test_textmaker_cmd.rb +58 -0
  187. data/test/test_tocprinter.rb +46 -0
  188. data/test/test_topbuilder.rb +365 -10
  189. data/test/test_update.rb +44 -44
  190. data/test/test_webtocprinter.rb +75 -43
  191. data/test/test_zip_exporter.rb +5 -6
  192. data/vendor/gentombow/LICENSE +1 -1
  193. data/vendor/gentombow/Makefile +0 -1
  194. data/vendor/gentombow/bounddvi-en.pdf +0 -0
  195. data/vendor/gentombow/bounddvi-en.tex +1 -0
  196. data/vendor/gentombow/bounddvi.pdf +0 -0
  197. data/vendor/gentombow/bounddvi.sty +30 -7
  198. data/vendor/gentombow/bounddvi.tex +1 -0
  199. data/vendor/gentombow/create_archive.sh +1 -0
  200. data/vendor/gentombow/gentombow-ja.pdf +0 -0
  201. data/vendor/gentombow/gentombow-ja.tex +9 -0
  202. data/vendor/gentombow/gentombow.pdf +0 -0
  203. data/vendor/gentombow/gentombow.sty +32 -10
  204. data/vendor/gentombow/gentombow.tex +8 -0
  205. data/vendor/gentombow/tests/gentombow-01-pdfx.tex +8 -0
  206. data/vendor/gentombow/tests/gentombow-02-pdfx.tex +8 -0
  207. data/vendor/jsclasses/LICENSE +1 -1
  208. data/vendor/jsclasses/Makefile +3 -2
  209. data/vendor/jsclasses/create_archive.sh +5 -5
  210. data/vendor/jsclasses/jis/Makefile +3 -2
  211. data/vendor/jsclasses/jis/jsarticle.cls +74 -31
  212. data/vendor/jsclasses/jis/jsbook.cls +74 -31
  213. data/vendor/jsclasses/jis/jsclasses.dtx +176 -36
  214. data/vendor/jsclasses/jis/jsclasses.ins +15 -5
  215. data/vendor/jsclasses/jis/jslogo.dtx +4 -4
  216. data/vendor/jsclasses/jis/jslogo.ins +9 -0
  217. data/vendor/jsclasses/jis/jslogo.sty +4 -16
  218. data/vendor/jsclasses/jis/jspf.cls +73 -30
  219. data/vendor/jsclasses/jis/jsreport.cls +74 -31
  220. data/vendor/jsclasses/jis/jsverb.ins +9 -0
  221. data/vendor/jsclasses/jis/jsverb.sty +1 -13
  222. data/vendor/jsclasses/jis/kiyou.cls +74 -31
  223. data/vendor/jsclasses/jis/minijs.sty +65 -22
  224. data/vendor/jsclasses/jis/okumacro.dtx +4 -5
  225. data/vendor/jsclasses/jis/okumacro.ins +9 -0
  226. data/vendor/jsclasses/jis/okumacro.sty +4 -17
  227. data/vendor/jsclasses/jis/okuverb.ins +9 -0
  228. data/vendor/jsclasses/jis/okuverb.sty +1 -13
  229. data/vendor/jsclasses/jis/winjis.sty +23 -19
  230. data/vendor/jsclasses/jsarticle.cls +74 -31
  231. data/vendor/jsclasses/jsbook.cls +74 -31
  232. data/vendor/jsclasses/jsclasses.dtx +176 -36
  233. data/vendor/jsclasses/jsclasses.ins +15 -5
  234. data/vendor/jsclasses/jsclasses.pdf +0 -0
  235. data/vendor/jsclasses/jslogo.dtx +4 -4
  236. data/vendor/jsclasses/jslogo.ins +9 -0
  237. data/vendor/jsclasses/jslogo.pdf +0 -0
  238. data/vendor/jsclasses/jslogo.sty +4 -16
  239. data/vendor/jsclasses/jspf.cls +73 -30
  240. data/vendor/jsclasses/jsreport.cls +74 -31
  241. data/vendor/jsclasses/jsverb.ins +9 -0
  242. data/vendor/jsclasses/jsverb.pdf +0 -0
  243. data/vendor/jsclasses/jsverb.sty +1 -13
  244. data/vendor/jsclasses/kiyou.cls +74 -31
  245. data/vendor/jsclasses/minijs.sty +68 -22
  246. data/vendor/jsclasses/okumacro.dtx +4 -5
  247. data/vendor/jsclasses/okumacro.ins +9 -0
  248. data/vendor/jsclasses/okumacro.pdf +0 -0
  249. data/vendor/jsclasses/okumacro.sty +4 -17
  250. data/vendor/jsclasses/okuverb.ins +9 -0
  251. data/vendor/jsclasses/okuverb.pdf +0 -0
  252. data/vendor/jsclasses/okuverb.sty +1 -13
  253. data/vendor/jsclasses/tests/relfont.tex +10 -0
  254. data/vendor/jsclasses/winjis.sty +23 -19
  255. metadata +109 -20
  256. data/.rubocop_todo.yml +0 -7
  257. data/lib/epubmaker.rb +0 -23
  258. data/lib/epubmaker/content.rb +0 -110
  259. data/lib/epubmaker/epubcommon.rb +0 -441
  260. data/lib/epubmaker/epubv2.rb +0 -143
  261. data/lib/epubmaker/epubv3.rb +0 -233
  262. data/lib/epubmaker/producer.rb +0 -375
  263. data/lib/epubmaker/zip_exporter.rb +0 -81
  264. data/lib/lineinput.rb +0 -155
  265. data/lib/review/book/compilable.rb +0 -178
  266. data/lib/review/tocparser.rb +0 -271
  267. data/samples/syntax-book/review-ext.rb +0 -14
  268. 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
- require 'pathname'
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
- require 'pathname'
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,16 +9,13 @@
9
9
  # For details of the GNU LGPL, see the file "COPYING".
10
10
  #
11
11
 
12
- require 'pathname'
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'
22
19
  require 'stringio'
23
20
  require 'fileutils'
24
21
  require 'optparse'
@@ -93,6 +90,7 @@ def main
93
90
  end
94
91
  rescue ReVIEW::Error => e
95
92
  raise if $DEBUG
93
+
96
94
  @logger.error e.message
97
95
  exit 1
98
96
  end
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
- require 'pathname'
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
- require 'pathname'
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
- bindir = Pathname.new(__FILE__).realpath.dirname
14
- $LOAD_PATH.unshift((bindir + '../lib').realpath)
12
+ $LOAD_PATH.unshift(File.realpath('../lib', __dir__))
13
+
15
14
  require 'review/logger'
16
15
 
17
16
  block = nil
@@ -30,7 +29,7 @@ ARGF.each do |line|
30
29
  @logger.warn "#{ln}: block #{new_block} started, but previous block #{block} didn't close yet."
31
30
  end
32
31
  block = new_block
33
- elsif line =~ %r{\A//\}}
32
+ elsif line.start_with?('//}')
34
33
  if block.nil?
35
34
  @logger.warn "#{ln}: block ended, but not opened."
36
35
  end
@@ -53,7 +52,8 @@ ARGF.each do |line|
53
52
  end
54
53
  elsif block == 'table'
55
54
  next if line.start_with?('#@')
56
- if line !~ /\A\-\-\-\-\-/
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-2019 Minero Aoki, Kenshi Muto
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
- require 'pathname'
12
+ $LOAD_PATH.unshift(File.realpath('../lib', __dir__))
13
13
 
14
- bindir = Pathname.new(__FILE__).realpath.dirname
15
- $LOAD_PATH.unshift((bindir + '../lib').realpath)
14
+ require 'review/volumeprinter'
16
15
 
17
- require 'review'
18
- require 'optparse'
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
- require 'pathname'
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
 
@@ -5,7 +5,7 @@
5
5
  # このファイルはUTF-8エンコーディングで記述してください。
6
6
 
7
7
  # この設定ファイルでサポートするRe:VIEWのバージョン番号。
8
- review_version: 4.0
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-2019 Re:VIEW Developers
77
+ # rights: (C) 2016-2020 Re:VIEW Developers
76
78
  # description: 説明
77
79
  # subject: 短い説明用タグ(配列で複数指定可)
78
80
  # type: 書籍のカテゴリーなど(配列で複数指定可)
@@ -85,11 +87,14 @@ aut: ["青木峰郎", "武藤健志", "高橋征義", "角征典"]
85
87
  debug: null
86
88
 
87
89
  # 固有IDに使用するドメイン。指定しない場合には、時刻に基づくランダムUUIDが入る
88
- # urnid: urn:uid:http://example.com/book-title/
90
+ # urnid: urn:uuid:http://example.com/book-title/
89
91
  #
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
  #
@@ -137,7 +142,10 @@ toc: true
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,22 +181,41 @@ toc: true
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
- # review-vol向けのヒント情報
180
- # 1ページの行数文字数と1kbごとのページ数を用紙サイズで指定する(A5 or B5)
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行字数、1kバイトごとのページ数
185
- # page_metric: [40,80,40,80,2]
208
+ # 各数字の意味は、順にリストの行数、リストの1行字数、テキストの行数、テキストの1行字数
209
+ # page_metric: [40,34,29,34]
186
210
 
187
- # EPUB・Web、およびテキスト生成時における数式の画像化指定
188
- # TeXの数式を画像化するか。省略した場合はnull (作成しない)
189
- # imgmath: true
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
190
217
 
191
- # imgmathがtrueの場合の設定
218
+ # math_formatがimgmathの場合の設定
192
219
  # 以下のパラメータを有効にするときには、
193
220
  # imgmath_options:
194
221
  # パラメータ: 値
@@ -373,6 +400,9 @@ pdfmaker:
373
400
  # 画像のscale=X.Xという指定を画像拡大縮小率からページ最大幅の相対倍率に変換する
374
401
  # image_scale2width: true
375
402
  #
403
+ # 画像のデフォルトのサイズを、版面横幅合わせではなく、原寸をそのまま利用する
404
+ # use_original_image_size: null
405
+ #
376
406
  # PDFやIllustratorファイル(.ai)の画像のBoudingBoxの抽出に指定のボックスを採用する
377
407
  # cropbox(デフォルト), mediabox, artbox, trimbox, bleedboxから選択する。
378
408
  # Illustrator CC以降のIllustratorファイルに対してはmediaboxを指定する必要がある
@@ -396,4 +426,17 @@ pdfmaker:
396
426
  colophon: true
397
427
  # 表紙挿入時に表紙のページ番号名を「cover」とし、偶数ページ扱いにして大扉前に白ページが入るのを防ぐ。デフォルトはtrue
398
428
  # use_cover_nombre: true
429
+ #
430
+ # 囲み表現の切り替え設定
431
+ # column, note, memo, tip, info, warning, important, caution, noticeを設定可
432
+ # styleはreview-tcbox.styまたは独自に作成したスタイルで定義済みの囲みスタイル名
433
+ # optionsはキャプションなし囲みに対するtcolorboxの追加・上書きオプション
434
+ # options_with_captionはキャプション付き囲みのtcolorboxの追加・上書きオプション(省略した場合はoptionsと同じ)
435
+ #
436
+ # boxsetting:
437
+ # note:
438
+ # style: squarebox
439
+ # options: "colback=black!5!white"
440
+ # options_with_caption: "colbacktitle=black!25!white"
441
+ #
399
442
  # pdfmaker:階層を使うものはここまで
@@ -1,5 +1,5 @@
1
1
  # simple sample of config.yml
2
- review_version: 4.0
2
+ review_version: 5.0
3
3
 
4
4
  # debug: true
5
5
 
@@ -20,11 +20,12 @@ 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-2019 Re:VIEW Commiters, some rights reserved.
26
+ rights: (C) 2016-2020 Re:VIEW Commiters, some rights reserved.
26
27
  description: sample config.yml file for Re:VIEW book
27
- urnid: urn:uid:http://reviewml.org/review-sample-book
28
+ urnid: urn:uuid:http://reviewml.org/review-sample-book
28
29
  # isbn: null
29
30
 
30
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 3.0 に基づいています。
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
  ソースコードを引用するには次のように記述します。
@@ -264,11 +263,23 @@ puts "hello world!"
264
263
 
265
264
  ```review
266
265
  //source[/hello/world.rb]{
267
- 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!" # キャプションなし、ハイライトあり
268
279
  //}
269
280
  ```
270
281
 
271
- ソースコードの引用は、キャプションを付けた `//emlist` とほぼ同じです。HTML の CSS などでは区別した表現ができます。
282
+ ソースコードの引用は、`//emlist` とほぼ同じです。HTML の CSS などでは区別した表現ができます。
272
283
 
273
284
  ## 本文中でのソースコード引用
274
285
 
@@ -312,7 +323,7 @@ V1 --> V6 --|
312
323
  //}
313
324
  ```
314
325
 
315
- 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` のように `::` でビルダを明示し、`,` でオプションを区切って指定できます。
316
327
 
317
328
  ※TeX において原寸からの倍率にしたいときには、`config.yml` に `image_scale2width: false` を指定してください。
318
329
 
@@ -334,7 +345,7 @@ V1 --> V6 --|
334
345
  ```
335
346
 
336
347
  * `<imgdir>` はデフォルトでは images ディレクトリです。
337
- * `<builder>` は利用しているビルダ名(ターゲット名)で、たとえば `--target=html` としているのであれば、images/html ディレクトリとなります。
348
+ * `<builder>` は利用しているビルダ名(ターゲット名)で、たとえば `--target=html` としているのであれば、images/html ディレクトリとなります。各 Maker におけるビルダ名は epubmaker および webmaker の場合は `html`、pdfmaker の場合は `latex`、textmaker の場合は `top` です。
338
349
  * `<chapid>` は章 ID です。たとえば ch01.re という名前であれば「ch01」です。
339
350
  * `<id>` は //image[〜] の最初に入れた「〜」のことです(つまり、ID に日本語や空白交じりの文字を使ってしまうと、後で画像ファイル名の名前付けに苦労することになります!)。
340
351
  * `<ext>` は Re:VIEW が自動で判別する拡張子です。ビルダによってサポートおよび優先する拡張子は異なります。
@@ -343,7 +354,7 @@ V1 --> V6 --|
343
354
 
344
355
  * HTMLBuilder (EPUBMaker、WEBMaker)、MARKDOWNBuilder: .png、.jpg、.jpeg、.gif、.svg
345
356
  * LATEXBuilder (PDFMaker): .ai、.eps、.pdf、.tif、.tiff、.png、.bmp、.jpg、.jpeg、.gif
346
- * それ以外のビルダ: .ai、.psd、.eps、.pdf、.tif、.tiff、.png、.bmp、.jpg、.jpeg、.gif、.svg
357
+ * それ以外のビルダ・Maker: .ai、.psd、.eps、.pdf、.tif、.tiff、.png、.bmp、.jpg、.jpeg、.gif、.svg
347
358
 
348
359
  ### インラインの画像挿入
349
360
 
@@ -491,6 +502,19 @@ complexmatrixという識別子に基づく画像ファイルが貼り込まれ
491
502
 
492
503
  内容には、空行で区切って複数の段落を記述可能です。
493
504
 
505
+ Re:VIEW 5.0 以降では、囲み記事に箇条書きや図表・リストを含めることもできます。
506
+
507
+ ```
508
+ //note{
509
+
510
+ 箇条書きを含むノートです。
511
+
512
+ 1. 箇条書き1
513
+ 2. 箇条書き2
514
+
515
+ //}
516
+ ```
517
+
494
518
  ## 脚注
495
519
 
496
520
  脚注は「`//footnote`」を使って記述します。
@@ -577,7 +601,7 @@ LaTeX の式を挿入するには、`//texequation{ 〜 //}` を使います。
577
601
  「式1.1」のように連番を付けたいときには、識別子とキャプションを指定します。
578
602
 
579
603
  ```
580
- //texequationl[emc][質量とエネルギーの等価性]{
604
+ //texequation[emc][質量とエネルギーの等価性]{
581
605
  \sum_{i=1}^nf_n(x)
582
606
  //}
583
607
  ```
@@ -588,7 +612,7 @@ LaTeX の式を挿入するには、`//texequation{ 〜 //}` を使います。
588
612
 
589
613
  LaTeX の数式が正常に整形されるかどうかは処理系に依存します。LaTeX を利用する PDFMaker では問題なく利用できます。
590
614
 
591
- EPUBMaker および WEBMaker では、MathML に変換する方法と、画像化する方法のどちらかを選べます。
615
+ EPUBMaker および WEBMaker では、MathML に変換する方法、MathJax に変換する方法、画像化する方法から選べます。
592
616
 
593
617
  ### MathML の場合
594
618
  MathML ライブラリをインストールしておきます(`gem install math_ml`)。
@@ -596,11 +620,20 @@ MathML ライブラリをインストールしておきます(`gem install mat
596
620
  さらに config.yml に以下のように指定します。
597
621
 
598
622
  ```
599
- mathml: true
623
+ math_format: mathml
600
624
  ```
601
625
 
602
626
  なお、MathML で正常に表現されるかどうかは、ビューアやブラウザに依存します。
603
627
 
628
+ ### MathJax の場合
629
+ config.yml に以下のように指定します。
630
+
631
+ ```
632
+ math_format: mathjax
633
+ ```
634
+
635
+ MathJax の JavaScript モジュールはインターネットから読み込まれます。現時点で EPUB の仕様では外部からの読み込みを禁止しているため、MathJax を有効にすると EPUB ファイルの検証を通りません。また、ほぼすべての EPUB リーダーで MathJax は動作しません。CSS 組版との組み合わせでは利用できる可能性があります。
636
+
604
637
  ### 画像化の場合
605
638
 
606
639
  LaTeX を内部で呼び出し、外部ツールを使って画像化する方法です。画像化された数式は、`images/_review_math` フォルダに配置されます。
@@ -615,7 +648,7 @@ TeXLive などの LaTeX 環境が必要です。必要に応じて config.yml
615
648
  config.yml で以下のように設定すると、
616
649
 
617
650
  ```
618
- imgmath: true
651
+ math_format: imgmath
619
652
  ```
620
653
 
621
654
  デフォルト値として以下が使われます。
@@ -650,7 +683,7 @@ imgmath_options:
650
683
  たとえば SVG を利用するには、次のようにします。
651
684
 
652
685
  ```
653
- imgmath: true
686
+ math_format: imgmath
654
687
  imgmath_options:
655
688
  format: svg
656
689
  pdfcrop_pixelize_cmd: "pdftocairo -svg -r 90 -f %p -l %p -singlefile %i %o"
@@ -661,7 +694,7 @@ imgmath_options:
661
694
  単一のページの処理を前提とする `sips` コマンドや `magick` コマンドを使う場合、入力 PDF から指定のページを抽出するように `extract_singlepage: true` として挙動を変更します。単一ページの抽出はデフォルトで TeXLive の `pdfjam` コマンドが使われます。
662
695
 
663
696
  ```
664
- imgmath: true
697
+ math_format: imgmath
665
698
  imgmath_options:
666
699
  extract_singlepage: true
667
700
  # pdfjamの代わりに外部ツールのpdftkを使う場合(Windowsなど)
@@ -675,7 +708,7 @@ imgmath_options:
675
708
  textmaker 向けに PDF 形式の数式ファイルを作成したいときには、たとえば以下のように設定します(ページの抽出には pdftk を利用)。
676
709
 
677
710
  ```
678
- imgmath: true
711
+ math_format: imgmath
679
712
  imgmath_options:
680
713
  format: pdf
681
714
  extract_singlepage: true
@@ -686,7 +719,7 @@ imgmath_options:
686
719
  Re:VIEW 2 以前の dvipng の設定に合わせるには、次のようにします。
687
720
 
688
721
  ```
689
- imgmath: true
722
+ math_format: imgmath
690
723
  imgmath_options:
691
724
  converter: dvipng
692
725
  fontsize: 12
@@ -790,7 +823,7 @@ Web ハイパーリンクを記述するには、リンクに `@<href>`、アン
790
823
  "i18n","""i""nternationalizatio""n"""
791
824
  ```
792
825
 
793
- 単語ファイルのファイルパスは、`config.yml` に `words_file: ファイルパス` で指定します。
826
+ 単語ファイルのファイルパスは、`config.yml` に `words_file: ファイルパス` で指定します。`word_file: ["common.csv", "mybook.csv"]` のように複数のファイルも指定可能です(同一のキーがあるときには後に指定したファイルの値が優先されます)。
794
827
 
795
828
  例:
796
829
 
@@ -900,9 +933,76 @@ LaTeXビルダを使用している場合:
900
933
 
901
934
  ```
902
935
 
903
-
904
936
  `//raw`、`//embed`、`@<raw>` および `@<embed>` は、HTML、XML や TeX の文書構造を容易に壊す可能性があります。使用には十分に注意してください。
905
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
+
906
1006
  ## インライン命令
907
1007
  主なインライン命令を次に示します。
908
1008
 
@@ -922,6 +1022,8 @@ LaTeXビルダを使用している場合:
922
1022
  * `@<ttb>{〜}` : 等幅+太字にします。
923
1023
  * `@<code>{〜}` : 等幅にします(コードの引用という性質)。
924
1024
  * `@<tcy>{〜}` : 縦書きの文書において文字を縦中横にします。
1025
+ * `@<ins>{〜}` : 挿入箇所を明示します(デフォルトでは下線が引かれます)。
1026
+ * `@<del>{〜}` : 削除箇所を明示します(デフォルトでは打ち消し線が引かれます)。
925
1027
 
926
1028
  ### 参照
927
1029
  * `@<chap>{章ファイル名}` : 「第17章」のような、章番号を含むテキストに置換されます。