Bookbinder v8.2.0

This release includes a new feature.

Feature

Configurable, persistent local headers
Bookbinder can now create and use a configurable, persistent local header. This header is specified per-product, and includes the following elements:

• Product Title
• Product Logo
• Additional links

Bookbinder v8.1.0

This release includes the following new features:

Features

Bookbinder "Owners"
Bookbinder now allows you to specify one or more "owner" of a topic. Add the owner tag to the frontmatter of a topic, with a value of either a single entry or an array.

New Subnav Generator Features

• Subnav generator now checks for duplicated subnav links
• Subnav generator now checks for broken subnav links
• Subnav generator now handles nested directories: the "deep subnav". You must add class "subnav" to links to use deep subnav.

Other Changes

Rename subnav_topics to subnav_root
Under the products key, subnav_root replaces subnav_topics. No functionality change.

Bookbinder v8.0.0

This release contains a breaking change, other new features, and a bug fix.

Breaking Change

Customizable Push Environment
In previous versions, Bookbinder could only push to one of three defined environments: Staging, Acceptance, and Production. Bookbinder now allows a book administrator to define any number of push environments in the credentials.yml file for a book, and to push to any of these environments with the bookbinder push_local_to command.

Other Features

Subnav generation implementation change
Specifying subnav_topics under the products key and associating this to a section via product_id allows users to generate their own navigation-related json by specifying topics in a config.yml and parsing the topic's specified table of contents page for navigation items, rather than defining as static HTML (as with subnav_template). This json can then be consumed with a javascript library (e.g. React.js) to create your subnav.

Previously, this feature was enabled under the subnavs, topics, and subnav_name keys. We have changed the implementation to reflect the first-order nature of products and their one-to-one relationship with subnavs.

Submodule dependency support
bookbinder bind remote now uses the --recursive flog when git cloning repositories to honor possible submodule dependencies.

Bug Fix

• Index pages in the subnav were not highlighted when browsed to using the directory name file form of the URL. This release resolves this issue.

Bookbinder v7.5.0

This release contains a new feature, a bug fix, and improved testing.

Features

• bookbinder imprint (new command): Generates PDFs from DITA. Requires locally installed DITA-OT.

Bug Fix

• Modified Date now converts UTC of latest commit to local time.

Improved Testing

Validations added for bind, watch, and imprint
Checks added for section presence, and for ditamaps for all DITA section.

Bookbinder v7.4.4

This release contains a bug fix.

Bug Fix

The release adds nokogiri-1.6.7.2 as runtime dependency. The nokogiri-1.6.7.2 release contains a security fix for CVE-2015-7499

Bookbinder v7.4.2

This release contains new features.

Features

Source Repository Link helper has been updated:

• Now fully usable with DITA source documents.
• Can now be restricted to certain publishing environments. This allows documents a book administrator to show the links when published to an internal staging environment, but not when published to a production environment, for example.

Modified Date has been updated:

• Now fully usable with DITA source documents. This links to the parent directory if the standard link on a DITA page has no direct source file.
• A book administrator can override the Modified Date.

Bookbinder v7.4.1

This release contains a bug fix.

Bug Fix

The bug occurred when the Modified Date helper was used with source files that had no non-excluded commits in their history. The helper now returns the current date for these files.

Bookbinder v7.4.0

This release contains new features.

Features

• Source Repository Link helper: Allows you to render links to the GitHub source page for the currently displayed page of a bound book.
• Modified Date helper commit exclusion: the Modified Date helper can exclude the dates of specified commits.
• DITA ERB.

Bookbinder 7.3.0

This release contains new features.

Features

• Repo path specification: Allows you to specify a directory inside a source repository to use as a section.
• Tagging: The punch command adds git tags to the current head of master to all sections specified in config.yml and the layout repo, if provided.
• Layout repository ref: Enables use of an alternate version of a layout repo.

Bookbinder v7.2.0

This release contains a new feature and a deprecation.

Features

• Dependent sections for DITA: DITA sections may optionally provide nested dependent sections for additional content.

Deprecation

• DITA books now prefer a template named subnav_template.erb in order for Bookbinder to generate a subnav, to move the required template in line with generated subnavs for other formats. The previous template file, _dita_subnav_template.erb, is now deprecated and should be renamed to subnav_template.erb.