Review v5.0.0 Release Notes

Release Date: 2020-10-29 // almost 3 years ago
  • ๐Ÿ”– 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)
    • 0๏ธโƒฃ 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 and (#1528)
    • ๐Ÿ›  fix incorrect example in (#1584)


    • ๐Ÿ”จ 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 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 Base#catalog is just getter now (#1551)
    • ๐Ÿ‘‰ use File.write when it can be used (#1560)
    • โœ‚ remove Builder#builder_init() (#1564)


Previous changes from v4.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)
    • 0๏ธโƒฃ 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)


    • ๐Ÿ’Ž GitHub Actions: use ruby/setup-ruby instead of eregon/use-ruby-action (#1490)
    • โœ… skip artifacts in the sample folder during testing (#1504)