Version 5.9.0

Bug Fixes

• LATEXBuilder: fix the spacing for @<code>, @<tt>, @<tti>, @<ttb> to be more appropriate. Also improved handling of PDF bookmarks (#1906, #1907).

Enhancements

• differentiated between JIS B and ISO B paper sizes in review-jlreq.cls Users Guide (#1904).
• fix typos in config.yml.sample (#1909).

Contributors

• @munepi
• @koshikawa

Version 5.8.0

New Features

• The //graph operator allows graphical description in Mermaid notation. See doc/format.md for details on prepairing and setting up external tools (#1885)

Bug Fixes

• EPUBMaker: fix <title> not being included in the auto-generated part content (#1898)

Enhancements

• PDFMaker: fix to wrap long URLs with @<href> operator (#1890)

Contributors

• @munepi

Version 5.7.0

Bug Fixes

• Fixed error when omitting a bind address of review-init -w on Windows (#1824)
• EPUBMaker: escape <, >, and & when converting to MathJax to avoid HTML errors (#1876, #1877)

Breaking Changes

• Ruby 2.6 or earlier was excluded from the operation verification (#1871)
• EPUMaker: included a link to the cover in the table of contents according to EPUB validation rules (#1874)

Others

• Ruby 3.2 is now included in the testing target (#1871)
• refactor code with RuboCop 1.45.1 (#1878)

Version 5.6.0

New Features

• IDGXMLBuilder: support imgmath math_format in //texequation and @<m> (#1829)
• LATEXBuilder: use reviewicon macro instead of reviewincludegraphics in @<icon> (#1838)
• trim spaces before/after characters in ruby text (#1839)

Breaking Changes

• LATEXBuilder: use MEMO, NOTICE, CAUTION or other headers instead of ■メモ. If you want to use older headers, add ■メモ in locale.yml. (#1856)

Others

• update documents format.md and format.ja.md (#1860)

Version 5.5.0

New Features

• introduced @<secref>, @<sec>, and @<sectitle> as inline op to refer sections (#1809)

Bug Fixes

• fixed test error (#1804)
• fixed an error of review-update (#1807)

Others

• added rexml to gemspec (#1808)

Version 5.4.0

New Features

• GitHub Discussions has been opened to answer questions about Re:VIEW

Breaking Changes

• EPUBMaker: manifest/item in the opf file is now sorted by the dictional order of ID strings (#1763)
• TextMaker: the separator line now put between the heading rows and the normal rows of the table. To revert this behavior to old version, set textmaker/th_bold parameter to true (#1789)
• TextMaker: the output result of the //indepimage op has been adjusted to //image (#1790)
• TextMaker: the output result of the //imgtable op has been adjusted to //image and //table (#1791)
• //source op is now also not escaped when highlighting is enabled (#1788)

Bug Fixes

• fixed YAML error in Ruby 3.1 and kept backward compatibility (#1767, #1775)
• EPUBMaker: removed epub:type=cover from titlepage and colophon (#1776)
• removed invalid urnid sample (#1779)
• when there is a syntax error in config.yml, exit with proper error message instead of an exception (#1797)
• IDGXMLMaker: fixed an error to compile prefaces or postfaces when secttags is enabled (#1800)

Enhancements

• EPUBMaker, WebMaker: use layout.html.erb or layout-web.html.erb as the base template for cover, titlepage, colophon, and part, just like regular chapters (#1780)
• EPUBMaker, WebMaker: cover, titlepage, colophon, and part can now be overwritten with _cover.html.erb, _titlepage.html.erb, _colophon.html.erb, _colophon_history.html.erb, and _part_body.html.erb (#1777)

Docs

• mentioned GitHub Discussions in README.md (#1772)

Others

• refactor code with RuboCop 1.25.1 (#1773, #1782, #1783, #1784, #1792)

Version 5.3.0

New Features

• add the future of endnote. //endnote specifies the content of the endnote, @<endnote> specifies the reference to the endnote, and //printendnotes places endnotes (#1724)

Bug Fixes

• fixed an error in new jlreq that caused it to become independent of ifthen package (#1718)
• fixed an issue with hidden folio being set to all 1 when using review-jsbook with TeXLive 2020 or later (#1720)
• fixed an error that occurred when a non-existent file was specified in the coverimage parameter (#1726, #1729)
• it now warns when a non-existent file is specified in the titlefile, creditfile, and profile parameters (#1730)
• fixed @<tcy> op error in review-jlreq. this op will be expanded into \reviewtcy macro (#1733)
• fixed exception errors in review-vol and review-index (#1740)
• fixed forgetting to copy __IMGMATH_BODY__.tex when math compiling error occurs (#1747)
• fixed the problem that the position of //beginchild and //endchild is not displayed when an error occurs (#1742)
• fixed a build error when using //graph op (#1744)
• fixed undefined variable in epubmaker.rb (#1755)
• fixed execution error in review-catalog-converter (#1753)

Enhancements

• warnings are now given when footnotes (//footnote) and endnotes (//endnote) are defined but not referenced (@<fn>, @<endnote>) (#1725)
• \includefullpagegraphics macro that pastes an image over the entire page now supports vertical writing (#1734)
• try to find plantuml.jar from the working folder, /usr/share/plantuml, or /usr/share/java (#1760)

Docs

• format.ja.md, format.md: fixed a mistake in the command line for creating SVG formulas (#1748)

Others

• added tests for Ruby 2.7 for Windows (#1743)
• refactor code with Rubocop 1.22.1 (#1759)

Contributors

• @munepi
• @huideyeren

Version 5.2.0

New Features

• EPUBMaker: added <section> based on heading level for CSS formatting, when the epubmaker/use_section parameter is set to true (#1685)

Bug Fixes

• PDFMaker: fixed a problem that caused a warning in templates for Ruby 2.6 and above (#1683)
• EPUBMaker: fixed an issue that caused copied files to be empty in Docker environments (#1686)
• added CSS style for correct displaying horizontal characters in vertical typesetting (#1688)
• PDFMaker: fixed the pxjahyper option conflict error on latest TeXLive (#1690)
• PDFMaker: fixed compile error when image is not found (#1706)

Enhancements

• improve around warn and error handling (#1674)
• PDFMaker: introduced pdfmaker/use_symlink parameter to speed up the process by using symbolic links instead of actual copies. This may not work on some operating systems such as Windows (#1696)
• PDFMaker: don't insert empty page after frontmatter when using review-jlreq with serial_pagination=true, openany (#1711)

Others

• fixed related to GitHub Actions (#1684, #1691)
• review-preproc: refactored (#1697)
• refactored nested lists handling (#1698)
• refactor code with Rubocop 1.12 (#1689, #1692, #1699, #1700)
• The builder_init_file method of each builder now executes super first to use base builder's builder_init_file (#1702)
• PDFMaker: Stopped implicitly including FileUtils library (#1704)

Contributors

• @odaki
• @imamurayusuke

Version 5.1.1

Bug Fixes

• Fix the runtime error of review-preproc (#1679)

Version 5.1.0

New Features

• added Rake rule to call 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)