Summary
This release contains a bunch of bug fixes, some minor refinements, and a handful of long-awaited enhancements. This is the last release candidate before the final 1.5.0 release, so be sure to give it a good test! The suite of nearly 1,000 tests should certainly help. Since the last release, we got the full test suite running again on Windows (Ruby 2.3-2.7 and JRuby), so we're even more confident in the results it gives us.
The main issue fixed by this release is the placement of inline images. The correct amount of space is once again reserved for inline images so text in the same line doesn't run together. This is most noticeable if you use the Asciidoctor Mathematical extension. If an entry in the TOC wraps across a page boundary, the dots leading up to the page number will be displayed on the page with the page number. If you use a background image in your document, the converter will not crash if the image is not readable. If the theme file has a syntax error, you'll see a log message that tells you the location of the error (and the default theme will be used instead). If a font with an absolute path cannot be found, the search path is not reported. And log messages are no longer emitted from the scratch document, so you should not see duplicate messages about the same problem.
So what are these long-awaited enhancements? Well, there are some good ones. The custom theme can now merge its font catalog with the theme it extends. This makes it easy to create custom themes that use custom fonts. If one of those fonts only has a single style (such as an emoji font), you can register it once by assigning the path directly to the font name (e.g., MyEmoji: /path/to/my-emoji.ttf). Speaking of emoji, the default-with-fallback-font theme (-a pdf-theme=default-with-fallback-font) now ships with an emoji fallback font by default (NotoEmoji). So you can have fun playing with emoji in your document. If your custom font is missing a character, you can discover which character by enabling verbose mode (-v). You can use remote images for any background image specified in the theme or as the running content image (when the allow-uri-read attribute is set on the document). Speaking of the running content, the vertical alignment can be further controlled using an offset as the second value (e.g., [top, 10]). And the max-width on an image or table caption can be specified as a % of the container width.
You may be interested in an early draft of a dark theme, which you can find in the examples directory. See https://github.com/asciidoctor/asciidoctor-pdf/blob/master/examples/chronicles-dark-theme.yml
Consult the CHANGELOG to find the complete list of changes.
Distribution
Changelog
- reserve space for inline image correctly so it doesn't mangle the character spacing in the line when the image wraps (#1516)
- allow custom theme to merge font catalog with theme being extended (#1505)
- allow font path to be declared once for all font styles (#1507)
- continue border, background, and column rule of admonition block on subsequent pages when block gets split (#1287)
- allow max-width on caption be specified as a percentage (of the container width) (#1484)
- add support for remote image in running content (if allow-uri-read attribute is set) (#1536)
- add support for remote background images specified by theme (if allow-uri-read attribute is set) (#1536)
- add support for remote title page logo image specified by theme (if allow-uri-read attribute is set) (#1536)
- place dots on correct page when section title in TOC wraps across a page boundary (#1533)
- add destination to top of imported PDF if ID is specified on image block
- log reason if theme file cannot be parsed or compiled (#1491)
- fix crash if background image in theme is not readable
- bundle emoji font and use as fallback in default-with-fallback-font theme (#1129)
- add dark theme for chronicles example
- allow vertical-align key for header and footer categories to accept numeric offset as second value (e.g., [top, 10]) (#1488)
- link font family for abstract and sidebar to heading font family if only latter is set
- if path of missing font is absolute, don't suggest that it was not found in the fontsdir
- allow use of style "regular" as alias for "normal" when defining font
- emit warning in verbose mode if glyph cannot be found in fallback font (#1529)
- don't crash if table is empty and emit warning (#607)
- only emit warning when non-WINANSI character is used with AFM font if verbose mode is enabled
- do not emit warning when non-WINANSI character is used with AFM font inside scratch document
- do not emit log messages from scratch document
- upgrade treetop to 1.6
- reenable tests on Windows (#1499) @slonopotamus
Release meta
Released on: 2019-02-04
Released by: @mojavelinux
Release beer: Sterling Tripel by Peak View
Logs: resolved issues | full diff
Credits
A very special thanks to all the awesome supporters of the Asciidoctor OpenCollective campaign who provided critical funding for the development of this release as well as ongoing development of the project.