Built-in content.toc plugin

[traut]

Design

data.toc plugin renders a Table Of Contents for the document

Specification

• the plugin has no configuration options
• API interface (inspired by Hugo TOC config):
  • start_level -- (optional) a positive int attribute. Default value: 1
  • end_level -- (optional) a positive int attribute. Default value: 3
  • ordered -- (optional) a boolean attribute. Default value: false
  • scope -- (optional) a string attribute. Accepted values are: document and section. Default value: document.

Behavior

The plugin accepts a local content with the parsed document tree inside (#17), walks the tree (depending on the scope -- section or document -- the walk is constrained or not) and assembles a table of contents from content.text block with format_as set to title (#15)

This plugin might reuse relative-title-size calculation that the content.text plugin performs if absolute_title_size is not set.

Deliverables

• new built-in content.toc plugin
• the unit tests for the plugin

[traut]

keeping open and moving to v0.4 milestone, since it depends on #98, as agreed in a conversation on slack