Improved reading <xref> elements in DocBook files #8065
Merged
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.
<xref>
elements can also be used to link to<figure>
elements. Alas, the DocBook reader was not aware of this and thus generated a link text which just said 'figure_title'.https://tdg.docbook.org/tdg/4.5/figure.html explains that
<figure>
elements can contain<title>
elements, so let's try to use that if it is available.Technically, this logic could be a lot more sophisticated. The docbook-xsl project's XSLT stylesheet for handling
<xref>
elements is a whopping 1300+ lines of code, and a lot of that is dedicated to a comprehensive heuristic which tries to come up with a sensible link text depending on the target element being referenced. However, it took seven years for someone to point out that Pandoc's handling of<xref>
elements is incomplete, so maybe we don't need to go all the way just yet.Closes #8064 .