Fix custom doc link title issue

[Kyle-Ye]

Bug/issue #, if applicable:

Close #271

Summary

## Overview

Hello

Check out [Hi](https://hi.com)

Check out [this great function](doc:Sloth/eat(_:quantity:))

Check out [this great function ![random image](https://picsum.photos/200)](doc:Sloth/eat(_:quantity:))

- <doc:Sloth/eat(_:quantity:)>

Before the PR (current behavior)

After the PR (expected behavior)

Dependencies

swiftlang/swift-markdown#82
swiftlang/swift-markdown#110

Testing

See RenderContentCompilerTests.swift

swiftlang/swift#61506

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

• Added tests
• Ran the ./bin/test script and it succeeded
• Updated documentation if necessary

[Kyle-Ye]

@swift-ci please test

[Kyle-Ye]

Testing passed here with the Markdown change: swiftlang/swift#61506

[franklinsch]

This is looking really great, thank you @Kyle-Ye!

[franklinsch]

@Kyle-Ye is there remaining work for this PR?

[Kyle-Ye]

@Kyle-Ye is there remaining work for this PR?

The implementation is done. But there is some Code Review discussion to be processed.

Could you help give a look at the following thread👇

• Fix custom doc link title issue #376 (comment)
• Fix link missing range issue swift-markdown#82 (comment)

@franklinsch

[Kyle-Ye]

There is still one thing wrong. The _isAutoLink property will get lost after visiting it and visiting back. This issue was identified in the failed test case, IndexingTests.testTutorial().

To address this problem, we can save and restore the original isAutolink status when changing a link's destination during a visit to a tutorial. However, this information will still be lost when revisiting that same tutorial. The reason for this is that the link will be generated from func makeMarkup(_ data: _MarkupData) -> Markup in Markup.child(at:), and it is not possible to retrieve the original isAutolink information at that point.

mutating func visitLink(_ link: Link) -> Markup? {
    ...
    let isAutolink = link.isAutolink // save the original isAutolink status
    var link = link
    link.destination = resolvedURL.absoluteString
    link.isAutolink = isAutolink // restore the original isAutolink status
    return link
}

[Kyle-Ye]

A possible solution to fix the failed test case and remove the need of Swift-Markdown's support for Markdown.Link._isAutolink property / Markdown.Link.isAutolink setter

Suggested change

	return [
	RenderInlineContent.reference(
	identifier: .init(resolved.absoluteString),
	isActive: true,
	overridingTitle: link.isAutolink ? nil : overridingTitle,
	overridingTitleInlineContent: link.isAutolink ? nil : overridingTitleInlineContent
	)
	]
	let useOverriding: Bool
	if link.isAutolink { // If the link is an auto link, we don't use overriding info
	useOverriding = false
	} else if let overridingTitle,
	overridingTitle.hasPrefix(DocumentationSchemeHandler.scheme + ":"),
	destination.hasPrefix(DocumentationSchemeHandler.fullScheme),
	destination.hasSuffix(overridingTitle.dropFirst((DocumentationSchemeHandler.scheme + ":").count)) { // If the link is a transformed doc link, we don't use overriding info
	useOverriding = false
	} else {
	useOverriding = true
	}
	return [
	RenderInlineContent.reference(
	identifier: .init(resolved.absoluteString),
	isActive: true,
	overridingTitle: useOverriding ? overridingTitle : nil,
	overridingTitleInlineContent: useOverriding ? overridingTitleInlineContent : nil
	)
	]

[QuietMisdreavus]

This looks good, thanks!

[QuietMisdreavus]

@swift-ci Please test

[QuietMisdreavus]

Looks like the if let destination in Swift-Markdown caused an issue. I'll see about getting a PR up.

[Kyle-Ye]

@swift-ci please test

[Kyle-Ye]

@swift-ci please test

[Kyle-Ye]

Looks like the if let destination in Swift-Markdown caused an issue. I'll see about getting a PR up.

The Swift-Markdown is fixed and the test passed on Swift-DocC. Are we ready to merge this? @QuietMisdreavus

[Kyle-Ye]

@swift-ci please test