Version 3.0.0 preview 3

Version 3.0.0 preview 3

New Features

• PDFMaker: instead of using jsbook.cls as it is, review-jsbook.cls (based on jsbook.cls, default) and review-jlreq.cls (based on jlreq.cls) are introduced. These supports the creation both paper and electronic PDF books. (#1032,#1117)
• EPUBMaker/WEBMaker: add imgmath function to image mathematical expressions (#868,#1138)

Breaking Changes

• PDFMaker: the location of \frontmatter is moved from the back of the titlepage to the front (#1128)
• PDFMaker: the cover image specified by coverimage is placed in the actual size and in the center (#1064,#1117)

Bug Fixes

• PDFMaker: fix an errror handling of cover parameter (#1116)
• PDFMaker: fix position misalignment in preview 2 (#1090,#1117)

Enhancements

• PDFMaker: increase the number of config.yml configuration parameters to LaTeX macros (#1121)
• PDFMaker: add hook \reviewbegindocumenthook just after \begin{document}, and add hook \reviewenddocumenthook just before \end{document} (#1111)
• PDFMaker: geometry.sty is no longer used, because the new class file can specify the paper design by document option (#912)
• PDFMaker: serial-pagination feature is supported in new class files (#1129)
• add network download function to review-init command. Specifying the URL of the zip file with -p option expands the zip file to the project folder (#812)
• PDFMaker: For expressing digital trim-marks and hidden page numbers (kakushi-nombre), the gentombow package (the external TeX package) has been included in vendor folder. It will be copied to the sty folder of the project folder (#1136)

Docs

• add a method of making Kindle e-book file to doc/customize_epub.ja.md (#1114)
• update examples of PDFMaker's default document options (#1115)
• clarify license of each file (#1093,#1112)
• add note about imgmath feature to doc/format.ja.md (#868)

Contributors

• @munepi

Version 3.0.0 preview 2

New Features

• add review-epub2html to produce single HTML file from EPUB file for CSS typesetting (#1098)

Breaking Changes

• PDFMaker: allow a path with space character on texcommand, dvicommmand, and makeindex_command. Due to this change, these parameters no longer take command options. use texoptions, dvioptions, and makeindex_options to specify options (#1091)
• PDFMaker: the file used internally has been changed from book.tex to __REVIEW_BOOK__.tex (#1081)
• PDFMaker: dropped geometry.sty from jsbook style (#912)
• PDFMaker: use twocolumn option for jsbook style (#1032)
• unified strings expanded by @<chapref>, @<hd>, and @<column> op between builders. you can customize it with locale.yml. @<chapref> will be expanded like Chapter 1 "FOO" (locale msgid: chapter_quote and chapter_quote_without_number). chapter_quote now takes two %s. @<hd> will be expanded like "2.1 BAR" (locale msgid: hd_quote and hd_quote_without_number). @<column> will be extended like Column BAZ (locale msgid: column) (#886)

Bug Fixes

• EPUBMaker: modified value of OPF file is now correct UTC time (#1094)
• fix an issue where bibliography file in contentdir could not be read (#1103)
• PDFMaker: fix an issue where the file specified by the parameter could not be found (#1086)
• fix a bug in the fence escaping that occurred in preview1 (#1083)
• remove unwanted tab character from sample CSS (#1084)

Enhancements

• PDFMaker: use \floatplacement to configure float settings of table and figure (#1095)
• EPUBMaker: use logger function to export error/warning (#1077)
• PDFMaker: do not use dvipdfmx when dvicommand parameter is null (#1065)

Docs

• Move sample documents to /samples folder (#1073)
• Add descriptions abount hooks and parameters of indexing into config.yml.sample (#1097)
• Fix typo in quickstart.md (#1079)

Contributors

• @aiya000
• @sho-h
• @kateinoigakukun

Version 3.0.0 preview 1

New Features

• .re files can be placed in subfolders by specifying a folder with contentdir parameter ([#920])
• //graph supports PlantUML ([#1006])
• add @<w> and @<wb> to expand the value corresponding to the specified key from CSV word file ([#1007], [#1010])
• LATEXBuilder: raise error when *.re file in catalog.yml does not exist ([#957])
• LATEXBuilder: add pxrubrica package to support 'ruby' ([#655])
• LATEXBuilder: support multiple layout files for LaTeX style ([#812])
• support inline @<balloon> as default settings ([#829])
• LATEXBuilder: allow to use Unicode character without otf package if possible ([#1045])
• override CONFIG_FILE in Rakefile with rake options ([#1059])

Breaking Changes

• When the value of review_version is 3 or more, @<m> no longer add a space before and after formula ([#943])
• the function of automatic detection of highlight target language by identifier in //list, //listnum is removed from HTMLBuilder ([#1016])
• LATEXBuilder: restructured layout.tex.erb ([#950])
• LATEXBuilder: add a new envirionment reviewlistblock in LaTeX ([#916])
• LATEXBuilder: attach plistings package and suport it instead of jlisting for listings ([#635])
• LATEXBuilder: remove underline in anchor for printing use ([#808])
• LATEXBuilder: use more abstract name like \reviewbold instead of \textbf ([#792])
• LATEXBuilder: cover and titlepage in config.yml is independently of each other ([#848])
• review-preproc: remove deprecated option --final ([#993])
• LATEXBuilder: captionblocks use new environments like reviewnote, not reviewminicolumn ([#1046])

Bug Fixes

• Fix redundant log display with Ruby 2.3 or later ([#975])
• for backward compatibility, revert usepackage parameter which was removed Version 2.5.0 ([#1001])
• HTMLBuilder: hide latex log of @<m>{...} amd //texequation{...//} ([#1027])
• LATEXBuilder: fix empty caption for listings ([#1040])
• fix load path of MeCab ([#1063])

Enhancements

• //graph now works on Windows ([#1008])
• file extensions of image files and font files becomes case insensitive ([#1002])
• review-pdfmaker: show executed command and its options ([#962],[#968])
• PDFMaker: support *.psd files as images ([#879])
• PDFMaker: texoptions in config.yml is "-interaction=nonstopmode -file-line-error" as default ([#1029])
• hide (latex and other commands') log messages ([#1036])
• MARKDOWNBuilder: support some commands ([#881])
• image_finder.rb: support symlinked directory ([#743])
• add files like catalog.yml as denendency relation ([#1060])

Docs

• add description of external tools used in //graph ([#1008])
• add description of @<w> and @<wb> ([#1007])
• add description of dvipdfmx option for zlib compression level (-z 9) in config.yml ([#935])

Contributors

• @TeTiRoss
• @kauplan
• @munepi
• @m-shibata

Version 2.5.0

Version 2.5.0

New Features

• add a new maker command review-textmaker to output plain text files (#926)
• LATEXBuilder: add a new parameter pdfmaker/bbox for settings of BoudingBox (#947)
• add a new command //blankline (#942)

Breaking Changes

• remove (incomplete) command //include (#887)
• LATEXBuilder: use \footnotemark implicitly for captions and headings (#841)
• EPUBMaker, WEBMaker: use pbl (publisher) instead of prt (printer) in titlepage (#927)

Bug Fixes

• fix column closing (#894)
• fix internal errors in @<hd> (#896)
• LATEXBuilder: fix to ignore empty caption (#922)
• fix invalid commmand errors in //graph when using gnuplot (#931)
• fix errors of review command in Windows (#940)
• EPUBMaker: fix error of removing temporary files in Windows (#946)

Enhancements

• remove tailing empty lines in block (captionblocks) such as //note. (#882)
• fix error messages when using non-existent ID of catalog.yml in inline commands such as @<chap> (#891)
• ignore UTF-8 BOM in catalog.yml (#899)
• LATEXBuilder: fix a length of horizontal line in colophon (#907)
• allow to use multiple parameters of texstyle in config.yml (#908)
• review-init: create lib/tasks folder to use original Rake commands (#921)
• review-init: copy doc folder into the target project (#918)
• add a help message of review (#933)
• show appropriate error messages when using invalid or non-existent YAML files (#958)
• show better error messages when using unknown ID in inline commands such as @<img> and @<table> (#954)
• show better error messages when compiling a file not included in catalog.yml (#953)
• LATEXBuilder: add IDs of table, imgtable, image and indepimage as comments (ex. \begin{reviewimage}%%sampleimg) (#937)

Docs

• add the rule of searching image files with extension (#939)
• add description of review-textmaker (#944)

Contributors

• @kauplan
• @krororo
• @mhidaka
• @Pegasus204

Version 2.4.0

New Features

• use built-in Logger class for warns and errors (#705)
• EPUBMaker: warn of large images because of rejecting ebook stores (#819)
• LATEXBuilder: add new inline command @<pageref> (#836)
• support inline notaion | | and $ $ instead of {} to surpress escaping } (#876)

Breaking Changes

• LATEXBuilder: use Roman numerals as part numbers (#837)
• EPUBMaker: TOC should be after frontmatter (#840)
• imgmath uses folder images/_review_math, not images directly (#856)
• EPUBMaker: default value of titlepage is true, not null (#862)
• EPUBMaker: params in template files should be config (#867)
• EWBBuilder is removed because nobody maintained it (#828)

Bug Fixes

• fix misrecognition of HeadlineIndex (#121)
• TOPBuilder: fix metric parameter in //image and //indepimage (#805)
• fix refering columns in other chapters (#817)
• use execution date when date in config.yml is empty (#824)
• fix I18N messages of listref, imgref, and tableref in frontmatters and backmatters (#830)
• WebMaker: fix booktitle using Hash (#831)
• LATEXBuilder: use lmodern package to avoid to use Type3 font in Western languages (#843)
• fix broken title using / in config.yml (#852)
• PDFMaker: fix toclevel (#846)

Enhancements

• allow block { 〜 //} in //indepimage. (#802)
• warn when images are not found in //indepimage(#803)
• LATEXBuilder: allow caption in //source (#834)

Docs

• add that installing LaTeX environments is needed to use rake pdf (#800)
• fix links in README.md (#815)
• add sample document to test commands of Re:VIEW (#833)
• fix comment of titlepage in config.yml (#847)
• fix description of footnotetext (#872)

Others

• fix coding rules to surpress rubocop v0.50.0 (#823)

Contributors

• @ryota-murakami
• @nasum
• @kokuyouwind

Version 2.3.0

New Features

• add //emtable, embedded table (#777) (#787)
• EPUBMaker: add new option imgmath (#773) (#774)
• HTMLBuilder: generate images for math notations (#774)

Bug Fixes

• LATEXBuilder: fix chpation numbering in appendix (#766)
• fix counting of //imgtable (#782)
• fix handling of numbered/itemized list in dlist. ([#794])(#795)

Enhancements

• add comments of backcover in doc/config.yml.sample (#765)(#767)
• use actual part counters for heading, list, image, and table in part (#779)
• LATEXBuilder: define the acceptable image formats for LaTeX Builder (#785)

Docs

• add //embed into NEWS.ja.md
• move doc/NEWS.* to top level directory (#780)
• add how to refer images in other sections (#770) (#771)
• fix description of //table markup (#776)
• Use https: instead of git: (#778)
• archive ChangeLog; use git log instead of ChangeLog (#784) (#788)

Others

• fix .rubocop.yml and suppress warnings

Contributors

• @karino2
• @imamurayusuke
• @znz
• @hanachin

Version 2.2.0

New Features

• PDFMaker: support index @<idx>, @<hidx> ([#261],[#660],[#669],[#740])
• add RSTBuilder ([#733],[#738])
• add //embed{...//} and @<embed>{...} ([#730],[#751],[#757],[#758])
• HTMLBuilder, IDGXMLBuilder, LATEXBuilder: suppot //firstlinenum for //listnum and //emlistnum ([#685],[#688])
• review-compile: --nolfinxml is deprecated ([#683],[#708])
• HTMLBuilder: Enclose references (@<img>, @<table>, and @<list>) with <span>. Class names are 'imgref', 'tableref', and 'listref'. ([#696],[#697])
• HTMLBuilder: support Rouge ([#684],[#710],[#711])

Breaking Changes

• LATEXBuilder: fix //source ([#681])
• fix escaping in inline ([#731])
  • \} -> }
  • \\ -> \
  • \x -> \x (when x != \ and x != })

Bug Fixes

• support comment for draft mode ([#360],[#717])
• i18n accepts mismatched number of arguments ([#667],[#723])
• support builder option for //tsize and //latextsize ([#716],[#719],[#720])
• remove ul_item() of html, idgxml, and markdown. ([#726],[#727])
• PDFMaker: reflect imagedir config ([#756],[#759])
• HTMLBuilder, LATEXBuilder, IDGXMLBuilder: use compile_inline in column tag
• review-init: Specify source file encoding on generating config. ([#761])
• EPUBMaker, PDFMaker: support subtitle for PDF and EPUB ([#742],[#745],[#747])
• TOPBuilder: fix @<list> ([#763])

Enhancements

• LATEXBuilder: enable jumoline.sty by default
• IDGXMLBuilder, HTMLBuilder: removes errors and warnings in published document ([#753])
• image_finder.rb: support symlinked directory ([#743])
• TOPBuilder: refactor headline ([#729])
• allow free format in history of config.yml ([#693])
• HTMLBuilder: put list's id into the attribute of div.caption-code ([#724])
• without rubyzip, skip zip test ([#713],[#714])
• suppress output on checking convert command ([#712],[#718])
• TOPBuilder: support @<bib> and //bibpaper ([#763])
• TOPBuilder: support [notoc] and [nodisp] ([#763])

Docs

• add makeindex.(ja.)md

Others

• fix .rubocop.yml and suppress warnings

Contributors

• @kuroda
• @olleolleolle
• @shirou
• @m-shibata
• @kenkiku1021

Version 2.1.0

New Features

• review-init: generate Gemfile ([#650])
• HTMLBuilder: add language specified class in list ([#666])
• HTMLBuilder: set id to
  of indepimage as same as image
• MD2INAOBuilder: support new builder MD2INAOBuilder ([#671])
• MARKDOWNBuilder, MD2INAOBuilder: support ruby ([#671])
• TEXTBuilder: support @<hd> ([#648])
• TOPBuilder: support @<comment>{} ([#625], [#627])

Breaking Changes

Bug Fixes

• review-validate: fix parsing blocks and comments in tables, and messages
• LATEXBuilder: fix when rights is null in config.yml ([#653])
• LATEXBuilder: escaping values from config.yml and locale.yml([#642])
• PDFMaker: support AI, EPS, and TIFF on pdfmaker correctly ([#675])
• PDFMaker: fix hooks; add @basehookdir and use it to get fullpath ([#662])
• EPUBMaker: fix missing default dc:identifier value ([#636])
• EPUBMaker: ext. of cover file should be "xhtml" in EPUB ([#618])
• WEBMaker: fix broken link ([#645])
• WEBMaker: fix when Part has no "*.re" file ([#641])
• I18n: fix %pJ in format_number_header ([#628])

Enhancements

• LATEXBuilder: use pxjahyper package in pLaTeX ([#640])
• LATEXBuilder: Enhanced implementation of layout.tex.erb ([#617])
• LATEXBuilder: fix to use keywords in locale.yml ([#629])
• IDGXMLBuilder: add instruction to column headline for toc ([#634])
• IDGXMLBuilder: fix to avoid empty caption in //emlist ([#633])
• Rakefile: add task preproc ([#630])
• ReVIEW::Location: add test ([#638])

Docs

• add customize_epub.md
• add preproc(.ja).md ([#632])
• config.yml: add csl in sample
• config.yml: add simplified sample ([#626])

Others

• license of template fils are MIT license([#663])
• rubocop: suppress warnings of rubocop

Contributors

• @kazken3
• @vvakame
• @masarakki
• @munepi
• @znz

Version 2.0.0

New Features

• Load ./config.yml if exists ([#477], [#479])
• config.yml: Add review_version ([#276], [#539], [#545])
  • Allow review_version to be nil, which means that I don't care about the version ([#592])
• Add experimental vertical orientation writing support ([#563])
• Support [notoc] and [nodisp] in header ([#506], [#555])
• Enable @<column> and @<hd> to refer other's column. ([#333], [#476])
• Add command //imgtable ([#499])
• Allow to use shortcut key of config ([#540])
  • enable to use @config["foo"] instead of @config["epubmaker"]["foo"] when using epubmaker
• Accept multiple YAML configurations using inherit parameter. ([#511], [#528])
• Add formats to i18n ([#520])
• Make rake run test and rubocop. ([#587])
• Add webmaker ([#498])
• LATEXBuilder: add option image_scale2width ([#543])
• PDFMaker: Migrate platex to uplatex ([#541])
• EPUBMaker: Support ebpaj format. ([#251], [#429])
• EPUBMaker: Add direction in default setting ([#508])
• EPUBMaker: Allow pronounciation of booktitle and author ([#507])
• review-preproc: allow monkeypatch in review-preproc ([#494])
• HTMLBuilder: Disable hyperlink with @<href> with epubmaker/externallink: false in config.yml ([#509], [#544])
• EPUBMaker: Add custom prefix and <meta> element in OPF ([#513])
• PDFMaker: support history in config ([#566])

Breaking Changes

• Update epubversion and htmlversion ([#542])
• Delete backward compatibility of 'param'. ([#594])
• config.yml: 'pygments:' is obsoleted. ([#604])
• Remove backward compatibility ([#560])
  • layout.erb -> layout.html.erb
  • locale.yaml -> locale.yml
  • PageMetric.a5 -> PageMetric::A5
  • raise error when using locale.yaml and layout.erb
  • prt is printer(印刷所), not publisher(発行所). 発行所 is pbl. ([#562, #593])
• Obsolete appendix_format ([#609])
• Remove obsolete inaobuilder. (upstream changed their mind to use modified Markdown) ([#573])
• Remove obsolete legacy epubmaker
• review-compile: Remove -a/--all option ([#481])

Bug Fixes

• Escape html correctly. ([#589], [#591])
• review-epubmaker: fix error of not copying all images. ([#224])
• Fix several bugs around [nonum]. ([#301], [#436], [#506], [#550], [#554], [#555])
• IDGXMLBuilder: fix wrong calcuration between pt and mm for table cell width on IDGXML. ([#558])
• HTMLBuilder: use class instead of width for //image[scale=XXX] ([#482], [#372]). It fixes on epubcheck test.

Refactorings

• Support named parameters in EPUBmaker/PDFmaker ([#534])
• Add ReVIEW::YAMLLoader ([#518])
• Remove global variables. ([#240])
• Set warning to false in test. ([#597])
• Avoid warnings (avoid circular require, unused variable, redefining methods, too many args) ([#599], [#601])
• MakerHelper: class -> module ([#582])
• review-init: generate config.yml from doc/config.yml.sample. ([#580])
• Unify template engine ReVIEW::Template ([#576])
  • HTMLBuilder: remove HTMLLayout
  • LATEXBuilder: use instance variable in templates ([#598])
  • LATEXBuilder: move lib/review/layout.tex.erb to templates/latex/ ([#572])
• Update config.yml.sample ([#579])
• Remove code for 1.8 and 1.9.3 in test (for Travis) ([#577])
• Fix LaTeX templates ([#575])
• Use read BOM|utf-8 flag for opening files, instead of string replacing ([#574])
• review-preproc: set default_external encoding UTF-8. ([#486])
• Fix pdf and epub build_path on debug ([#564], [#556])
• Refactor EPUBMaker. ([#533])
• Use SecureRandom.uuid instead of ruby-uuid ([#497])
• epubmaker, pdfmaker: Use ReVIEW::Converter instead of system() ([#493])
• Remove zip command and use PureRuby Zip library ([#487])
• review-index: refine TOCParser and TOCPrinter ([#486])
• Remove deprecated parameters, change default value of some parameters. ([#547])
• sample config.yml should be config.yml.* ([#538])
• Add Hash#deep_merge ([#523])
• LATEXBuilder: use \reviewunderline instead of \Underline ([#408])
• Add name_of and names_of method into Configure class to take 'name' attribute value. ([#534])
• EPUBMaker: reflected colophon_order. ([#460])
• TOCPrinter: remove IDGTOCPrinter. ([#486])
• Add new methods: Book#catalog=(catalog) and Catalog.new(obj) ([93691d0])
• Chapter and Part: do not use lazy loading. ([#491])

Docs

• README: rdoc -> md ([#610])
• Update format.md, quickstart.md
• Add note about writing vertical document and PDFMaker
• Fix document in EN ([#588])

Code contributors

• @arikui1911

Version 1.7.2

Bug Fix

• Fix latexbuilder to show caption in //list without highlighting ([#465])
• Fix markdownbuilder to use definition list ([#473])