TOC component and header IDs

[Johani (Joe)]

@guildai

Personally I think Discourse should NOT strip element id attrs

@guildai

Unfortunately, Discourse removes id attrs from post elements before the above code is run so the logic is thwarted.

Here’s a header that uses <h4 id="alt-main-outlet">main outlet</h4> :

If you need to add a heading then it needs to be prefixed with heading-- you can find more information about that here Link to a heading within a post or topic

ids that are not prefixed like that will be stripped, regardless of what the id value is.

@guildai

With TOC, both Examples headers get the same ID

Headings with duplicate text are not currently supported - and have never been - in the TOC component. The component generates the id based on the text of the heading. So, two headings with the same exact text will get the same id.

There are no plans to patch this up in the component right now since automatic id generation is on our list of features for the next release of Discourse and we plan to address the issue of duplicate headings by adding the heading’s index to its id.

@guildai

If the Discourse team is that concerned about ID hijacking, all Discourse IDs should be prefixed e.g. discourse-main-outlet and ID stripping should apply only to those prefixed IDs.

When we implement this in core, I think adding a prefix to the generated headings should be enough.