Skip to content

[REQ] Differentiate between headings and sections #36

@mhatzl

Description

@mhatzl

Unimarkup has markup to create headings, and these headings are then considered as document sections.
However, not every heading should be a section (e.g. headings in quotation blocks).

It should be clearly defined when a heading is considered a section.
Besides this differentiation, users should also have the option to exclude sections from the ToC.

Headings in the following contexts should not be considered as sections:

  • Inside any indented block (e.g. quotation blocks and lists)
  • Inside Tables
  • Inside verbatim blocks
  • Inside verbatim block inserts
  • Inside block decorations
  • Inside math blocks

It would probably be useful to have a field block that prevents headings from being considered as sections.
This gives users more freedom if the above restrictions are not enough.
The field block name could be something like no-sections.

Headings in text blocks and columns should be considered as sections, because these block elements are commonly used for document layout.

Examples:

[[[
# This is a section heading

> # This is no section

- Some list

  # Neither is this

```
# Nor this
```
]]]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions