Table of contents block needs automatic placement or [toc] in the text to show up

Created on 9 September 2024, 9 months ago

Problem/Motivation

This is either a bug or some help text to improve in the UI .
Since having the TOC in a block working is possible, I made this a documentation task.

Steps to reproduce

Add the filter to the text format and configure it to not select anything for automatic placement, but do enable the placing with a block.
Please the Table of contents block. Add a node with some headings. => the TOC block won't show up.
Either edit the node and add "[toc]" in its body, or enable the top or botton Automatic placement in the text format filter settings, and the Table of Contents will appear.

Tested with a fresh Drupal 10.3.3 install.

Proposed resolution

Make it clear that the block option is an override over the previous one. Improve the help text like:

Enabling this option will move the TOC from the body of text to the Table of contents block provided by this module: please make sure to place it on your site.

Remaining tasks

Approve the changes and make them into a MR patch (I still don't have a setup to do this quickly 😇)

User interface changes

Just a clearer help text.

📌 Task

Status

Active

Version

2.0

Component

Documentation

Created by

🇮🇹Italy kopeboy Milan

Live updates comments and jobs are added and updated live.

Merge Requests

!15Table of contents block needs automatic placement or [toc] in the text to show up
Open
🇨🇦Canada Liam Morland
updated 11 days ago

Comments & Activities

Issue created by @kopeboy
Status changed to Needs review 9 months ago9:32am 9 September 2024
Comment 9 months ago →
🇮🇹Italy kopeboy Milan
Comment 4 months ago →
🇺🇦Ukraine proweb.ua
proweb.ua → made their first commit to this issue’s fork.
Comment 18 days ago →
🇨🇦Canada Liam Morland Ontario, CA 🇨🇦
liam morland → made their first commit to this issue’s fork.
Merge request !15Issue #3473002: Table of contents block needs automatic placement or [toc] in the text to show up → (Open) created by Liam Morland
Comment 18 days ago →
🇨🇦Canada Liam Morland Ontario, CA 🇨🇦
The issue may be that it is using the "Automatically include table of contents" setting instead of the "Display table of contents in a block" setting. I have implemented this change in the merge request.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024