Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

do not use <link> element for example links #306

Open
dariavladykina opened this issue Nov 28, 2024 · 2 comments
Open

do not use <link> element for example links #306

dariavladykina opened this issue Nov 28, 2024 · 2 comments

Comments

@dariavladykina
Copy link
Contributor

dariavladykina commented Nov 28, 2024

Suggestion from Jana:
I found roughly 150 links reported as broken that are example URLs that cannot ever work and even aren't meant to. Can we suggest that authors do not use <link> or similar adoc equivalents, but rather use some other markup that changes the font to monospace, but doesn't create a (broken) link?

@dariavladykina
Copy link
Contributor Author

These are links that illustrate some example and get formatted like a real URL. SI recognizes them as a real, broken link. We should educate our writers and make sure we find out whether asciidoc has some sort of automatism that turns anything http* into a real URL and whether this can be switched off.
https://ip_address_of_region_server/regionInfo?regionHint=REGION_NAME
For AsciiDoc, https://docs.asciidoctor.org/asciidoc/latest/macros/autolinks/ - here is both the feature and how to turn it off.

@tomschr
Copy link
Contributor

tomschr commented Dec 5, 2024

It's all there.😉 For Docbook, use <uri>. That doesn't create a link, but is still displayed as monospace.

For ADoc you can have different options:

From my view, I think the first option would be the most flexible one. I'd recommend that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants