About
is a widget that contains configuration for an automatic table of contents for posts.
This automatic table of contents is only available on Post and Blog Page - (View).
Specification
Configuration
Description
enable
Activates the table of contents.
auto_scan
When the auto_scan configuration is set to yes and there is no manual table of contents element,
the system will take all elements created using
tags specified in the scan_tags configuration as table of contents items.
The auto scan feature will only run when there is no manual table of contents element. When a manual table of contents is present, the table of contents will take elements from the manual table of contents. You can read more about manual table of contents on: Formatting: Manual ToC.
The auto scan feature will only run when there is no manual table of contents element. When a manual table of contents is present, the table of contents will take elements from the manual table of contents. You can read more about manual table of contents on: Formatting: Manual ToC.
scan_tags
List of heading tags taken during the auto scan process. Separate each tag with a comma.
The default value is h2, h3, h4, which means all elements created
using heading tags h2, h3, and h4 will be included in the table of contents.
nested
min_items
For certain reasons, you might not want to display the table of contents on the overlay ToC if the number of items is too small.
This configuration allows you to set the minimum number of items that will be placed on the overlay ToC.
This applies whether the table of contents content comes from a manual table of contents or from the auto scan process.
When this minimum number of items is not met, the table of contents will not be displayed on overlay ToC.