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

Simplify top-level navigation #585

Open
infotexture opened this issue Jan 20, 2025 · 0 comments · Fixed by #586
Open

Simplify top-level navigation #585

infotexture opened this issue Jan 20, 2025 · 0 comments · Fixed by #586
Assignees
Labels
enhancement Changes to an existing topic or feature
Milestone

Comments

@infotexture
Copy link
Member

infotexture commented Jan 20, 2025

The DITA-OT documentation currently uses a common structure for the HTML and PDF output.

The top-level items appear as “parts” in the PDF ToC. The same topics form first level of the navigation sidebar in the HTML output in the distribution package, and on the project website.

Proposal

As discussed at DITA-OT Day 2024 and recent contributor calls, we're considering simplifying this structure to reduce the number of parts and simplify the navigation menu. This would work better with the upcoming bookmap improvements for PDF theme files, and lay the foundation for alternative navigation approaches in HTML.

As a first step, we could merge several of these items, perhaps like this:

---
config:
  sankey:
    showValues: false
---

sankey-beta

%% source, target, value
Landing Page,DITA Open Toolkit 4.2,1
Release Notes,DITA Open Toolkit 4.2,1
Authoring formats,DITA Open Toolkit 4.2,3
Output formats,DITA Open Toolkit 4.2,7
Installing DITA-OT,Installing, 4
Building output,Publishing,5
Parameters,Configuring,3
Customizing HTML,Configuring,2
Customizing PDF,Configuring,3
Adding plug-ins,Extending,4
Creating plug-ins,Extending,9
Error messages and troubleshooting,Troubleshooting,8
Reference topics,Reference,6
Resources,Reference,2
Loading

Caveats

  • This effort would focus primarily on the top level, rather than a complete refactoring of the site IA, which is beyond the scope of what's possible for the next release with the resources we have now.
  • Wherever possible, previously shared paths will be preserved, because we know Cool URIs don't change.
  • Where path changes are necessary, redirects will be implemented on the project website to ensure previously shared links keep working.
@infotexture infotexture added the enhancement Changes to an existing topic or feature label Jan 20, 2025
@infotexture infotexture self-assigned this Jan 20, 2025
@infotexture infotexture added this to 4.3 Jan 20, 2025
@infotexture infotexture moved this to In Progress in 4.3 Jan 25, 2025
@infotexture infotexture added this to the 4.3 milestone Feb 1, 2025
@infotexture infotexture linked a pull request Feb 1, 2025 that will close this issue
infotexture added a commit that referenced this issue Feb 1, 2025
Refactor map hierarchies to simplify top-level navigation for #585.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Changes to an existing topic or feature
Projects
Status: In Progress
Development

Successfully merging a pull request may close this issue.

1 participant