review 3.0.0 → 4.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-win.yml +39 -0
- data/.github/workflows/ruby.yml +27 -0
- data/.rubocop.yml +50 -12
- data/.travis.yml +17 -8
- data/Dockerfile +21 -5
- data/NEWS.ja.md +358 -0
- data/NEWS.md +358 -1
- data/README.md +11 -8
- data/appveyor.yml +1 -3
- data/bin/review-catalog-converter +4 -4
- data/bin/review-check +8 -8
- data/bin/review-checkdep +1 -1
- data/bin/review-compile +12 -12
- data/bin/review-epubmaker +3 -35
- data/bin/review-idgxmlmaker +16 -0
- data/bin/review-index +2 -89
- data/bin/review-preproc +14 -19
- data/bin/review-validate +3 -3
- data/bin/review-vol +4 -78
- data/doc/LICENSE +1 -1
- data/doc/config.yml.sample +46 -12
- data/doc/config.yml.sample-simple +4 -2
- data/doc/format.ja.md +37 -13
- data/doc/format.md +35 -20
- data/doc/pdfmaker.ja.md +43 -1
- data/doc/pdfmaker.md +42 -1
- data/doc/quickstart.ja.md +46 -26
- data/doc/quickstart.md +38 -17
- data/lib/epubmaker/epubcommon.rb +10 -5
- data/lib/epubmaker/epubv2.rb +1 -1
- data/lib/epubmaker/epubv3.rb +1 -0
- data/lib/epubmaker/producer.rb +4 -2
- data/lib/review/book.rb +1 -1
- data/lib/review/book/base.rb +38 -79
- data/lib/review/book/chapter.rb +18 -3
- data/lib/review/book/compilable.rb +6 -5
- data/lib/review/book/index.rb +69 -101
- data/lib/review/book/index/item.rb +40 -0
- data/lib/review/book/page_metric.rb +7 -7
- data/lib/review/book/part.rb +28 -5
- data/lib/review/book/volume.rb +3 -4
- data/lib/review/builder.rb +105 -44
- data/lib/review/catalog.rb +13 -16
- data/lib/review/compiler.rb +84 -72
- data/lib/review/configure.rb +19 -8
- data/lib/review/epub2html.rb +37 -4
- data/lib/review/epubmaker.rb +62 -7
- data/lib/review/extentions/string.rb +0 -4
- data/lib/review/htmlbuilder.rb +102 -115
- data/lib/review/htmlutils.rb +2 -3
- data/lib/review/i18n.rb +2 -2
- data/lib/review/i18n.yml +9 -0
- data/lib/review/idgxmlbuilder.rb +153 -74
- data/lib/review/idgxmlmaker.rb +191 -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 +125 -34
- data/lib/review/latexbuilder.rb +199 -88
- 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 +24 -5
- data/lib/review/markdownbuilder.rb +31 -37
- data/lib/review/md2inaobuilder.rb +3 -5
- data/lib/review/pdfmaker.rb +44 -22
- data/lib/review/plaintextbuilder.rb +106 -85
- data/lib/review/preprocessor.rb +32 -41
- data/lib/review/rstbuilder.rb +33 -33
- data/lib/review/textmaker.rb +19 -3
- data/lib/review/textutils.rb +76 -2
- data/lib/review/tocprinter.rb +231 -102
- data/lib/review/topbuilder.rb +114 -61
- data/lib/review/update.rb +19 -19
- data/lib/review/version.rb +1 -1
- data/lib/review/volumeprinter.rb +99 -0
- data/lib/review/webmaker.rb +11 -4
- 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/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 +16 -0
- data/templates/latex/layout.tex.erb +4 -0
- data/templates/latex/review-jlreq/review-base.sty +150 -61
- data/templates/latex/review-jlreq/review-jlreq.cls +74 -8
- data/templates/latex/review-jlreq/review-style.sty +4 -1
- data/templates/latex/review-jsbook/README.md +39 -0
- data/templates/latex/review-jsbook/review-base.sty +101 -23
- data/templates/latex/review-jsbook/review-jsbook.cls +28 -5
- 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 +2 -2
- data/test/assets/test_template.tex +24 -3
- data/test/assets/test_template_backmatter.tex +24 -3
- data/test/test_book.rb +75 -21
- data/test/test_book_chapter.rb +4 -2
- data/test/test_book_part.rb +3 -3
- data/test/test_builder.rb +16 -0
- data/test/test_catalog.rb +24 -42
- data/test/test_catalog_converter_cmd.rb +1 -1
- data/test/test_epubmaker_cmd.rb +14 -7
- data/test/test_helper.rb +15 -7
- data/test/test_htmlbuilder.rb +909 -159
- data/test/test_i18n.rb +25 -25
- data/test/test_idgxmlbuilder.rb +395 -38
- data/test/test_idgxmlmaker_cmd.rb +46 -0
- data/test/test_image_finder.rb +52 -70
- data/test/test_index.rb +50 -10
- data/test/test_latexbuilder.rb +1194 -106
- data/test/test_latexbuilder_v2.rb +628 -97
- data/test/test_logger.rb +14 -1
- data/test/test_makerhelper.rb +3 -3
- data/test/test_markdownbuilder.rb +134 -16
- data/test/test_md2inaobuilder.rb +32 -9
- data/test/test_pdfmaker.rb +18 -1
- data/test/test_pdfmaker_cmd.rb +100 -6
- data/test/test_plaintextbuilder.rb +371 -25
- data/test/test_preprocessor.rb +2 -16
- data/test/test_rstbuilder.rb +249 -26
- data/test/test_textmaker_cmd.rb +54 -0
- data/test/test_textutils.rb +109 -2
- data/test/test_topbuilder.rb +546 -31
- data/test/test_update.rb +17 -8
- data/test/test_webtocprinter.rb +66 -34
- data/test/test_yamlloader.rb +13 -0
- data/vendor/jsclasses/LICENSE +1 -1
- data/vendor/jsclasses/jis/jsarticle.cls +53 -14
- data/vendor/jsclasses/jis/jsbook.cls +53 -14
- data/vendor/jsclasses/jis/jsclasses.dtx +84 -25
- data/vendor/jsclasses/jis/jslogo.dtx +4 -4
- data/vendor/jsclasses/jis/jslogo.sty +3 -3
- data/vendor/jsclasses/jis/jspf.cls +52 -13
- data/vendor/jsclasses/jis/jsreport.cls +53 -14
- data/vendor/jsclasses/jis/kiyou.cls +53 -14
- data/vendor/jsclasses/jis/okumacro.dtx +4 -5
- data/vendor/jsclasses/jis/okumacro.sty +3 -4
- data/vendor/jsclasses/jsarticle.cls +53 -14
- data/vendor/jsclasses/jsbook.cls +53 -14
- data/vendor/jsclasses/jsclasses.dtx +84 -25
- data/vendor/jsclasses/jsclasses.pdf +0 -0
- data/vendor/jsclasses/jslogo.dtx +4 -4
- data/vendor/jsclasses/jslogo.pdf +0 -0
- data/vendor/jsclasses/jslogo.sty +3 -3
- data/vendor/jsclasses/jspf.cls +52 -13
- data/vendor/jsclasses/jsreport.cls +53 -14
- data/vendor/jsclasses/kiyou.cls +53 -14
- data/vendor/jsclasses/okumacro.dtx +4 -5
- data/vendor/jsclasses/okumacro.pdf +0 -0
- data/vendor/jsclasses/okumacro.sty +3 -4
- metadata +55 -10
- data/lib/review/tocparser.rb +0 -271
- data/samples/syntax-book/review-ext.rb +0 -14
- data/test/test_tocparser.rb +0 -25
data/NEWS.md
CHANGED
@@ -1,3 +1,360 @@
|
|
1
|
+
# Version 4.2.0
|
2
|
+
## New Features
|
3
|
+
* introduce `caption_position` parameter to specify a caption position of image, table, list, and equation. `caption_position` has child parameters `image`, `table`, `list`, and `equation` and the value is `top` or `bottom` ([#1320])
|
4
|
+
|
5
|
+
## Breaking Changes
|
6
|
+
* review-vol is rewritten. Improved processing of parts and inline instructions in headings. Changed display format. When a part is specified, the volume of the part file itself is returned instead of the volume of the part. The `-P` and `--directory` options have been removed ([#1485])
|
7
|
+
* review-index is rewritten. Most option names have been changed. The number of lines and characters are now displayed only when `-d` option is specified. review-index uses PLAINTEXTBuilder to return accurate line and character counts. `-y` option is provided to specify a target chapter ([#1485])
|
8
|
+
|
9
|
+
## Bug Fixes
|
10
|
+
* remove duplicated `@non_parsed_commands` declaration ([#1499])
|
11
|
+
* mathematical images not being created in WebMaker and TextMaker has been fixed ([#1501])
|
12
|
+
|
13
|
+
## Enhancements
|
14
|
+
* improve a performance of building math figures on imgmath ([#1488])
|
15
|
+
* for those times when you want to hand over non-default YAML parameters to PDFMaker, you can write your own `layouts/config-local.tex.erb` file ([#1505])
|
16
|
+
|
17
|
+
## Others
|
18
|
+
* GitHub Actions: use `ruby/setup-ruby` instead of `eregon/use-ruby-action` ([#1490])
|
19
|
+
* skip artifacts in the sample folder during testing ([#1504])
|
20
|
+
|
21
|
+
[#1320]: https://github.com/kmuto/review/issues/1320
|
22
|
+
[#1485]: https://github.com/kmuto/review/issues/1485
|
23
|
+
[#1488]: https://github.com/kmuto/review/issues/1488
|
24
|
+
[#1490]: https://github.com/kmuto/review/pull/1490
|
25
|
+
[#1499]: https://github.com/kmuto/review/issues/1499
|
26
|
+
[#1501]: https://github.com/kmuto/review/pull/1501
|
27
|
+
[#1504]: https://github.com/kmuto/review/pull/1504
|
28
|
+
[#1505]: https://github.com/kmuto/review/issues/1505
|
29
|
+
|
30
|
+
# Version 4.1.0
|
31
|
+
## New Features
|
32
|
+
* add `table_row_separator` to specify a separator that separates table rows. Accceptable value: tabs (means `\t+`, default), `singletab` (means `\t`), spaces (means `\s+`), verticalbar (means `\s*\|\s*`) ([#1420])
|
33
|
+
* PDFMaker, EPUBMaker, WEBMaker, TEXTMaker, IDGXMLMaker: add `-y` (`--only`) option to specify the files to convert instead of all files ([#1428])
|
34
|
+
* add `--without-config-comment` option to review-init command to exclude comments from config.yml ([#1453])
|
35
|
+
* PDFMaker: add `use_original_image_size` in `pdfmaker` section. If this parameter is set to true, images in `//image`, `//indepimage`, and `//imgtable` will be placed in actual size, not textwidth ([#1461])
|
36
|
+
|
37
|
+
## Breaking Changes
|
38
|
+
* PDFMaker: `image_scale2width` parameter has been moved under `pdfmaker` section ([#1462])
|
39
|
+
|
40
|
+
## Bug Fixes
|
41
|
+
* PDFMaker: fix backward compatibility error with Re:VIEW 3 ([#1414])
|
42
|
+
* PDFMaker: fix an error when compiling review-jlreq with LuaLaTeX ([#1416])
|
43
|
+
* PDFMaker: fix index not being included in the table of contents ([#1418])
|
44
|
+
* RSTBuilder: fix conversion failure due to incorrect method argument handling ([#1426])
|
45
|
+
* IDGXMLBuilder: there was an error in the warning handling for the table ([#1427])
|
46
|
+
* IDGXMLMaker: there was an error in the processing when an error occurred in the filter program ([#1429])
|
47
|
+
* PDFMaker: fix a build failure when using inline operators such as `@<code>` or `@<tt>` for heading with `media=ebook` mode ([#1432], [#1465])
|
48
|
+
* PDFMaker: raise just warning instead of error, when MeCab isn't installed ([#1445])
|
49
|
+
* IDGXMLBuilder: fix `//imgtable` to work correctly ([#1448])
|
50
|
+
* PDFMaker: fix an error when makeindex is true but no index is registered ([#1467])
|
51
|
+
* PDFMaker: fix missing footnotes in a description list ([#1476])
|
52
|
+
* review-index: fix an error when `@<w>` exists in headlines ([#1484])
|
53
|
+
|
54
|
+
## Enhancements
|
55
|
+
* PDFMaker: add version to .cls/.sty files ([#1163])
|
56
|
+
* update Dockerfile ([#1412])
|
57
|
+
* IDGXMLMaker: show the contents of stderr from the filter program ([#1443])
|
58
|
+
* add *-idgxml folder entry to .gitignore ([#1448])
|
59
|
+
* `//source` can now omit options in all builders ([#1447])
|
60
|
+
* add Ruby 2.7 to the test targets ([#1468])
|
61
|
+
* allow a setting of multiple word\_file ([#1469])
|
62
|
+
* EPUBMaker: warn when there is no heading in .re file ([#1474])
|
63
|
+
|
64
|
+
## Docs
|
65
|
+
* add the description about `contact` and `colophon_order` to `config.yml.sample` ([#1425])
|
66
|
+
* update quickstart.ja.md and quickstart.md to Re:VIEW 4 ([#1442])
|
67
|
+
* update syntax-book sample document ([#1448], [#1449])
|
68
|
+
* update README.md ([#1455], [#1458])
|
69
|
+
* update format.ja.md and format.md. add the description about `::` notation which sets builder-specific options to images ([#1421])
|
70
|
+
|
71
|
+
## Others
|
72
|
+
* refactor codes with Rubocop 0.78.0 ([#1424], [#1430])
|
73
|
+
* run PDF build test more strictly when there is LaTeX runtime environment ([#1433])
|
74
|
+
* switch the build test suite from Travis CI to GitHub Actions ([#1431], [#1436], [#1437])
|
75
|
+
* IDGXMLBuilder: refactor code list methods ([#1438], [#1439])
|
76
|
+
* remove unnecessary review-ext.rb from syntax-book ([#1446])
|
77
|
+
* add tests for IDGXMLMaker and TextMaker ([#1448])
|
78
|
+
* refactor around Index ([#1456], [#1457], [#1459])
|
79
|
+
* update jsclasses to version 2020/02/02 ([#1478])
|
80
|
+
|
81
|
+
## Contributors
|
82
|
+
* [@turky](https://github.com/turky)
|
83
|
+
|
84
|
+
[#1163]: https://github.com/kmuto/review/issues/1163
|
85
|
+
[#1412]: https://github.com/kmuto/review/pull/1412
|
86
|
+
[#1414]: https://github.com/kmuto/review/issues/1414
|
87
|
+
[#1416]: https://github.com/kmuto/review/issues/1416
|
88
|
+
[#1418]: https://github.com/kmuto/review/issues/1418
|
89
|
+
[#1420]: https://github.com/kmuto/review/issues/1420
|
90
|
+
[#1421]: https://github.com/kmuto/review/issues/1421
|
91
|
+
[#1424]: https://github.com/kmuto/review/pull/1424
|
92
|
+
[#1425]: https://github.com/kmuto/review/pull/1425
|
93
|
+
[#1426]: https://github.com/kmuto/review/pull/1426
|
94
|
+
[#1427]: https://github.com/kmuto/review/pull/1427
|
95
|
+
[#1428]: https://github.com/kmuto/review/pull/1428
|
96
|
+
[#1429]: https://github.com/kmuto/review/pull/1429
|
97
|
+
[#1430]: https://github.com/kmuto/review/pull/1430
|
98
|
+
[#1431]: https://github.com/kmuto/review/pull/1431
|
99
|
+
[#1432]: https://github.com/kmuto/review/issues/1432
|
100
|
+
[#1433]: https://github.com/kmuto/review/pull/1433
|
101
|
+
[#1436]: https://github.com/kmuto/review/pull/1436
|
102
|
+
[#1437]: https://github.com/kmuto/review/issues/1437
|
103
|
+
[#1438]: https://github.com/kmuto/review/pull/1438
|
104
|
+
[#1439]: https://github.com/kmuto/review/pull/1439
|
105
|
+
[#1442]: https://github.com/kmuto/review/issues/1442
|
106
|
+
[#1443]: https://github.com/kmuto/review/pull/1443
|
107
|
+
[#1445]: https://github.com/kmuto/review/pull/1445
|
108
|
+
[#1446]: https://github.com/kmuto/review/pull/1446
|
109
|
+
[#1447]: https://github.com/kmuto/review/issues/1447
|
110
|
+
[#1448]: https://github.com/kmuto/review/pull/1448
|
111
|
+
[#1449]: https://github.com/kmuto/review/pull/1449
|
112
|
+
[#1453]: https://github.com/kmuto/review/pull/1453
|
113
|
+
[#1455]: https://github.com/kmuto/review/pull/1455
|
114
|
+
[#1456]: https://github.com/kmuto/review/pull/1456
|
115
|
+
[#1457]: https://github.com/kmuto/review/pull/1457
|
116
|
+
[#1458]: https://github.com/kmuto/review/pull/1458
|
117
|
+
[#1459]: https://github.com/kmuto/review/pull/1459
|
118
|
+
[#1461]: https://github.com/kmuto/review/issues/1461
|
119
|
+
[#1462]: https://github.com/kmuto/review/issues/1462
|
120
|
+
[#1465]: https://github.com/kmuto/review/pull/1465
|
121
|
+
[#1466]: https://github.com/kmuto/review/pull/1466
|
122
|
+
[#1467]: https://github.com/kmuto/review/pull/1467
|
123
|
+
[#1468]: https://github.com/kmuto/review/pull/1468
|
124
|
+
[#1469]: https://github.com/kmuto/review/issues/1469
|
125
|
+
[#1474]: https://github.com/kmuto/review/issues/1474
|
126
|
+
[#1476]: https://github.com/kmuto/review/issues/1476
|
127
|
+
[#1478]: https://github.com/kmuto/review/issues/1478
|
128
|
+
[#1484]: https://github.com/kmuto/review/pull/1484
|
129
|
+
|
130
|
+
# Version 4.0.0
|
131
|
+
## New Features
|
132
|
+
* introduce review-idgxmlmaker which generates IDGXML files at once ([#1337])
|
133
|
+
* review-textmaker converts the math in the document to image files when `imgmath` parameter has `true` ([#1338])
|
134
|
+
* introduce wizard mode to layout of LaTeX on Web browser. Add `-w` option to review-init. This feature is experimental and may be replaced in the future ([#1403])
|
135
|
+
* experimental feature: introduce the feature to insert whitespace based on character when combining lines into a paragraph. To enable this, install unicode-eaw gem and add `join_lines_by_lang: true` into config.yml [#1362]
|
136
|
+
|
137
|
+
## Breaking Changes
|
138
|
+
* review-init no longer creates empty `layouts` folder ([#1340])
|
139
|
+
* PDFMaker: fix a problem that white space characters disappeared in `@<code>`, `@<tt>`, `@<tti>`, and `@<ttb>`. Also the string is automatically wrapped ([#1348])
|
140
|
+
* `//texequation`, `//embed` and `//graph` that don't allow inline op no longer escape inline op in strings. And don't put extra line break ([#1371], [#1374])
|
141
|
+
* PDFMaker: change the default table placement from `htp` to `H` for use in columns (`\floatplacement{table}` value in review-style.sty) [#1385]
|
142
|
+
* PDFMaker: the space between Japanese/Western characters in the code lists is changed to 0 from 1/4 character ([#1401])
|
143
|
+
* change the default value of `toc` parameter from null (false, don't create a table of contents) to true (create a table of contents) ([#1405])
|
144
|
+
|
145
|
+
## Bug Fixes
|
146
|
+
* fix a typo in review-jlreq ([#1350])
|
147
|
+
* fix incorrect result when `re` file uses CR for line-feed code ([#1341])
|
148
|
+
* PDFMaker: fix foreground color of `//cmd` with review-jlreq after page breaking ([#1363])
|
149
|
+
* PDFMaker: fix duplicate 'column' label for `@<column>` ([#1367])
|
150
|
+
* PDFMaker: copy gentombow.sty and jsbook.cls only for review-jsbook ([#1381])
|
151
|
+
* PDFMaker: fix invalid PDFDocumentInformation on review-jlreq with LuaLaTeX ([#1392])
|
152
|
+
* PDFMaker: fix missing hiddenfolio information at even pages on review-jlreq ([#1395])
|
153
|
+
|
154
|
+
## Enhancements
|
155
|
+
* support `@<em>` and `@<strong>` in IDGXMLBuilder ([#1353])
|
156
|
+
* PDFMaker: extract `code_line` and `code_line_num` from code blocks for ease handling each line ([#1368])
|
157
|
+
* PDFMaker: add new compile option `-halt-on-error` to make it easier to find the problem when an error occurs ([#1378])
|
158
|
+
* PDFMaker: when there is a footnote text (`//footnote`) in the column block, it may cuse problems such as numbering. So warn it if there is. ([#1379])
|
159
|
+
* Logger: progname should be add in logger, not in message arguments ([#1388])
|
160
|
+
* improve error checking for yaml files ([#1386])
|
161
|
+
* PDFMaker: the cover page becomes even number (p.0) and is named "cover" ([#1402])
|
162
|
+
* PDFMaker: refactor `generate_pdf` method ([#1404])
|
163
|
+
* create `.gitignore` for new project ([#1407])
|
164
|
+
|
165
|
+
## Docs
|
166
|
+
* update sample-book/README.md ([#1354])
|
167
|
+
* add descriptions about options of jsbook.cls to review-jsbook/README.md ([#1365])
|
168
|
+
|
169
|
+
## Others
|
170
|
+
* unify styles of a method with arguments ([#1360])
|
171
|
+
* `Catalog#{chaps,parts,predef,postdef,appendix}` should return Array, not String ([#1372])
|
172
|
+
* use `safe_load` for loading YAML ([#1375])
|
173
|
+
* refactor `table` method to simplify each builder ([#1356])
|
174
|
+
* refactor `XXX_header` and `XXX_body` ([#1359])
|
175
|
+
* enable `Builder#highlight?` method on each builder ([#1373])
|
176
|
+
* refactor mkdchap* and mkpart* ([#1383])
|
177
|
+
* don't update rubygems in Travis CI ([#1389])
|
178
|
+
* refactor around Index ([#1390])
|
179
|
+
* add configration for review-jlreq to sample documents ([#1391])
|
180
|
+
* definition list should start with spaces ([#1398])
|
181
|
+
|
182
|
+
## Contributors
|
183
|
+
* [@m-shibata](https://github.com/m-shibata)
|
184
|
+
* [@masarakki](https://github.com/masarakki)
|
185
|
+
|
186
|
+
[#1337]: https://github.com/kmuto/review/issues/1337
|
187
|
+
[#1338]: https://github.com/kmuto/review/issues/1338
|
188
|
+
[#1340]: https://github.com/kmuto/review/issues/1340
|
189
|
+
[#1341]: https://github.com/kmuto/review/issues/1341
|
190
|
+
[#1348]: https://github.com/kmuto/review/issues/1348
|
191
|
+
[#1350]: https://github.com/kmuto/review/issues/1350
|
192
|
+
[#1353]: https://github.com/kmuto/review/pull/1353
|
193
|
+
[#1354]: https://github.com/kmuto/review/pull/1354
|
194
|
+
[#1356]: https://github.com/kmuto/review/pull/1356
|
195
|
+
[#1359]: https://github.com/kmuto/review/pull/1359
|
196
|
+
[#1360]: https://github.com/kmuto/review/pull/1360
|
197
|
+
[#1362]: https://github.com/kmuto/review/pull/1362
|
198
|
+
[#1363]: https://github.com/kmuto/review/issues/1363
|
199
|
+
[#1365]: https://github.com/kmuto/review/pull/1365
|
200
|
+
[#1367]: https://github.com/kmuto/review/issues/1367
|
201
|
+
[#1368]: https://github.com/kmuto/review/issues/1368
|
202
|
+
[#1371]: https://github.com/kmuto/review/pull/1371
|
203
|
+
[#1372]: https://github.com/kmuto/review/pull/1372
|
204
|
+
[#1373]: https://github.com/kmuto/review/pull/1373
|
205
|
+
[#1374]: https://github.com/kmuto/review/pull/1374
|
206
|
+
[#1375]: https://github.com/kmuto/review/pull/1375
|
207
|
+
[#1378]: https://github.com/kmuto/review/pull/1378
|
208
|
+
[#1379]: https://github.com/kmuto/review/issues/1379
|
209
|
+
[#1381]: https://github.com/kmuto/review/issues/1381
|
210
|
+
[#1383]: https://github.com/kmuto/review/issues/1383
|
211
|
+
[#1385]: https://github.com/kmuto/review/issues/1385
|
212
|
+
[#1386]: https://github.com/kmuto/review/pull/1386
|
213
|
+
[#1388]: https://github.com/kmuto/review/pull/1388
|
214
|
+
[#1389]: https://github.com/kmuto/review/pull/1389
|
215
|
+
[#1390]: https://github.com/kmuto/review/pull/1390
|
216
|
+
[#1391]: https://github.com/kmuto/review/pull/1391
|
217
|
+
[#1392]: https://github.com/kmuto/review/issues/1392
|
218
|
+
[#1395]: https://github.com/kmuto/review/issues/1395
|
219
|
+
[#1398]: https://github.com/kmuto/review/issues/1398
|
220
|
+
[#1401]: https://github.com/kmuto/review/pull/1401
|
221
|
+
[#1402]: https://github.com/kmuto/review/pull/1402
|
222
|
+
[#1403]: https://github.com/kmuto/review/pull/1403
|
223
|
+
[#1404]: https://github.com/kmuto/review/pull/1404
|
224
|
+
[#1405]: https://github.com/kmuto/review/pull/1405
|
225
|
+
[#1407]: https://github.com/kmuto/review/pull/1407
|
226
|
+
|
227
|
+
# Version 3.2.0
|
228
|
+
|
229
|
+
## Breaking Changes
|
230
|
+
* PDFMaker: changed to use the abstract name `\reviewincludegraphics` instead of `\includegraphics` for image placements (such as `//image`) ([#1318])
|
231
|
+
|
232
|
+
## Bug Fixes
|
233
|
+
* reference to IDs of non-existent chapter now return standard key error (instead of internal error) ([#1284])
|
234
|
+
* fixed the value in the error message of review-compile ([#1286])
|
235
|
+
* PDFMaker: fixed the metadata of PDF page number was wrong when using review-jsbook with serial_pagination = true ([#1288])
|
236
|
+
* fixed a bug when using `@<hd>` to refer to headings with notoc, nodisp, or nonum ([#1294])
|
237
|
+
* PDFMaker: fixed an error in review-jlreq when using jlreq.cls version 0401 ([#1298])
|
238
|
+
* EPUBMaker: fixed a error of building EPUB2 ([#1301])
|
239
|
+
* EPUBMaker: added a workaround for a temporary folder deletion failure on Windows ([#1011])
|
240
|
+
* PDFMaker: support `@<bou>` ([#1220])
|
241
|
+
* PDFMaker: support old jlreq.cls ([#1317])
|
242
|
+
|
243
|
+
## Enhancements
|
244
|
+
* added test when `CHAPS:` is empty ([#1275])
|
245
|
+
* PDFMaker: for safety, inline typeface commands such as `\reviewtt` are defined with RobustCommand ([#1280])
|
246
|
+
* EPUBMaker: added `--debug` option to execute in debug mode ([#1281])
|
247
|
+
* review-epub2html: added `--inline-footnote` option to represent footnotes as inline ([#1283])
|
248
|
+
* EPUBMaker: added metadata of the cover image on EPUB3 for iBooks ([#1293])
|
249
|
+
* PDFMaker: suppressed the unexptected page break after the caption of code list or equation in review-jsbook and review-jlreq ([#1299])
|
250
|
+
* reformatted the codes using rubocop 0.67.2 ([#1297])
|
251
|
+
* added a test of building EPUB ([#1300])
|
252
|
+
* updated Ruby versions of test target to 2.4.6, 2.5.5, and 2.6.3 ([#1303])
|
253
|
+
* improved the code of YAMLLoader ([#1304])
|
254
|
+
* raise an error when invalid level is used in bullet ([#1313])
|
255
|
+
* extracted ReVIEW::Location class ([#1308])
|
256
|
+
* avoid multi-lined English words being combined without a space in bullets and bibliographic list (only in PDFMaker, at this time) ([#1312])
|
257
|
+
* raise an error when table is empty ([#1325])
|
258
|
+
* add some tests ([#1327], [#1328])
|
259
|
+
* MARKDOWNBilder: support `//listnum` ([#1336])
|
260
|
+
|
261
|
+
## Docs
|
262
|
+
* fixed the description about header levels ([#1309])
|
263
|
+
|
264
|
+
## Others
|
265
|
+
* removed ReVIEW::Preprocessor::Strip due to it is no longer used ([#1305])
|
266
|
+
|
267
|
+
## Contributors
|
268
|
+
* [@uetchy](https://github.com/uetchy)
|
269
|
+
* [@mitsuo0114](https://github.com/mitsuo0114)
|
270
|
+
|
271
|
+
[#1011]: https://github.com/kmuto/review/issues/1011
|
272
|
+
[#1220]: https://github.com/kmuto/review/issues/1220
|
273
|
+
[#1275]: https://github.com/kmuto/review/pull/1275
|
274
|
+
[#1280]: https://github.com/kmuto/review/pull/1280
|
275
|
+
[#1281]: https://github.com/kmuto/review/issues/1281
|
276
|
+
[#1283]: https://github.com/kmuto/review/pull/1283
|
277
|
+
[#1284]: https://github.com/kmuto/review/issues/1284
|
278
|
+
[#1286]: https://github.com/kmuto/review/pull/1286
|
279
|
+
[#1288]: https://github.com/kmuto/review/issues/1288
|
280
|
+
[#1293]: https://github.com/kmuto/review/pull/1293
|
281
|
+
[#1294]: https://github.com/kmuto/review/issues/1294
|
282
|
+
[#1297]: https://github.com/kmuto/review/pull/1297
|
283
|
+
[#1298]: https://github.com/kmuto/review/pull/1298
|
284
|
+
[#1299]: https://github.com/kmuto/review/pull/1299
|
285
|
+
[#1300]: https://github.com/kmuto/review/pull/1300
|
286
|
+
[#1301]: https://github.com/kmuto/review/pull/1301
|
287
|
+
[#1303]: https://github.com/kmuto/review/pull/1303
|
288
|
+
[#1304]: https://github.com/kmuto/review/pull/1304
|
289
|
+
[#1305]: https://github.com/kmuto/review/pull/1305
|
290
|
+
[#1308]: https://github.com/kmuto/review/pull/1308
|
291
|
+
[#1309]: https://github.com/kmuto/review/issues/1309
|
292
|
+
[#1312]: https://github.com/kmuto/review/issues/1312
|
293
|
+
[#1313]: https://github.com/kmuto/review/issues/1313
|
294
|
+
[#1317]: https://github.com/kmuto/review/pull/1317
|
295
|
+
[#1318]: https://github.com/kmuto/review/issues/1318
|
296
|
+
[#1325]: https://github.com/kmuto/review/issues/1325
|
297
|
+
[#1327]: https://github.com/kmuto/review/issues/1327
|
298
|
+
[#1328]: https://github.com/kmuto/review/pull/1328
|
299
|
+
[#1336]: https://github.com/kmuto/review/pull/1336
|
300
|
+
|
301
|
+
# Version 3.1.0
|
302
|
+
## Breaking Changes
|
303
|
+
* PDFMaker: introduce `\reviewimagecaption` macro for the caption of figure ([#1254]). Please update your review-base.sty by `review-update` command on your Re:VIEW 3 project.
|
304
|
+
* remove `--strip` option which is undocumented and doesn't work correctly from `review-preproc command` ([#1257])
|
305
|
+
|
306
|
+
## Bug Fixes
|
307
|
+
* PDFMaker: fix a problem that the section number of the part continues the section number in the previous chapter ([#1225],[#1226])
|
308
|
+
* fix copying of gentombow.sty in samples folder ([#1229])
|
309
|
+
* PDFMaker: fix that the number of lines specified by `number_of_lines` document option decrease by 1 line than originally on review-jsbook ([#1235])
|
310
|
+
* PDFMaker: fix review-jlreq to work with LuaLaTeX ([#1243])
|
311
|
+
* EPUBMaker: fix a problem that the hierachy of the table of contents become strange when there is a part ([#1262])
|
312
|
+
* fix escaping of `//comment` ([#1264])
|
313
|
+
* PDFMaker: fix overflowing when the left column of colophon is long ([#1252])
|
314
|
+
* fix an error when CHAPS: is empty ([#1273])
|
315
|
+
|
316
|
+
## Enhancements
|
317
|
+
* PDFMaker: load amssymb, amsthm, and bm packages which are often used as extension of mathematical expression ([#1224])
|
318
|
+
* HTMLBuilder: `emlist` and `listnum` now always pass `highlight` method as well as others ([#1231])
|
319
|
+
* EPUBMaker: implement a back-link to the text from the footnote ([#1233])
|
320
|
+
* PDFMaker: add `\makelines` macro to create a dummy line ([#1240])
|
321
|
+
* implement `#@warn` correctly ([#1258])
|
322
|
+
* `#@mapfile` now imports as is (keep tabs etc.) when imported file has `.re` extension ([#1247])
|
323
|
+
* add Ruby 2.6 for the test coverage ([#1242])
|
324
|
+
* PDFMaker: replace `zw` with `\zw` in review-jlreq. add a indent to paragraphs in the column ([#1250])
|
325
|
+
* PDFMaker: when `\reviewimagecaption` is undefined (implemented in [#1254]), define it ([#1267])
|
326
|
+
|
327
|
+
## Docs
|
328
|
+
* README.md: fix the filename of jsbook.cls ([#1239])
|
329
|
+
* add the note about `back_footnote` into config.yml.sample and update documents a little ([#1268])
|
330
|
+
|
331
|
+
## Contributors
|
332
|
+
* [@doublemarket](https://github.com/doublemarket)
|
333
|
+
* [@munepi](https://github.com/munepi)
|
334
|
+
|
335
|
+
[#1224]: https://github.com/kmuto/review/issues/1224
|
336
|
+
[#1225]: https://github.com/kmuto/review/pull/1225
|
337
|
+
[#1226]: https://github.com/kmuto/review/pull/1226
|
338
|
+
[#1229]: https://github.com/kmuto/review/pull/1229
|
339
|
+
[#1231]: https://github.com/kmuto/review/issues/1231
|
340
|
+
[#1233]: https://github.com/kmuto/review/issues/1233
|
341
|
+
[#1235]: https://github.com/kmuto/review/issues/1235
|
342
|
+
[#1239]: https://github.com/kmuto/review/pull/1239
|
343
|
+
[#1240]: https://github.com/kmuto/review/pull/1240
|
344
|
+
[#1242]: https://github.com/kmuto/review/pull/1242
|
345
|
+
[#1243]: https://github.com/kmuto/review/issues/1243
|
346
|
+
[#1247]: https://github.com/kmuto/review/issues/1247
|
347
|
+
[#1250]: https://github.com/kmuto/review/pull/1250
|
348
|
+
[#1252]: https://github.com/kmuto/review/issues/1252
|
349
|
+
[#1254]: https://github.com/kmuto/review/issues/1254
|
350
|
+
[#1257]: https://github.com/kmuto/review/issues/1257
|
351
|
+
[#1258]: https://github.com/kmuto/review/issues/1258
|
352
|
+
[#1262]: https://github.com/kmuto/review/issues/1262
|
353
|
+
[#1264]: https://github.com/kmuto/review/issues/1264
|
354
|
+
[#1267]: https://github.com/kmuto/review/issues/1267
|
355
|
+
[#1268]: https://github.com/kmuto/review/issues/1268
|
356
|
+
[#1273]: https://github.com/kmuto/review/issues/1273
|
357
|
+
|
1
358
|
# Version 3.0.0
|
2
359
|
|
3
360
|
## Bug Fixes
|
@@ -394,7 +751,7 @@
|
|
394
751
|
|
395
752
|
## Enhancements
|
396
753
|
|
397
|
-
* allow block `{
|
754
|
+
* allow block `{ ... //}` in `//indepimage`. ([#802])
|
398
755
|
* warn when images are not found in `//indepimage`([#803])
|
399
756
|
* LATEXBuilder: allow caption in `//source` ([#834])
|
400
757
|
|
data/README.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
# Re:VIEW
|
2
2
|
|
3
3
|
[![Gem Version](https://badge.fury.io/rb/review.svg)](http://badge.fury.io/rb/review)
|
4
|
-
[![Build Status](https://
|
4
|
+
[![Build Status](https://github.com/kmuto/review/workflows/Test/badge.svg)](https://github.com/kmuto/review/actions)
|
5
5
|
[![Build status](https://ci.appveyor.com/api/projects/status/github/kmuto/review?svg=true)](https://ci.appveyor.com/project/kmuto/review)
|
6
6
|
|
7
7
|
Re:VIEW is an easy-to-use digital publishing system for paper books and ebooks.
|
@@ -22,15 +22,17 @@ Re:VIEW uses its original format('Re:VIEW format') as source files. See doc/for
|
|
22
22
|
|
23
23
|
## Commands
|
24
24
|
|
25
|
-
There are
|
25
|
+
There are commands generate files directly.
|
26
26
|
|
27
27
|
* review-epubmaker: generate EPUB file.
|
28
28
|
* review-pdfmaker: generate PDF file using LaTeX (TeXLive).
|
29
29
|
* review-textmaker: generate text files.
|
30
30
|
* review-webmaker: generate Web pages.
|
31
|
+
* review-idgxmlmaker: generate InDesign XML files.
|
31
32
|
|
32
33
|
And some useful commands.
|
33
34
|
|
35
|
+
* review-init: create a project.
|
34
36
|
* review-compile: compile Re:VIEW format files.
|
35
37
|
* review-vol: figure out size of Re:VIEW files.
|
36
38
|
* review-index: generate index with various format.
|
@@ -60,10 +62,11 @@ $ echo "export PATH=PATH_OF_REVIEW/bin:$PATH" >> ~/.profile
|
|
60
62
|
$ review-init hello
|
61
63
|
$ cd hello
|
62
64
|
$ (... add and edit *.re file, config.yml and catalog.yml ...)
|
63
|
-
$ rake epub
|
64
|
-
$ rake pdf
|
65
|
-
$ rake text
|
66
|
-
$ rake web
|
65
|
+
$ rake epub ## generating EPUB
|
66
|
+
$ rake pdf ## generating PDF (Requirement TeXLive)
|
67
|
+
$ rake text ## generating texts
|
68
|
+
$ rake web ## generating Web pages
|
69
|
+
$ rake idgxml ## generating InDesign XML files
|
67
70
|
```
|
68
71
|
|
69
72
|
For further information, see [doc/quickstart.md](https://github.com/kmuto/review/blob/master/doc/quickstart.md)
|
@@ -108,8 +111,8 @@ Exception:
|
|
108
111
|
* jumoline.sty, vendor/jumoline: The LaTeX Project Public License. See [LPPL](https://github.com/kmuto/review/blob/master/vendor/jumoline/lppl.txt) file.
|
109
112
|
* plistings.sty, vendor/plistings: MIT License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/plistings/LICENSE) file.
|
110
113
|
* gentombow.sty, vendor/gentombow: BSD License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/gentombow/LICENSE) file.
|
111
|
-
* jsbook.
|
114
|
+
* jsbook.cls, vendor/jsclasses: BSD License. See [LICENSE](https://github.com/kmuto/review/blob/master/vendor/jsclasses/LICENSE) file.
|
112
115
|
|
113
116
|
## Copyright
|
114
117
|
|
115
|
-
Copyright (c) 2006-
|
118
|
+
Copyright (c) 2006-2020 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.
|
data/appveyor.yml
CHANGED
@@ -6,7 +6,6 @@ install:
|
|
6
6
|
build_script:
|
7
7
|
- bundle install
|
8
8
|
- bundle exec rake test --trace --verbose
|
9
|
-
- bundle exec rubocop
|
10
9
|
|
11
10
|
branches:
|
12
11
|
only:
|
@@ -14,5 +13,4 @@ branches:
|
|
14
13
|
|
15
14
|
environment:
|
16
15
|
matrix:
|
17
|
-
- ruby_version: "
|
18
|
-
- ruby_version: "23-x64"
|
16
|
+
- ruby_version: "26"
|
@@ -1,6 +1,6 @@
|
|
1
1
|
#!/usr/bin/env ruby
|
2
2
|
#
|
3
|
-
# Copyright (c) 2014-
|
3
|
+
# Copyright (c) 2014-2019 Masanori Kado, Kenshi Muto
|
4
4
|
#
|
5
5
|
# This program is free software.
|
6
6
|
# You can distribute or modify this program under the terms of
|
@@ -30,8 +30,8 @@ def main
|
|
30
30
|
|
31
31
|
begin
|
32
32
|
opts.parse!
|
33
|
-
rescue OptionParser::ParseError =>
|
34
|
-
@logger.error
|
33
|
+
rescue OptionParser::ParseError => e
|
34
|
+
@logger.error e.message
|
35
35
|
$stderr.puts opts.help
|
36
36
|
exit 1
|
37
37
|
end
|
@@ -140,7 +140,7 @@ end
|
|
140
140
|
def replace_old_style_part(dir)
|
141
141
|
catalog = ReVIEW::Catalog.new(File.open("#{dir}/catalog.yml"))
|
142
142
|
Array.new(catalog.parts.split("\n")).each_with_index do |part, part_idx|
|
143
|
-
next if part.end_with?
|
143
|
+
next if part.end_with?('.re')
|
144
144
|
|
145
145
|
allow_overwrite = true
|
146
146
|
part_name = sprintf('part%d.re', part_idx + 1)
|