Fix link handling in conreffed content #3842
Merged
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
Signed-off-by: Jarno Elovirta <jarno@elovirta.com>
jelovirt
added
bug
priority/medium
jelovirt
commented
Dec 28, 2021
| @@ -547,7 +547,7 @@ See the accompanying LICENSE file for applicable license. | |||
| <xsl:variable name="conref-topicid" as="xs:string"> | |||
| <xsl:choose> | |||
| <xsl:when test="empty($topicid)"> | |||
| <xsl:value-of select="//*[contains(@class, ' topic/topic ')][1]/@id"/> | |||
| <xsl:value-of select="/descendant-or-self::*[contains(@class, ' topic/topic ')][1]/@id"/> | |||
There was a problem hiding this comment.
A classic XPath bug where // desugars to /descendant-or-self::node()/ and the [1] predicate no longer selects the first match of //, but rather anything that is the first child of parent node.
jelovirt
commented
Dec 28, 2021
| @@ -559,10 +559,10 @@ See the accompanying LICENSE file for applicable license. | |||
| <xsl:variable name="conref-gen-id" as="xs:string"> | |||
| <xsl:choose> | |||
| <xsl:when test="empty($elemid) or $elemid = $href-elemid"> | |||
| <xsl:value-of select="generate-id(key('id', $conref-topicid)[contains(@class, ' topic/topic ')]//*[@id = $href-elemid])"/> | |||
| <xsl:value-of select="generate-id((key('id', $conref-topicid)[contains(@class, ' topic/topic ')]//*[@id = $href-elemid])[1])"/> | |||
There was a problem hiding this comment.
When $conref-topicid starts to return correct values, id key will also start returning values. XSLT 1.0 will accept multiple argument values for generate-id(), but XSLT 2.0 will not. Thus we have to explicitly use only the first.
robander
approved these changes
Dec 28, 2021
infotexture
added a commit
to dita-ot/docs
that referenced
this pull request
Dec 29, 2021
- dita-ot/dita-ot#3842 Signed-off-by: Roger Sheen <roger@infotexture.net>
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
Link handling in conreffed content has bugs in how target elements are selected. This PR fixes the conref stylesheet query issues.
Motivation and Context
The
conrefImpl.xslwas originally written some 17 years ago with XSLT 1.0. When the conref code was moved to XSLT 2.0, the relavant code was not adjusted for the differences between XSLT 1.0 and 2.0. The code also contains a bug in selection of the first topic in a document.How Has This Been Tested?
Existing tests pass or have been fixed to expect correct output.
Type of Changes
Documentation and Compatibility
Mention in release notes. Fixes a bug that's been in the codebase for 17 year. Seventeen years.