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

We need to generate a plain/static version of the documentation #326

Closed
martindholmes opened this issue Jan 3, 2025 · 5 comments
Closed
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request release-blocker The dev branch must not be merged into master while a release-blocker bug is open.
Milestone

Comments

@martindholmes
Copy link
Collaborator

We currently generate two versions of the documentation: the staticSearch.html file, which is basically created using the TEI stylesheets, and has external links to a TEI CSS file and some embedded JS, and the fragmented site version which is indexed for its own search, and of course is dependent on JS. But for the release distribution, what we really need is a truly static version with only local CSS, and no JS, which can be used directly in a browser without needing a server. This should be fairly simple to achieve. We need to work on the CSS anyway, so adopting the best bits of the TEI CSS directly into our local documentation.css file, and removing the external dependency, will be the first step; the JS is probably not really doing anything useful anyway, so just removing it might be enough.

@martindholmes martindholmes added documentation Improvements or additions to documentation enhancement New feature or request release-blocker The dev branch must not be merged into master while a release-blocker bug is open. labels Jan 3, 2025
@martindholmes martindholmes added this to the Release 2.0 milestone Jan 3, 2025
@martindholmes martindholmes self-assigned this Jan 3, 2025
@martindholmes
Copy link
Collaborator Author

I've been doing a little work on this in branch issue-326-documentation. The CSS pulled from the TEI site is the print css; it's not clear to me that this is worth having, so I would suggest we simply drop it.

@martindholmes
Copy link
Collaborator Author

I think I have most of it working now, with the exception of the tables in the prose body; I'll look at those today, and use the regular approach of switching to display: list for small-format devices.

@martindholmes
Copy link
Collaborator Author

I have everything displaying without horizontal scrolling in the small-form-factor view of the single-page rendering now. Next is to move on to the split-page view.

@martindholmes
Copy link
Collaborator Author

Making progress on the split-page view. I think there are a number of things to think about for the small-form-factor:

  1. The index page should show the search first, then the TOC.
  2. The TOC should be suppressed, or moved to the end, for other individual pages. If it appears at the beginning, and the main content wraps below it, you don't appear to go anywhere when you click on a TOC link.

I think I prefer the TOC to still be there, but at the end, so that if you finish reading a section, there's a navigation option. But we should also provide a link to the index page right at the top of every page, hidden in the wide view but showing up in the narrow view, so that it's easy to get back to the TOC.

@martindholmes
Copy link
Collaborator Author

I believe this is done now the PR is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request release-blocker The dev branch must not be merged into master while a release-blocker bug is open.
Projects
None yet
Development

No branches or pull requests

1 participant