Dactyl

This release fixes a couple bugs in the built-in templates when using virtual pages with a `prefix` value. It also changes to use the `prefix` value inherited at the page level so that individual pages can overwrite the value if necessary. (A 404 page, for example, might want to use a separate prefix since it may be used at different paths.)

This release removes a couple of debug statements that broke compatibility with Python 3.5. (Python 3.5 has reached end of life, but Dactyl still works with it for now if you use the right versions of its dependencies.)

This release improves the built-in templates, improves the documentation in the examples, and introduces the concept of "Virtual Pages". Virtual pages are placeholders for links to external sites, which you can insert into the automatically-generated navigation with a stanza similar to a page built by Dactyl.

To add a Virtual Page, add a page to your config with an `html` value containing `//`. For example,

yaml
- name: Dactyl Homepage
blurb: Go to the online home of Dactyl.
html: https://dactyl.link/
parent: virtual-pages.html
targets:
- everything


Dactyl's built-in templates automatically add the page to generated navigation. Use the `parent` field to specify where in the hierarchy the virtual page should appear. The page also shows up as an item in the page lists for the preprocessor and templates so custom templates and pages can list it also.

Breaking Changes

Most projects using Dactyl won't experience breaking changes from this release, but the following changes may potentially require action in certain circumstances:

- The `buttonize` filter now uses Bootstrap's `btn btn-primary` classes instead of adding a `button` class.
- The built-in `tree-nav.html` template and its associated CSS have been significantly updated to fix bugs with deeper levels of navigation and to simplify the generated HTML.
- The `children.html` template no longer omits blurbs beyond the top level by default.

Other Changes

- The default PDF templates (`simple.html` and `pdf-cover.html`) better handle frontmatter and hierarchy fields.
- The SCSS for the tree nav has been split into a separate file to make it easier to include in external projects.
- Updated many of the examples including their URLs.
- Fixed integration test for the style checker.

This release restores compatibility with Python 3.5. There are no other changes.

This release adds "hover anchors" and fixes two bugs with filters and frontmatter.

Bug Fixes

- Fixed a problem with the `export` values of filters not being loaded when those filters were enabled via frontmatter on some pages.
- Fixed a problem where filters would not get imported if they were only listed in frontmatter sections and not in the main config file somewhere.

Hover Anchors

Added the option to enable "hover anchors" for linking directly to headers. These are little links that appear next to a header so that you can right-click and copy the link to get a URL directly to that header. To enable hover anchors, you need to make two changes:

1. In your Dactyl config file, add a `hover_anchors` field to the definition of the target(s) or page(s) you want to enable them on. Set the value to whatever text or HTML you want to represent the anchor. Some examples:

Plain text octothorpe:

- name: some_target
hover_anchors: ""

FontAwesome 4 link icon:

- name: some_target
hover_anchors: <i class="fa fa-link"></i>

2. In your stylesheet, add styles to show `.hover_anchor` elements only when headers are hovered. For example:

CSS:

.hover_anchor {
visibility: hidden;
padding-left: 1rem;
font-size: 60%;
text-decoration: none;
}

h1:hover .hover_anchor, h2:hover .hover_anchor,
h3:hover .hover_anchor, h4:hover .hover_anchor,
h5:hover .hover_anchor, h6:hover .hover_anchor {
visibility: visible;
}

Or, SCSS, if you prefer:

.dactyl_content {
// Hover anchors ---------------
.hover_anchor {
visibility: hidden;
padding-left: 1rem;
font-size: 60%;
}

h1,h2,h3,h4,h5,h6 {
&:hover .hover_anchor {
visibility: visible;
text-decoration: none;
}
}
}

This release fixes the link checker's handling of some less common hyperlink types. It also adds the `--legacy_prince` option to allow you to build PDFs with Prince version 10 and earlier.