Tocbot

The Tocbot module provides a wrapper around the Tocbot library. It creates a block with a table of contents (TOC), generated from HTML headings. The Tocbot block makes navigating through documentation pages or long articles easy.

Installation

Install this module using the official Backdrop CMS instructions.

Configuration

• Visit the configuration page under Administration > Configuration > Content authoring > Tocbot (admin/config/content/tocbot).
• The defaults should be fine to get started but feel free to change the Module settings or the JavaScript settings to suit your needs.
• More information about the JavaScript settings can be found at tscanlin.github.io/tocbot/#api.

Get started

With the default configuration, the module creates a "Tocbot" block that contains a table of contents. When a visitor scrolls down the page, at a certain point the block will be treated as fixed positioned. While the content of the page appears in the viewport, the corresponding TOC items will be highlighted, and nested items will be expanded.

• Create a content page (or a post).
• Put a lot of text in the body, and use HTML headings to divide the content.
• Place the Tocbot block in the sidebar of a corresponding Backdrop Layout.
• Visit the content page, and scroll down to see the block and its behavior.

Screencast / Screenshots

• Video introduction by Tim Erickson
• Screenshots in the Wiki

Coming from Drupal?

In contrast to the Drupal version which by default uses CSS and JavaScript from a CDN, the Backdrop version uses by default local library files bundled with the module (CDN files are only loaded if the local library isn't available). Currently version 4.23.0 of the TocBot library is bundled.

Issues

Bugs and Feature requests should be reported in the Issue Queue.

Current Maintainers

• Olaf Grabienski

Credits

• Ported to Backdrop CMS by Olaf Grabienski.
• Originally written for Drupal by Nicholas Stees.
• Based on the Tocbot library, which is released under the MIT license.

License

This project is GPL v2 software. See the LICENSE.txt file in this directory for complete text.