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

[Docs update] Fix codelists horizontal & vertical scroll, check hyperlinks #161

Closed
odscjen opened this issue Jul 27, 2023 · 4 comments
Closed
Assignees
Labels
Docs This issue relates to documentation

Comments

@odscjen
Copy link
Contributor

odscjen commented Jul 27, 2023

Check if there is a way to present the open codelists without having to horizontally scroll

@odscjen odscjen added the Docs This issue relates to documentation label Jul 27, 2023
@duncandewhurst duncandewhurst self-assigned this Aug 15, 2023
@matamadio
Copy link
Contributor

matamadio commented Aug 30, 2023

Please also consider introducing height limitation for huge tables such as media formats - with an internal scroll, or collapsible.
Also note in the schema reference (and possibly elsewhere) that the links to codelists #anchors with underscore should replace with dash:

E.g. https://rdl-standard.readthedocs.io/en/178-diagrams/reference/codelists/#function_approach does not work;
it is https://rdl-standard.readthedocs.io/en/178-diagrams/reference/codelists/#function-approach

Best thing would be to have the hyperlink target to use underscore, to avoid confusion (since the schema codelists adopt underscore).

@matamadio matamadio changed the title [Docs update] Present open codelists without horizontal scroll? [Docs update] Fix codelists horizontal scroll and hyperlinks Aug 30, 2023
@matamadio matamadio changed the title [Docs update] Fix codelists horizontal scroll and hyperlinks [Docs update] Fix codelists horizontal & vertical scroll, check hyperlinks Aug 30, 2023
@duncandewhurst
Copy link
Contributor

All sounds good. I'll make those updates as part of #214

@duncandewhurst
Copy link
Contributor

Best thing would be to have the hyperlink target to use underscore, to avoid confusion (since the schema codelists adopt underscore).

That isn't possible because Sphinx replaces the _ character in hyperlink targets with - for compatibility with CSS. As such, I've updated the codelist URLs in the schema to use - in #236.

There shouldn't be any other broken links because Sphinx checks for unresolvable references in Markdown content and we've updated the Sphinx directive that generates the schema tables to do the same replacements as Sphinx in OpenDataServices/sphinxcontrib-opendataservices-jsonschema#51, but let me know if you find any.

@odscjen
Copy link
Contributor Author

odscjen commented Sep 1, 2023

closing as incorporated into #236 and #214

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs This issue relates to documentation
Projects
Development

No branches or pull requests

3 participants