Document Outline: add support for heading elements outside of core Heading blocks #29610
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ZebulanStanphill
added
[Type] Bug
|
Size Change: +128 B (0%) Total Size: 1.05 MB
ℹ️ View Unchanged
|
ZebulanStanphill
force-pushed
the
fix/document-outline-include-all-heading-tags
branch
5 times, most recently
from
b074e90 to
3a523bb
Compare
|
I can't get the last unit test to pass, despite the described behavior working fine in my manual testing. Any ideas? |
ZebulanStanphill
requested review from
jorgefilipecosta,
youknowriad and
epiqueras
6 tasks
ZebulanStanphill
force-pushed
the
fix/document-outline-include-all-heading-tags
branch
from
3a523bb to
106714a
Compare
|
Since we decided in #29560 that the Table of Contents block should only support other blocks when gathering headings, I think it's safe to assume similar reasoning applies here. In other words, it's not worth the added complexity to support headings outside of the Heading block (and perhaps other core blocks). |
|
@ZebulanStanphill is there a hook to override the content being analyzed in the outline structure? As an agency developer making client sites, we severely limit the allowed blocks and use a component-driven workflow where custom blocks all control the specific heading tags. I'm now getting asked by our clients' SEO teams why the "Outline" tab is broken in the List View. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Previously, the Document Outline only accounted for core Heading blocks. This PR adds support for heading elements in any other block, as long as that block includes the heading tags in its save implementation.
How has this been tested?
I tested to make sure that heading elements inside a Custom HTML block were listed in the Document Outline, and I confirmed that all the warnings appeared when appropriate. I also tested to make sure that clicking the entries in the Document Outline would jump to the block containing that heading.
Screenshots
Checklist: