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

intra-xrefs converted to plain text reference provide bad UX #381

Open
ghost opened this issue Sep 26, 2018 · 1 comment
Open

intra-xrefs converted to plain text reference provide bad UX #381

ghost opened this issue Sep 26, 2018 · 1 comment
Labels
cat-enhancement Enhancements effort:XL Very large effort, takes long to implement format-html html, xhtml, html5, webhelp, jsp support skill-xslt XSLT knowledge necessary styles-2022 "suse2022-ns" styles topic-smartdocs For SmartDocs

Comments

@ghost
Copy link

ghost commented Sep 26, 2018

Initially reported by @vmoutoussamy on IRC.

When we build individual books from a set, intra-xrefs are converted to plain text.
Having to dig through the web site to find the guide referenced as plain text is not a great experience.

Maybe we could add a build parameter that defines a URL prefix for intra-xrefs? However, the prefix would likely have to be different for different books (book.gnomeuser is likely in a different directory than book.security)/different formats (we should reference PDFs from PDFs, 1-HTML from 1-HTML)...

@vmoutoussamy
Copy link

Just a bit of context about my report. IMHO, our techy users would prefer the single HTML version of our docs over the regular HTML one. But then they could face situation like this: section 2.2 on https://www.suse.com/documentation/sles-15/singlehtml/art_modules/art_modules.html the paragraph doesn't have any interesting content apart from the references to other docs, so the user basically have to find his way to the references by himself.

@ghost ghost changed the title intra-xrefs converted to plain text reference are not great UX intra-xrefs converted to plain text reference provide bad UX Sep 26, 2018
@ghost ghost added cat-enhancement Enhancements skill-xslt XSLT knowledge necessary format-html html, xhtml, html5, webhelp, jsp support styles-2013 "suse2013", "suse2013-ns", "daps2013", "daps2013-ns", "opensuse2013", "opensuse2013-ns" styles labels Jan 21, 2020
@janajaeger janajaeger added styles-2022 "suse2022-ns" styles cat-limbo Issues which should be investigated further labels Jul 20, 2022
@tomschr tomschr added effort:XL Very large effort, takes long to implement topic-smartdocs For SmartDocs and removed styles-2013 "suse2013", "suse2013-ns", "daps2013", "daps2013-ns", "opensuse2013", "opensuse2013-ns" styles cat-limbo Issues which should be investigated further labels Nov 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cat-enhancement Enhancements effort:XL Very large effort, takes long to implement format-html html, xhtml, html5, webhelp, jsp support skill-xslt XSLT knowledge necessary styles-2022 "suse2022-ns" styles topic-smartdocs For SmartDocs
Projects
None yet
Development

No branches or pull requests

3 participants