CHANGELOG.adoc

Asciidoctor PDF Changelog

This document provides a high-level view of the changes to the Asciidoctor PDF by release. For a detailed view of what has changed, refer to the commit history on GitHub.

1.5.0.alpha.13 (2016-09-19) - @mojavelinux

• Add support for mirror (recto/verso) margins and facing pages when media=prepress

• Add non-breaking hyphen glyph to built-in fonts so its intended behavior is honored (#462)

• Add page break before a book part (#329)

• Allow running (header/footer) content to be arranged in columns (#449)

• Allow font properties to be set per element in running content (#454)

• Prevent the SVG from modifying the document font (#494)

• Implement decorative border for multipage quote and verse blocks (#270, #557, #558)

• Encode anchors in hex that contain characters outside of ASCII range (#481, #301)

• Size the line number gutter correctly (accounting for width of largest line number) (#402)

• Allow theme to specify default value for pdfwidth attribute on image and document in README (#455)

• Fix front matter page numbering by adding page labels for all front matter pages in outline (#458)

• Allow image type to be specified explicitly using format attribute on image macro (#540)

• Add support for literal and verse table cell styles

• Preserve indentation in literal and verse table cells

• Preserve paragraph breaks in normal table cells

• Honor value of width attribute even when autowidth option is set on table (#519)

• Align table title to left edge of table, regardless of table alignment (#469)

• Add support for reversed option on ordered list (#491)

• Don’t drop whitespace in front of conum on final line of source block (#470)

• Add more control over position of elements on title page, including support for vw units (#418)

• Allow table caption position/side to be controlled by theme (#531)

• Use base_align setting from theme as default alignment for headings

• Resolve bare image-related attribute values relative to base_dir

• Only allow Prawn SVG to fetch remote images if the allow-uri-read attribute is set (#548)

• Introduce page_margin_inner and page_margin_outer keys to theme

• Start title page, toc, main content, parts, and chapters on recto page when media=prepress and doctype=book

• Allow default font style for table to be set via theme (table_font_style)

• Use correct default bullet per nested unordered list level (#529)

• Call start_new_part at start of each book part

• Delegate to layout_part_title method to layout part title

• Don’t match a special section as a chapter unless the doctype is book

• Fix list marker placement when list item touches bottom of page

• Eliminate excessive spacing between list items that contain nested lists

• Drop lines in running (header/footer) content with unresolved attributes (#522)

• Ensure start_new_chapter is always executed at a chapter transition (#524)

• Add support for root xref (e.g., included-doc.adoc) (#521)

• Prevent block from spilling to next page if there’s no more content (#361)

• Add support for px units to pdf-page-size attribute

• Fix parsing error when value of pdf-page-size attribute is unitless

• Don’t crash if table is empty (#480)

• Don’t crash when deleting last remaining page; don’t delete last page if empty

• Don’t orphan space between conums when extracting from verbatim block (#506)

• Properly scope attr and attr? lookups

• Rename internal page_start and page_end attributes to pdf-page-start and pdf-page-end, respectively

• Fix settings for table header cell

• Fix padding around content of quote block in default theme

• Read theme file with UTF-8 encoding (#533)

• Allow temporary image file to be deleted on Windows (#425)

• Don’t crash if theme file is empty (#551)

• Don’t crash if cover image can’t be read; warn instead

• Clarify in theming guide how to write numbers with 3 or more digits (#555)

• Document how inline images are sized

• Document how to disable default footer from theme

• Update explanation of WINANSI encoding behavior in theming guide

• Restore support for Ruby 1.9.3 (#528)

• Upgrade prawn-icon to 1.2.0 (which upgrades Font Awesome to 4.6.3)

• Upgrade prawn-svg to 0.25.2 (by way of more lenient version range)

• Fix Ruby warnings

• Document in README how image paths are resolved

• Configure README for better preview on GitHub

• Update chronicles example to modern AsciiDoc syntax; update content

1.5.0.alpha.12 (2016-08-05) - @mojavelinux

• Fix incompatibility with Rouge 2 source highlighter (#471)

• Declare rouge gem in Gemfile for use with examples

• Add option to make URLs visible in printed PDF using show-link-uri or media=print attributes (#435, #463)

• Document options for scaling an image (#453)

• Add support for images to span width of page (#424)

• Fix embedding of remote images; fix case when imagesdir is a URI (#467)

• Collapse non-significant whitespace (#465)

• Document how to inherit font size for a given heading level (#460)

• Decode character references in link URIs (#448)

• Use arrow as caret for menu path instead of pipe (#441)

• Document theme-related AsciiDoc attributes in theming guide (#428)

• Section title alignment should be customizable via theme (#343)

• Collapse all whitespace when normalizing (#355)

• Require space on either side of math operator to avoid interpretting dates as math equations (#429)

• Allow specifying a font style for a title on the title page (#423)

• Fix Prawn SVG to support arrow heads on lines (#75)

• Upgrade prawn-svg to 0.25.1

• Upgrade prawn-icon to 1.1.0

• Fix rendering of two images in header or footer (#421)

• Allow table grid color and width to be controlled by theme (@ntfc)

• Fix undefined local variable or method `dest_y' when adding auto-generated anchor to section (#419)

• SVG files that include image elements are not rendered correctly improvement (@AlexanderZobkov) (#414)

• Fix Prawn SVG to support currentColor keyword (#407)

• Parser should recognize up to 6 digit character references (#404)

• Properly convert a negative measurement value in theme

• Coerce percentage value to float instead of integer in theme

• Set minimum required Ruby version to 1.9.3 instead of 1.9

• Use title capitalization for section titles in theming guide

• Update and reorganize keys in theming guide; document numerous keys previous missing

• Add hints to theming guide about how to apply styles when using Maven or Gradle (@fwilhe)

• Fix gemspec to collect files when project is not a git repository or git is not available

1.5.0.alpha.11 (2016-01-05) - @mojavelinux

• Allow font style for first line of abstract to be controlled by theme (@nawroth) (#378)

• Add option to make builds reproducible (@bk2204) (#338)

• Set default page size to A4 (@stephenhay) (#319)

• Preprocess all hex color values (#381)

• Add note about preprocessing hex color values to theming guide (#381)

• Honor base font style (#373)

• Don’t fail to delete tmp file (#369)

• Lazy load icon fonts if detected (#364)

• Reduce heading line height in default theme (#351)

• Set default (fallback) SVG font from theme (#210)

• Expand last column to fit width of table (#372)

• Don’t cache resolved imagesdir attribute value

• Use fallback when merging icon data

• Defer to built-in caching in prawn-icon

• Document replacements and numeric character refs in header/footer content

• Document base_font_size_min setting in theming guide

• Document that page background colors & images do not currently work in AsciidoctorJ PDF

• Use failproof relative require logic in bin script

issues resolved | git tag

1.5.0.alpha.10 (2015-11-01) - @mojavelinux

• Allow admonition icon to be customized by theme (#121) (@jessedoyle)

• Update to prawn-icon 1.0.0 (#335) (@jessedoyle)

• Only generate the pdfmarks file if the pdfmarks attribute is set

• Honor table alignment (via align attribute or role) (#299)

• Use Hash for ViewerPreferences; set initial magnification (#303)

• Handle case when colpcwidth is unspecified (#314)

• Show title for lists (olist, ulist, dlist) (#316)

• Don’t attempt to add running content if document has no content pages

• Correctly calculate toc page range (#322)

• Don’t insert blank page after back cover (#328)

• Document theme key that sets sidebar padding (#344)

• Handle case when CodeRay passes nil text to text_token

issues resolved | git tag

1.5.0.alpha.9 (2015-08-02) - @mojavelinux

• Apply point conversion to image widths (#221)

• Restore missing glyphs in Noto Serif font; adds support for Cyrillic languages (#72, #99)

• Add support for the Rouge source highlighter (#247)

• Fix parsing of style attribute in inline markup when it contains spaces; fixes Pygments highlighting

• Expand tabs to spaces in source document (#236)

• Scale down SVG if width is wider than page (#242)

• Load a base theme with defaults for required keys (#132)

• Enable PDF page import using block image macro (#177)

• Restore method in PDF::Core needed to import PDF page (#237)

• Restore text rendering mode after PDF import (#251)

• Support writing to STDOUT and other IO objects (#254)

• Enable pagenums by default; allow noheader & nofooter to control running header/footer (#205)

• Implement explicit table width, including autowidth (#258)

• Handle conversion to windows-1252 more gracefully when using built-in (AFM) fonts (#290)

• Disable warning if using a built-in (AFM) font

• Remove use of rhythm theme keys from converter (#289)

• Allow font_style to be set on literal text (#291)

• Parse inline image macro value of page_background_image (#222)

• Allow theme to control header cells in table body (#272)

• Make line height in running header/footer configurable (#274)

• Normalize text content in running header/footer (#266)

• Modify vertical alignment setting for running header/footer (#264)

• Use table background color, even if white; upgrade to Prawn Table 0.2.2 (#214)

• Delete trailing content page if empty (#147)

• Fix dry run calculation of block height…​again (#215)

• Move footnotes to inline in a lighter shade

• Fix for JRuby 1.7 running in 2.0 mode

• Upgrade Prawn SVG to 0.21.0; fixes most badge SVGs

• Upgrade thread_safe gem

• Prevent crash if doc has no sections (@abatalev)

issues resolved | git tag

1.5.0.alpha.8 (2015-06-23) - @mojavelinux

• Support inline images (#9)

• Support link attribute on inline images (#209)

• Support inline icon macro (#97)

• Allow fine-grained control over image width (#76)

• Size conversion not yet applied to images on title page or in running header/footer

• Enable checklists (#181)

• Fix block height calculation when content is indented by propagating bounds to scratch document (#215)

• Don’t insert page break before content whose height exceeds a single page (#183)

• Dash border of literal/listing block at page boundary when broken across pages (#190)

• Don’t crash if toc entry is too long (#200)

• Add missing methods on OpenStruct to fix Rubinius compatibility (#81)

• Autofit font size in listing & literal blocks if autofit option is specified (#185)

• Support border style (e.g., double, dashed, dotted) (#196)

• Allow font color of outline list marker to be set by theme (#170)

• Allow use of hyphen in property names in the theme (#193)

• Only include table of contents if toc attribute is defined in header (#187)

• Improve parsing of pdf-page-size attribute

• Handle case in colist converter when previous block isn’t found (#173)

• Print Asciidoctor PDF version in CLI output

• Upgrade Prawn (< 3.0.0, >= 1.3.0) (#68)

• Upgrade Prawn SVG to 0.20.0

• Document gem installation in README (#112)

• Perform code cleanups (#195)

• Silence warning about toc block macro

• Add -example suffix to example file names

• Use CodeRay as syntax highlighter in examples (#207)

• Use proper font names in default them to support custom fonts in SVGs

• Rework parser to parse void elements

• Apply first line formatting correctly (no dropped words)

• Add support for text-center role on paragraphs

• Update theming guide

• Fix cross references in README

issues resolved | git tag

1.5.0.alpha.7 (2015-05-31) - @mojavelinux

• Add support for font-based icons (Jesse Doyle) (#15)

• Enable font fallback support (Rei)

• Support single value for font_fallbacks key in theme

• Reenable M+ 1p as the fallback font

• Add option to specify the background color for even table rows (Tord Heimdal) (#104)

• Add block title for paragraphs (David Gamba) (#67)

• Allow custom page size setting (Otavio Salvador) (#84)

• Fix xref to sections (#56)

• Fix xrefs to non-section content (#110)

• Allow theme to control layout of title page (#135)

• Allow theme to control style of table of contents (#167)

• Allow running header & footer content to be customized (#89)

• Tighten spacing between list items, make value configurable (#92)

• Support CMYK color values (#155)

• Add support for measurement values in theme (#156)

• Name per-level heading theme keys consistently (e.g., heading_h<n>_font_size) (#157)

• Preprocess theme data to allow # in front of hex colors (#158)

• Support linkable images (#51)

• Render table footer row (#123)

• Don’t crash if sectids attribute is disabled (#70)

• Support text transform in theme (uppercase / lowercase) (#138)

• Keep together shouldn’t create blank pages (#150)

• Properly resolve image target as system path (#87)

• Show warning when image cannot be read (#148)

• Allow page background image to be specified (#134)

• Support PDF format as cover page (#113)

• Accomodate numbered list with large numbers (#91)

• Position list marker correctly (#140)

• Allow theme to set font size & family of table cells (#139)

• Unencode character entities in document title (#136)

• Process callouts in listing & literal blocks (#31)

• Use :center to vertically align table cell (#118)

• Normalize endlines in table cell text (#116)

• Support setting page size via attribute (#65)

• Remove unused fonts; update version of NotoSerif font license file

• Remove Asciidoctor theme until we’re ready to fully implement

• Restore source highlighting when nested inside block

• Allow keys in theme to be nested to an arbitrary depth

• Assign width to border for blockquote if not specified in theme

• Add support for font family and style per heading level

• Implement basic converter for inline_indexterm

• Coerce negative values in theme if they slip through

• Use preserve_indentation in layout_prose

• Support remote images

• Add warning about unsupported gif format

• Abort cli if option parsing returns exit code

• Use SafeYAML to load theme files

• Handle transparent value for table background colors

issues resolved | git tag

1.5.0.alpha.6 (2014-11-28) - @mojavelinux

• Add pdf-fontsdir attributes to redefine fonts directory (andrey)

• Use require_relative to load Asciidoctor PDF in asciidoctor-pdf script (Ryan Bigg)

• Add example for specifying theme file (Leif Gruenwoldt) (#61)

• Add thread_safe gem to remove warning when registering converter

issues resolved | git tag

1.5.0.alpha.5 (2014-09-15) - @mojavelinux

• Allow chapter label to be controlled using the chapter-label attribute (#47)

• Prevent toc from overflowing content (#35)

• Fix page numbering for various permutations of front matter

• Don’t activate implicit header include processor by default (#48, #25)

• Draw box around listings and literal blocks than span more than one page (#11)

issues resolved | git tag

1.5.0.alpha.4 (2014-09-09) - @mojavelinux

• Fix yield statement so Asciidoctor PDF can be used with JRuby

• Document that the coderay gem must be installed to run the examples (#42)

issues resolved | git tag

1.5.0.alpha.3 (2014-09-08) - @mojavelinux

• Remove unnecessary dependencies (tilt, slim, thread_safe)

issues resolved | git tag

1.5.0.alpha.2 (2014-09-05) - @mojavelinux

• Add magic encoding header to source file so Asciidoctor PDF can be used with Ruby 1.9.3 (#33, #36)

issues resolved | git tag

1.5.0.alpha.1 (2014-09-04) - @mojavelinux

• Rewrite as proper Asciidoctor converter (#29)

• Initial pre-release

issues resolved | git tag