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

Crosslinks should not include .html #33206

Closed
philwebb opened this issue Nov 15, 2022 · 7 comments
Closed

Crosslinks should not include .html #33206

philwebb opened this issue Nov 15, 2022 · 7 comments
Labels
status: declined A suggestion or change that we don't feel we should currently apply type: documentation A documentation update

Comments

@philwebb
Copy link
Member

Eg:

read the "getting-started.html" and "using.html" sections

in https://docs.spring.io/spring-boot/docs/2.6.x/reference/html/features.html#features

@philwebb philwebb added the type: documentation A documentation update label Nov 15, 2022
@philwebb philwebb added this to the 2.6.x milestone Nov 15, 2022
@mhalbritter mhalbritter self-assigned this Nov 18, 2022
@mhalbritter mhalbritter modified the milestones: 2.6.x, 2.6.14 Nov 18, 2022
@wilkinsona
Copy link
Member

Unfortunately, there are still quite a few other .html links in the multi-page docs. Asciidoctor manages to use the title of the section to which we're linking in the single-page docs. It would be good to find a way to get that to work in the multi-page docs as well without having to provide the link text manually.

@wilkinsona wilkinsona reopened this Nov 18, 2022
@wilkinsona wilkinsona modified the milestones: 2.6.14, 2.6.x Nov 18, 2022
@mhalbritter
Copy link
Contributor

This seems to be the problem:

image

https://docs.asciidoctor.org/asciidoc/latest/macros/inter-document-xref/

I'm trying to find a workaround.

@mhalbritter
Copy link
Contributor

mhalbritter commented Nov 24, 2022

I got an answer here: https://asciidoctor.zulipchat.com/#narrow/stream/279644-users.2Fasciidoctorj/topic/.E2.9C.94.20Link.20titles.20in.20multipage.20crossreferences

Looks like the << ... >> syntax is deprecated and even when using xref we have to make sure to satisfies all the rules. Going to take a look if this is feasible for us.

@mhalbritter
Copy link
Contributor

Dan Allen said:

You can't get automatic titles across separate documents (unless you are using AsciiDoc with Antora).

@mhalbritter
Copy link
Contributor

Workaround would be to add the title by hand to all xrefs which have no explicit title. Downside is that then the title in the link can differ from the linked section, if the section is renamed and the link stays at the old title.

@philwebb
Copy link
Member Author

We might be able to hack something on out custom backend in the meantime

@philwebb philwebb removed this from the 2.7.x milestone Nov 8, 2023
@philwebb philwebb added the status: declined A suggestion or change that we don't feel we should currently apply label Nov 8, 2023
@philwebb
Copy link
Member Author

philwebb commented Nov 8, 2023

There's no easy way to do this with the backend so I think we should just live with it until the Antora migration.

@philwebb philwebb closed this as not planned Won't fix, can't repro, duplicate, stale Nov 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: declined A suggestion or change that we don't feel we should currently apply type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

3 participants