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. Whencover_fit_page=true
is specified in thetexdocumentclass
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 whenmedia=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
andaut
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 (whenmedia=ebook
) (#1530) - ๐ use
cgi/escape
first andcgi/util
as fallback. remove orignal implementation inReVIEW::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
inRe: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 ofCompilable
module, the super class ofChapter
andPart
(#1543) - ๐
ReVIEW::Book.load
is deprecated, useReVIEW::Book::Base.load
orReVIEW::Book::Base.new
add new option:config
forReVIEW::Book::Base.load
(#1548, #1563) - โ added
ReVIEW::Configure.create
(#1549) - ๐ WebMaker: removed unused
clean_mathdir
(#1550) - add
Base#parse_catalog_file()
and use it inReVIEW::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
- added
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 parametersimage
,table
,list
, andequation
and the value istop
orbottom
(#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)
Others
- introduce