Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Don't show heading ancestors in the document outline #15034

Closed
afercia opened this issue Apr 18, 2019 · 2 comments · Fixed by #25599
Closed

Don't show heading ancestors in the document outline #15034

afercia opened this issue Apr 18, 2019 · 2 comments · Fixed by #25599
Assignees
Labels
[Feature] Document Outline An option that outlines content based on a title and headings used in the post/page [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Package] Editor /packages/editor [Status] In Progress Tracking issues with work in progress

Comments

@afercia
Copy link
Contributor

afercia commented Apr 18, 2019

See #5314 (comment) and #14889 (comment)

When headings are nested within other blocks, the document outline displays the headings ancestors. Example screenshots:

Screenshot 2019-04-18 at 10 28 29

screen shot 2018-04-06 at 18 49 11

To some extent, I understand the argumentation behind #14889, quoting:

We are just showing the nesting path in the outline as a way to make the structure more intuitive to the user, and make it easier to navigate in the document.

However, I'm not sure displaying the ancestors adds a real value for users. Instead, it makes the UI pretty confusing. Also, the more nested blocks, the more the document outline UI will be confusing.

One more concern is the way the document outline is announced by screen readers: hearing, for example, "Section Column Column H2 My Heading" doesn't help so much.

As a user, I'd expect a tool called "Document Outline" would display just the... outline: headings. Worth also noting there are no known implementations of the HTML5 outline algorithm: as mentioned in #5314 (comment) the current W3C recommendation is: "use heading rank (h1-h6) to convey document structure."

@afercia afercia added [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Feature] Document Outline An option that outlines content based on a title and headings used in the post/page labels Apr 18, 2019
@draganescu
Copy link
Contributor

This is still an issue in Gutenberg 7.9.1 and I agree with @afercia especially since we have the block navigation for "just showing the nesting path in the outline as a way to make the structure more intuitive to the user, and make it easier to navigate in the document."

@afercia
Copy link
Contributor Author

afercia commented Apr 22, 2020

Yup and worth also reminding there's now the "breadcrumbs path" below the content area that shows the nesting path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Document Outline An option that outlines content based on a title and headings used in the post/page [Focus] Accessibility (a11y) Changes that impact accessibility and need corresponding review (e.g. markup changes). [Package] Editor /packages/editor [Status] In Progress Tracking issues with work in progress
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants