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)

Version 5.0.0

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

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)

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

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
• @masarakki

Version 3.2.0

Breaking Changes

• PDFMaker: changed to use the abstract name \reviewincludegraphics instead of \includegraphics for image placements (such as //image) (#1318)

Bug Fixes

• reference to IDs of non-existent chapter now return standard key error (instead of internal error) (#1284)
• fixed the value in the error message of review-compile (#1286)
• PDFMaker: fixed the metadata of PDF page number was wrong when using review-jsbook with serial_pagination = true (#1288)
• fixed a bug when using @<hd> to refer to headings with notoc, nodisp, or nonum (#1294)
• PDFMaker: fixed an error in review-jlreq when using jlreq.cls version 0401 (#1298)
• EPUBMaker: fixed a error of building EPUB2 (#1301)
• EPUBMaker: added a workaround for a temporary folder deletion failure on Windows (#1011)
• PDFMaker: support @<bou> (#1220)
• PDFMaker: support old jlreq.cls (#1317)

Enhancements

• added test when CHAPS: is empty (#1275)
• PDFMaker: for safety, inline typeface commands such as \reviewtt are defined with RobustCommand (#1280)
• EPUBMaker: added --debug option to execute in debug mode (#1281)
• review-epub2html: added --inline-footnote option to represent footnotes as inline (#1283)
• EPUBMaker: added metadata of the cover image on EPUB3 for iBooks (#1293)
• PDFMaker: suppressed the unexptected page break after the caption of code list or equation in review-jsbook and review-jlreq (#1299)
• reformatted the codes using rubocop 0.67.2 (#1297)
• added a test of building EPUB (#1300)
• updated Ruby versions of test target to 2.4.6, 2.5.5, and 2.6.3 (#1303)
• improved the code of YAMLLoader (#1304)
• raise an error when invalid level is used in bullet (#1313)
• extracted ReVIEW::Location class (#1308)
• avoid multi-lined English words being combined without a space in bullets and bibliographic list (only in PDFMaker, at this time) (#1312)
• raise an error when table is empty (#1325)
• add some tests (#1327, #1328)
• MARKDOWNBilder: support //listnum (#1336)

Docs

• fixed the description about header levels (#1309)

Others

• removed ReVIEW::Preprocessor::Strip due to it is no longer used (#1305)

Contributors

• @uetchy
• @mitsuo0114

Version 3.1.0

Breaking Changes

• 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.
• remove --strip option which is undocumented and doesn't work correctly from review-preproc command (#1257)

Bug Fixes

• PDFMaker: fix a problem that the section number of the part continues the section number in the previous chapter (#1225,#1226)
• fix copying of gentombow.sty in samples folder (#1229)
• PDFMaker: fix that the number of lines specified by number_of_lines document option decrease by 1 line than originally on review-jsbook (#1235)
• PDFMaker: fix review-jlreq to work with LuaLaTeX (#1243)
• EPUBMaker: fix a problem that the hierachy of the table of contents become strange when there is a part (#1262)
• fix escaping of //comment (#1264)
• PDFMaker: fix overflowing when the left column of colophon is long (#1252)
• fix an error when CHAPS: is empty (#1273)

Enhancements

• PDFMaker: load amssymb, amsthm, and bm packages which are often used as extension of mathematical expression (#1224)
• HTMLBuilder: emlist and listnum now always pass highlight method as well as others (#1231)
• EPUBMaker: implement a back-link to the text from the footnote (#1233)
• PDFMaker: add \makelines macro to create a dummy line (#1240)
• implement #@warn correctly (#1258)
• #@mapfile now imports as is (keep tabs etc.) when imported file has .re extension (#1247)
• add Ruby 2.6 for the test coverage (#1242)
• PDFMaker: replace zw with \zw in review-jlreq. add a indent to paragraphs in the column (#1250)
• PDFMaker: when \reviewimagecaption is undefined (implemented in #1254), define it (#1267)

Docs

• README.md: fix the filename of jsbook.cls (#1239)
• add the note about back_footnote into config.yml.sample and update documents a little (#1268)

Contributors

• @doublemarket
• @munepi

Version 3.0.0

Bug Fixes

• PDFMaker: adjust the loading of external files in review-jsbook.cls (#1217)

Contributors

• @munepi

Version 3.0.0 Release Candidate

Breaking Changes

• PDFMaker: heading character size of review-jsbook becomes the same as the original jsbook (#1152)
• PDFMaker: Q, W, L, H parameters of review-jsbook are withdrawn. Projects created in the past preview version can be updated with the review-update command (#1151,#1201)

Bug Fixes

• PDFMaker: fixes an issue that hiddenfolio parameter was ignored when using both hiddenfolio and tombopaper in review-jsbook (#1158)
• PDFMaker: fixes a problem that the paperwidth and paperheight parameters of review-jsbook didn't work (#1171)
• fixes an issue that review-update ignored update of sty folder (#1183)

Enhancements

• PDFMaker: in review-jsbook, you can specify the font size with fontsize parameter and the line height with baselineskip parameter with units such as pt and mm (#1151)
• PDFMaker: users who want to continue using the original jsbook.cls class file for some reason can use sty files of review-jsbook set (#1177)
• PDFMaker: add useful macros to review-jsbook and review-jlreq for users. \oneblankpage creates an empty page. \clearoddpage breaks page as necessary so that the next page is always an even page (#1175,#1182)
• PDFMaker: add media parameter that specifies the type of PDF to review-jsbook and review-jlreq. This has the same meaning as cameraready (#1181)
• PDFMaker: sections are now allowed in part (#1195)
• PDFMaker: \reviewusepart macro is defined when theare is a part (#1199)
• texdocumentclass parameter is explicit (not a comment) when creating config.yml by review-init (#1202)
• PDFMaker: line feed (@<br>) in the table is now represented by \newline macro when the width is explicity specified with //tsize (#1206)
• PDFMaker: enable to use L{width} (left justified), C{width} (centering), R{width} (right justified) as representation of the table column width (#1208)
• PDFMaker: to avoid implementation differences between versions, the snapshots jsbook.cls (2018/06/23) and gentombow.sty (2018/08/30 v0.9j) are copied to the sty folder (#1210)

Bug Fixes

• PDFMaker: fix serial_pagination and startpage were not working in review-jlreq class (#1204)

Docs

• update format_idg.ja.md (#1188)
• add note about review-update command to quickstart guide quickstart.ja.md (#1189)
• update comments of config.yml.sample (#1190)
• update pdfmaker.ja.md (#1191)
• update writing_vertical.ja.md (#1198)
• update document of review-jsbook (#1203)
• update document of review-jlreq (#1204)

Contributors

• @munepi

Version 3.0.0 preview 4

New Features

• new command review-update is added, which updates the setting of the project files to the new version (#1144)
• texequation representing an expression can now be numbered and captioned. To reference this you can use the @<eq> operator (#1167)

Breaking Changes

• In IDGXMLBuilder, PlaintextBuilder, and TextBuilder, the expansion result of @<chapref> is no longer created in a unique way. Like other builders, it uses the chapter_quote locale string (#1160)

Bug Fixes

• samples collection could not generate PDF in preview 3. Now it works with rake pdf (#1156)

Enhancements

• PDFMaker: support hiddenfolio parameter with review-jlreq.cls (#1147)
• EPUBMaker/WEBMaker: when imgmath function is enabled, font size is passed to each //texequation (#1146)