[DOXIA-662] Non unique IDs generated by IndexingSink

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.0.0-M3
• Fix Version/s: 1.12.0, 2.0.0-M4, 2.0.0
• Component/s: Core
• Assignee: Michael Osipov
• Reporter: Konrad Windszus
• Created: 06/Jul/22 08:09
• Updated: 14/Dec/23 16:47
• Resolved: 07/Jul/22 17:03

Description

If a HTML source contains non-unique headlines (i.e. two or more headlines with the same text) in a single HTML page the IDs being generated out of those are not unique.
That leads to issues with e.g. the TOC macro (https://github.com/apache/maven-doxia/blob/2aea4500ba6559b91fe3a4b83a5d3aafc10116b4/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java#L155) which writes an anchor link leveraging that id.

The problematic line is https://github.com/apache/maven-doxia/blob/2aea4500ba6559b91fe3a4b83a5d3aafc10116b4/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java#L314 which just uses the (sanitized) title as id. In case of conflicts the title needs to be suffixed with an index to be unique.

Issue Links

• is related to: DOXIA-599 Replace <a /> element's name attribute with id attribute
• is related to: MSHARED-390 Add startSection method AbstractMavenReportRenderer where anchor != name
• links to: GitHub Pull Request #106