review 3.2.0 → 5.1.0

data/NEWS.md

@@ -1,6 +1,433 @@
-# Version 3.2.0
+# Version 5.1.0
+## New Features
+* added Rake rule to call [Vivliostyle-CLI](https://github.com/vivliostyle/vivliostyle-cli), CSS typesetting formatter. Create a PDF with `rake vivliostyle:build` or `rake vivliostyle`, and open a preview with `rake vivliostyle:preview` ([#1663])
+* PDFMaker: introduced `boxsetting` parameter to choose and customize the decorations for column, note, memo, tip, info, warning, important, caution and notice ([#1637])
+* added inline op, `@<ins>` (indicates an insertion) and `@<del>` (indicates a deletion) ([#1630])
+* EPUBMaker, WebMaker: MathJax is now supported. Added `math_format` parameter to choose the mathematical expression method ([#1587], [#1614])
+
+## Breaking Changes
+* EPUBMaker: changed the default value of the `urnid` parameter from `urn:uid` to `urn:uuid` ([#1658])
+* PDFMaker: footnotes are no longer broken up by a page ([#1607])
+
+## Bug Fixes
+* fixed WebMaker, review-vol and review-index errors when `contentdir` is defined ([#1633])
+* WebMaker: fixed `images/html` foder not being found ([#1623])
+* PDFMaker: fixed chapterlink in term list ([#1619])
+* PDFMaker: fixed errors when index contains `{`, `}`, or `|` ([#1611])
+* review-vol: valid error messages will be displayed when invalid headings are found ([#1604])
+* PDFMaker: `after_makeindex` hook to be executed after `mendex` execution, not after LaTeX compilation ([#1605])
+* PDFMaker: if the caption of `//image` is empty, the figure number will be printed instead of an internal error ([#1666])
+* fixed review-vol and review-index errors when a file is invalid ([#1671])
+* EPUBMaker: fixed an error when static file is missing ([#1670])
+
+## Enhancements
+* Maker commands now display with nice colors and icons for their progress status when tty-logger gem is installed ([#1660])
+* PDFMaker: added `\RequirePackage{plautopatch}` definition to class files ([#1644])
+* MARKDOWNBuilder: supported `@<hd>` ([#1629])
+* Re:VIEW now reports an error when a document file contains invalid escape sequence characters ([#1596], [#1602])
+* an error is raised when there are more than 6 `=` in a heading ([#1591])
+
+## Docs
+* documented the name of the image folder referenced by Makers ([#1626])
+
+## Others
+* EPUBMaker: moved EPUB library from `lib/epubmaker` to `lib/review/epubmaker` and refactored it ([#1575], [#1617], [#1635], [#1640], [#1641], [#1650], [#1653], [#1655])
+* EPUBMaker: added tests ([#1656])
+* PDFMaker: refactored some ([#1664])
+* introduced `ReVIEW::ImgMath` class to handle mathematic images ([#1642], [#1649], [#1659], [#1662])
+* IDGXMLMaker: refactored some ([#1654])
+* MakerHelper: refactored some ([#1652])
+* introduced `ReVIEW::Template.generate` class to handle the templates ([#1648])
+* added a test of TeX compilation to GitHub Actions ([#1643])
+* refactored codes according to Rubocop 1.10 ([#1593], [#1598], [#1613], [#1636], [#1647], [#1669])
+* fixed duplicate IDs of syntax-book sample ([#1646])
+* refactored the way to reference relative pathes ([#1639])
+* refactored `ReVIEW::LineInput` class ([#1638])
+* update Copyright to 2021 ([#1632])
+* added Ruby 3.0 to the test platform ([#1622])
+* suppressed tests for Pygments ([#1610], [#1618])
+* WebTocPrinter: fixed an error of test ([#1606])
+* improved to make it easier to specify the target of the test ([#1594])
+
+[#1671]: https://github.com/kmuto/review/issues/1671
+[#1670]: https://github.com/kmuto/review/pull/1670
+[#1669]: https://github.com/kmuto/review/pull/1669
+[#1666]: https://github.com/kmuto/review/issues/1666
+[#1664]: https://github.com/kmuto/review/pull/1664
+[#1663]: https://github.com/kmuto/review/pull/1663
+[#1662]: https://github.com/kmuto/review/issues/1662
+[#1660]: https://github.com/kmuto/review/issues/1660
+[#1659]: https://github.com/kmuto/review/pull/1659
+[#1658]: https://github.com/kmuto/review/pull/1658
+[#1656]: https://github.com/kmuto/review/pull/1656
+[#1655]: https://github.com/kmuto/review/pull/1655
+[#1654]: https://github.com/kmuto/review/pull/1654
+[#1653]: https://github.com/kmuto/review/pull/1653
+[#1652]: https://github.com/kmuto/review/pull/1652
+[#1650]: https://github.com/kmuto/review/pull/1650
+[#1649]: https://github.com/kmuto/review/pull/1649
+[#1648]: https://github.com/kmuto/review/pull/1648
+[#1647]: https://github.com/kmuto/review/pull/1647
+[#1646]: https://github.com/kmuto/review/pull/1646
+[#1644]: https://github.com/kmuto/review/issues/1644
+[#1643]: https://github.com/kmuto/review/pull/1643
+[#1642]: https://github.com/kmuto/review/pull/1642
+[#1641]: https://github.com/kmuto/review/pull/1641
+[#1640]: https://github.com/kmuto/review/pull/1640
+[#1639]: https://github.com/kmuto/review/pull/1639
+[#1638]: https://github.com/kmuto/review/pull/1638
+[#1637]: https://github.com/kmuto/review/pull/1637
+[#1636]: https://github.com/kmuto/review/pull/1636
+[#1635]: https://github.com/kmuto/review/pull/1635
+[#1633]: https://github.com/kmuto/review/issues/1633
+[#1632]: https://github.com/kmuto/review/issues/1632
+[#1630]: https://github.com/kmuto/review/issues/1630
+[#1629]: https://github.com/kmuto/review/pull/1629
+[#1626]: https://github.com/kmuto/review/pull/1626
+[#1623]: https://github.com/kmuto/review/issues/1623
+[#1622]: https://github.com/kmuto/review/pull/1622
+[#1619]: https://github.com/kmuto/review/issues/1619
+[#1618]: https://github.com/kmuto/review/pull/1618
+[#1617]: https://github.com/kmuto/review/pull/1617
+[#1614]: https://github.com/kmuto/review/pull/1614
+[#1613]: https://github.com/kmuto/review/pull/1613
+[#1611]: https://github.com/kmuto/review/issues/1611
+[#1610]: https://github.com/kmuto/review/pull/1610
+[#1607]: https://github.com/kmuto/review/issues/1607
+[#1606]: https://github.com/kmuto/review/issues/1606
+[#1605]: https://github.com/kmuto/review/issues/1605
+[#1604]: https://github.com/kmuto/review/issues/1604
+[#1602]: https://github.com/kmuto/review/pull/1602
+[#1598]: https://github.com/kmuto/review/pull/1598
+[#1596]: https://github.com/kmuto/review/issues/1596
+[#1594]: https://github.com/kmuto/review/pull/1594
+[#1593]: https://github.com/kmuto/review/pull/1593
+[#1591]: https://github.com/kmuto/review/issues/1591
+[#1587]: https://github.com/kmuto/review/issues/1587
+[#1575]: https://github.com/kmuto/review/issues/1575
+
+# Version 5.0.0
+## New Features
+* added `cover_fit_page` option to review-jsbook / review-jlreq classes. When `cover_fit_page=true` is specified in the `texdocumentclass` parameter, the cover image is scaled to paper size. Note: it is recommended that the images should be created at actual size ([#1534])
+* allow minicolumn nesting. Now you can put a block instruction such as `//image` or itemized list in minicolumn (`//note`, `//memo`, `//tip`, `//info`, `//warning`, `//important`, `//caution`, `//notice`) ([#1558], [#1562])
+* added single commands `//beginchild` and `//endchild` for nesting itemized/enumerate/description list. **EXPERIMENTAL FEATURE** ([#1497])
+
+## Breaking Changes
+* In review-jlreq.cls, hiddenfolio is now implemented by jlreqtrimmarkssetup. It is slightly different from the previous version in position and display ([#1397])
+* The default value of the `chapterlink` parameter is now true. Most links (chapter, section, image, table, list, equation, bibliography) in Web and EPUB are now hyperlinked. In TeX PDF, some links (chapter, section, biliography) are hyperlinked only when `media=ebook` ([#1529])
+
+## Bug Fixes
+* PDFMaker: fixed a problem with multiple same-named image files with different extensions that would cause them to be misaligned ([#1483])
+* PDFMaker: fixed a problem that cuased an error when the author name (`aut`) was empty ([#1517])
+* PDFMaker: fixed a problem that caused an error if `//indepimage`'s image file didn't exist and ID contained characters to be TeX-escaped ([#1527])
+* PDFMaker: fixed a problem with characters to be TeX-escaped in the `bookttilename` and `aut` parameters causing incorrect PDF metainformation ([#1533])
+* WebMaker: fixed to avoid nil in HTML template ([#1545])
+* PDFMaker: fixed a problem when hiding chapter numbers ([#1559])
+* MarkdownBuilder: paragraphs in minicolumn should be separated with a blank line instead of a newline ([#1572])
+
+## Enhancements
+* fix warning message to output more detailed information of item ([#1523])
+* PDFMaker: make `@<hd>` op a hyperlink (when `media=ebook`) ([#1530])
+* use `cgi/escape` first and `cgi/util` as fallback. remove orignal implementation in `ReVIEW::HTMLUtils.escape()` ([#1536])
+* suppress warning with same `@<icon>` ([#1541])
+* fix an error handling when a badly encoded file is received ([#1544])
+* introduce IndexBuilder. IndexBuilder first scans the entire project files and provides indexes for each builder ([#1384], [#1552])
+* IDs and labels containing below characters or space characters are now warned ([#1393], [#1574])
+```
+#%\{}[]~/$'"|*?&<>`
+```
+
+## Docs
+* fix a typo in format.ja.md and format.md ([#1528])
+* fix incorrect example in makeindex.ja.md ([#1584])
+
+## Others
+* refactor code with Rubocop 0.92.0 ([#1511], [#1569], [#1573])
+* rename `@strategy` to `@builder` in `Re:VIEW::Compiler` ([#1520])
+* refactor code with Rubocop-performance 1.7.1 ([#1521])
+* update Gemfile in syntax-book ([#1522])
+* calling GhostScript in ImageMagick has been deprecated, so the test has been removed ([#1526])
+* unnecessary stderr output on some test units has been suppressed ([#1538])
+* add `BookUnit` class instead of `Compilable` module, the super class of `Chapter` and `Part` ([#1543])
+* `ReVIEW::Book.load` is deprecated, use `ReVIEW::Book::Base.load` or `ReVIEW::Book::Base.new` add new option `:config` for `ReVIEW::Book::Base.load` ([#1548], [#1563])
+* added `ReVIEW::Configure.create` ([#1549])
+* WebMaker: removed unused `clean_mathdir` ([#1550])
+* add `Base#parse_catalog_file()` and use it in `ReVIEW::Book::Base.new()`. `Base#catalog` is just getter now  ([#1551])
+* use `File.write` when it can be used ([#1560])
+* remove `Builder#builder_init()` ([#1564])
+
+## Contributors
+* [@snoozer05](https://github.com/snoozer05)
+
+[#1384]: https://github.com/kmuto/review/pull/1384
+[#1393]: https://github.com/kmuto/review/issues/1393
+[#1397]: https://github.com/kmuto/review/issues/1397
+[#1483]: https://github.com/kmuto/review/issues/1483
+[#1497]: https://github.com/kmuto/review/pull/1497
+[#1511]: https://github.com/kmuto/review/pull/1511
+[#1517]: https://github.com/kmuto/review/issues/1517
+[#1520]: https://github.com/kmuto/review/pull/1520
+[#1521]: https://github.com/kmuto/review/pull/1521
+[#1522]: https://github.com/kmuto/review/pull/1522
+[#1523]: https://github.com/kmuto/review/pull/1523
+[#1526]: https://github.com/kmuto/review/pull/1526
+[#1527]: https://github.com/kmuto/review/pull/1527
+[#1528]: https://github.com/kmuto/review/pull/1528
+[#1529]: https://github.com/kmuto/review/issues/1529
+[#1530]: https://github.com/kmuto/review/issues/1530
+[#1533]: https://github.com/kmuto/review/issues/1533
+[#1534]: https://github.com/kmuto/review/issues/1534
+[#1536]: https://github.com/kmuto/review/pull/1536
+[#1538]: https://github.com/kmuto/review/pull/1538
+[#1541]: https://github.com/kmuto/review/pull/1541
+[#1543]: https://github.com/kmuto/review/pull/1543
+[#1544]: https://github.com/kmuto/review/issues/1544
+[#1545]: https://github.com/kmuto/review/issues/1545
+[#1548]: https://github.com/kmuto/review/pull/1548
+[#1549]: https://github.com/kmuto/review/pull/1549
+[#1550]: https://github.com/kmuto/review/pull/1550
+[#1551]: https://github.com/kmuto/review/pull/1551
+[#1552]: https://github.com/kmuto/review/pull/1552
+[#1558]: https://github.com/kmuto/review/pull/1558
+[#1559]: https://github.com/kmuto/review/issues/1559
+[#1560]: https://github.com/kmuto/review/pull/1560
+[#1562]: https://github.com/kmuto/review/pull/1562
+[#1563]: https://github.com/kmuto/review/pull/1563
+[#1564]: https://github.com/kmuto/review/pull/1564
+[#1569]: https://github.com/kmuto/review/pull/1569
+[#1572]: https://github.com/kmuto/review/pull/1572
+[#1573]: https://github.com/kmuto/review/pull/1573
+[#1574]: https://github.com/kmuto/review/issues/1574
+[#1584]: https://github.com/kmuto/review/pull/1584
+
+# Version 4.2.0
+## New Features
+* 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])
+
+## Breaking Changes
+* 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])
+* 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])
+
+## Bug Fixes
+* remove duplicated `@non_parsed_commands` declaration ([#1499])
+* mathematical images not being created in WebMaker and TextMaker has been fixed ([#1501])
+
+## Enhancements
+* improve a performance of building math figures on imgmath ([#1488])
+* 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])
 
+## Others
+* GitHub Actions: use `ruby/setup-ruby` instead of `eregon/use-ruby-action` ([#1490])
+* skip artifacts in the sample folder during testing ([#1504])
+
+[#1320]: https://github.com/kmuto/review/issues/1320
+[#1485]: https://github.com/kmuto/review/issues/1485
+[#1488]: https://github.com/kmuto/review/issues/1488
+[#1490]: https://github.com/kmuto/review/pull/1490
+[#1499]: https://github.com/kmuto/review/issues/1499
+[#1501]: https://github.com/kmuto/review/pull/1501
+[#1504]: https://github.com/kmuto/review/pull/1504
+[#1505]: https://github.com/kmuto/review/issues/1505
+
+# Version 4.1.0
 ## New Features
+* 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])
+* PDFMaker, EPUBMaker, WEBMaker, TEXTMaker, IDGXMLMaker: add `-y` (`--only`) option to specify the files to convert instead of all files ([#1428])
+* add `--without-config-comment` option to review-init command to exclude comments from config.yml ([#1453])
+* 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])
+
+## Breaking Changes
+* PDFMaker: `image_scale2width` parameter has been moved under `pdfmaker` section ([#1462])
+
+## Bug Fixes
+* PDFMaker: fix backward compatibility error with Re:VIEW 3 ([#1414])
+* PDFMaker: fix an error when compiling review-jlreq with LuaLaTeX ([#1416])
+* PDFMaker: fix index not being included in the table of contents ([#1418])
+* RSTBuilder: fix conversion failure due to incorrect method argument handling ([#1426])
+* IDGXMLBuilder: there was an error in the warning handling for the table ([#1427])
+* IDGXMLMaker: there was an error in the processing when an error occurred in the filter program ([#1429])
+* PDFMaker: fix a build failure when using inline operators such as `@<code>` or `@<tt>` for heading with `media=ebook` mode ([#1432], [#1465])
+* PDFMaker: raise just warning instead of error, when MeCab isn't installed ([#1445])
+* IDGXMLBuilder: fix `//imgtable` to work correctly ([#1448])
+* PDFMaker: fix an error when makeindex is true but no index is registered ([#1467])
+* PDFMaker: fix missing footnotes in a description list ([#1476])
+* review-index: fix an error when `@<w>` exists in headlines ([#1484])
+
+## Enhancements
+* PDFMaker: add version to .cls/.sty files ([#1163])
+* update Dockerfile ([#1412])
+* IDGXMLMaker: show the contents of stderr from the filter program ([#1443])
+* add *-idgxml folder entry to .gitignore ([#1448])
+* `//source` can now omit options in all builders ([#1447])
+* add Ruby 2.7 to the test targets ([#1468])
+* allow a setting of multiple word\_file ([#1469])
+* EPUBMaker: warn when there is no heading in .re file ([#1474])
+
+## Docs
+* add the description about `contact` and `colophon_order` to `config.yml.sample` ([#1425])
+* update quickstart.ja.md and quickstart.md to Re:VIEW 4 ([#1442])
+* update syntax-book sample document ([#1448], [#1449])
+* update README.md ([#1455], [#1458])
+* update format.ja.md and format.md. add the description about `::` notation which sets builder-specific options to images ([#1421])
+
+## Others
+* refactor codes with Rubocop 0.78.0 ([#1424], [#1430])
+* run PDF build test more strictly when there is LaTeX runtime environment ([#1433])
+* switch the build test suite from Travis CI to GitHub Actions ([#1431], [#1436], [#1437])
+* IDGXMLBuilder: refactor code list methods ([#1438], [#1439])
+* remove unnecessary review-ext.rb from syntax-book ([#1446])
+* add tests for IDGXMLMaker and TextMaker ([#1448])
+* refactor around Index ([#1456], [#1457], [#1459])
+* update jsclasses to version 2020/02/02 ([#1478])
+
+## Contributors
+* [@turky](https://github.com/turky)
+
+[#1163]: https://github.com/kmuto/review/issues/1163
+[#1412]: https://github.com/kmuto/review/pull/1412
+[#1414]: https://github.com/kmuto/review/issues/1414
+[#1416]: https://github.com/kmuto/review/issues/1416
+[#1418]: https://github.com/kmuto/review/issues/1418
+[#1420]: https://github.com/kmuto/review/issues/1420
+[#1421]: https://github.com/kmuto/review/issues/1421
+[#1424]: https://github.com/kmuto/review/pull/1424
+[#1425]: https://github.com/kmuto/review/pull/1425
+[#1426]: https://github.com/kmuto/review/pull/1426
+[#1427]: https://github.com/kmuto/review/pull/1427
+[#1428]: https://github.com/kmuto/review/pull/1428
+[#1429]: https://github.com/kmuto/review/pull/1429
+[#1430]: https://github.com/kmuto/review/pull/1430
+[#1431]: https://github.com/kmuto/review/pull/1431
+[#1432]: https://github.com/kmuto/review/issues/1432
+[#1433]: https://github.com/kmuto/review/pull/1433
+[#1436]: https://github.com/kmuto/review/pull/1436
+[#1437]: https://github.com/kmuto/review/issues/1437
+[#1438]: https://github.com/kmuto/review/pull/1438
+[#1439]: https://github.com/kmuto/review/pull/1439
+[#1442]: https://github.com/kmuto/review/issues/1442
+[#1443]: https://github.com/kmuto/review/pull/1443
+[#1445]: https://github.com/kmuto/review/pull/1445
+[#1446]: https://github.com/kmuto/review/pull/1446
+[#1447]: https://github.com/kmuto/review/issues/1447
+[#1448]: https://github.com/kmuto/review/pull/1448
+[#1449]: https://github.com/kmuto/review/pull/1449
+[#1453]: https://github.com/kmuto/review/pull/1453
+[#1455]: https://github.com/kmuto/review/pull/1455
+[#1456]: https://github.com/kmuto/review/pull/1456
+[#1457]: https://github.com/kmuto/review/pull/1457
+[#1458]: https://github.com/kmuto/review/pull/1458
+[#1459]: https://github.com/kmuto/review/pull/1459
+[#1461]: https://github.com/kmuto/review/issues/1461
+[#1462]: https://github.com/kmuto/review/issues/1462
+[#1465]: https://github.com/kmuto/review/pull/1465
+[#1466]: https://github.com/kmuto/review/pull/1466
+[#1467]: https://github.com/kmuto/review/pull/1467
+[#1468]: https://github.com/kmuto/review/pull/1468
+[#1469]: https://github.com/kmuto/review/issues/1469
+[#1474]: https://github.com/kmuto/review/issues/1474
+[#1476]: https://github.com/kmuto/review/issues/1476
+[#1478]: https://github.com/kmuto/review/issues/1478
+[#1484]: https://github.com/kmuto/review/pull/1484
+
+# Version 4.0.0
+## New Features
+* introduce review-idgxmlmaker which generates IDGXML files at once ([#1337])
+* review-textmaker converts the math in the document to image files when `imgmath` parameter has `true` ([#1338])
+* 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])
+* 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]
+
+## Breaking Changes
+* review-init no longer creates empty `layouts` folder ([#1340])
+* PDFMaker: fix a problem that white space characters disappeared in `@<code>`, `@<tt>`, `@<tti>`, and `@<ttb>`. Also the string is automatically wrapped ([#1348])
+* `//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])
+* PDFMaker: change the default table placement from `htp` to `H` for use in columns (`\floatplacement{table}` value in review-style.sty) [#1385]
+* PDFMaker: the space between Japanese/Western characters in the code lists is changed to 0 from 1/4 character ([#1401])
+* 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])
+
+## Bug Fixes
+* fix a typo in review-jlreq ([#1350])
+* fix incorrect result when `re` file uses CR for line-feed code ([#1341])
+* PDFMaker: fix foreground color of `//cmd` with review-jlreq after page breaking ([#1363])
+* PDFMaker: fix duplicate 'column' label for `@<column>` ([#1367])
+* PDFMaker: copy gentombow.sty and jsbook.cls only for review-jsbook ([#1381])
+* PDFMaker: fix invalid PDFDocumentInformation on review-jlreq with LuaLaTeX ([#1392])
+* PDFMaker: fix missing hiddenfolio information at even pages on review-jlreq ([#1395])
+
+## Enhancements
+* support `@<em>` and `@<strong>` in IDGXMLBuilder ([#1353])
+* PDFMaker: extract `code_line` and `code_line_num` from code blocks for ease handling each line ([#1368])
+* PDFMaker: add new compile option `-halt-on-error` to make it easier to find the problem when an error occurs ([#1378])
+* 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])
+* Logger: progname should be add in logger, not in message arguments ([#1388])
+* improve error checking for yaml files ([#1386])
+* PDFMaker: the cover page becomes even number (p.0) and is named "cover" ([#1402])
+* PDFMaker: refactor `generate_pdf` method ([#1404])
+* create `.gitignore` for new project ([#1407])
+
+## Docs
+* update sample-book/README.md ([#1354])
+* add descriptions about options of jsbook.cls to review-jsbook/README.md ([#1365])
+
+## Others
+* unify styles of a method with arguments ([#1360])
+* `Catalog#{chaps,parts,predef,postdef,appendix}` should return Array, not String ([#1372])
+* use `safe_load` for loading YAML ([#1375])
+* refactor `table` method to simplify each builder ([#1356])
+* refactor `XXX_header` and `XXX_body` ([#1359])
+* enable `Builder#highlight?` method on each builder ([#1373])
+* refactor mkdchap* and mkpart* ([#1383])
+* don't update rubygems in Travis CI ([#1389])
+* refactor around Index ([#1390])
+* add configration for review-jlreq to sample documents ([#1391])
+* definition list should start with spaces ([#1398])
+
+## Contributors
+* [@m-shibata](https://github.com/m-shibata)
+* [@masarakki](https://github.com/masarakki)
+
+[#1337]: https://github.com/kmuto/review/issues/1337
+[#1338]: https://github.com/kmuto/review/issues/1338
+[#1340]: https://github.com/kmuto/review/issues/1340
+[#1341]: https://github.com/kmuto/review/issues/1341
+[#1348]: https://github.com/kmuto/review/issues/1348
+[#1350]: https://github.com/kmuto/review/issues/1350
+[#1353]: https://github.com/kmuto/review/pull/1353
+[#1354]: https://github.com/kmuto/review/pull/1354
+[#1356]: https://github.com/kmuto/review/pull/1356
+[#1359]: https://github.com/kmuto/review/pull/1359
+[#1360]: https://github.com/kmuto/review/pull/1360
+[#1362]: https://github.com/kmuto/review/pull/1362
+[#1363]: https://github.com/kmuto/review/issues/1363
+[#1365]: https://github.com/kmuto/review/pull/1365
+[#1367]: https://github.com/kmuto/review/issues/1367
+[#1368]: https://github.com/kmuto/review/issues/1368
+[#1371]: https://github.com/kmuto/review/pull/1371
+[#1372]: https://github.com/kmuto/review/pull/1372
+[#1373]: https://github.com/kmuto/review/pull/1373
+[#1374]: https://github.com/kmuto/review/pull/1374
+[#1375]: https://github.com/kmuto/review/pull/1375
+[#1378]: https://github.com/kmuto/review/pull/1378
+[#1379]: https://github.com/kmuto/review/issues/1379
+[#1381]: https://github.com/kmuto/review/issues/1381
+[#1383]: https://github.com/kmuto/review/issues/1383
+[#1385]: https://github.com/kmuto/review/issues/1385
+[#1386]: https://github.com/kmuto/review/pull/1386
+[#1388]: https://github.com/kmuto/review/pull/1388
+[#1389]: https://github.com/kmuto/review/pull/1389
+[#1390]: https://github.com/kmuto/review/pull/1390
+[#1391]: https://github.com/kmuto/review/pull/1391
+[#1392]: https://github.com/kmuto/review/issues/1392
+[#1395]: https://github.com/kmuto/review/issues/1395
+[#1398]: https://github.com/kmuto/review/issues/1398
+[#1401]: https://github.com/kmuto/review/pull/1401
+[#1402]: https://github.com/kmuto/review/pull/1402
+[#1403]: https://github.com/kmuto/review/pull/1403
+[#1404]: https://github.com/kmuto/review/pull/1404
+[#1405]: https://github.com/kmuto/review/pull/1405
+[#1407]: https://github.com/kmuto/review/pull/1407
+
+# Version 3.2.0
+
 ## Breaking Changes
 * PDFMaker: changed to use the abstract name `\reviewincludegraphics` instead of `\includegraphics` for image placements (such as `//image`) ([#1318])
 
@@ -526,7 +953,7 @@
 
 ## Enhancements
 
-* allow block `{ 〜 //}` in `//indepimage`. ([#802])
+* allow block `{ ... //}` in `//indepimage`. ([#802])
 * warn when images are not found in `//indepimage`([#803])
 * LATEXBuilder: allow caption in `//source` ([#834])
 

data/README.md

@@ -1,7 +1,7 @@
 # Re:VIEW
 
 [![Gem Version](https://badge.fury.io/rb/review.svg)](http://badge.fury.io/rb/review)
-[![Build Status](https://secure.travis-ci.org/kmuto/review.svg)](http://travis-ci.org/kmuto/review)
+[![Build Status](https://github.com/kmuto/review/workflows/Test/badge.svg)](https://github.com/kmuto/review/actions)
 [![Build status](https://ci.appveyor.com/api/projects/status/github/kmuto/review?svg=true)](https://ci.appveyor.com/project/kmuto/review)
 
 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
 
 ## Commands
 
-There are two commands generate files directly.
+There are commands generate files directly.
 
 * review-epubmaker: generate EPUB file.
 * review-pdfmaker: generate PDF file using LaTeX (TeXLive).
 * review-textmaker: generate text files.
 * review-webmaker: generate Web pages.
+* review-idgxmlmaker: generate InDesign XML files.
 
 And some useful commands.
 
+* review-init: create a project.
 * review-compile: compile Re:VIEW format files.
 * review-vol: figure out size of Re:VIEW files.
 * review-index: generate index with various format.
@@ -60,10 +62,12 @@ $ echo "export PATH=PATH_OF_REVIEW/bin:$PATH" >> ~/.profile
 $ review-init hello
 $ cd hello
 $ (... add and edit *.re file, config.yml and catalog.yml ...)
-$ rake epub  ## generating EPUB
-$ rake pdf   ## generating PDF (Requirement TeXLive)
-$ rake text  ## generating texts
-$ rake web   ## generating Web pages
+$ rake epub         ## generating EPUB
+$ rake pdf          ## generating PDF (Requirement TeXLive)
+$ rake text         ## generating texts
+$ rake web          ## generating Web pages
+$ rake idgxml       ## generating InDesign XML files
+$ rake vivliostyle  ## generating PDF using Vivliostyle-CLI (Requirement Vivliostyle-CLI)
 ```
 
 For further information, see [doc/quickstart.md](https://github.com/kmuto/review/blob/master/doc/quickstart.md)
@@ -112,4 +116,4 @@ Exception:
 
 ## Copyright
 
-Copyright (c) 2006-2019 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.
+Copyright (c) 2006-2021 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.