Update web page dependencies #681
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FORD contains icon references to Font Awesome version 4. Without updating many HTML templates in FORD, compatibility mode must be enabled by including two additional stylesheets: * v4-font-face.min.css * v4-shims.min.css
The MathJax javascript does not have to be at the end of pages for them to render faster. Just use the `async` attribute. Also remove duplicated configuration options that are already included in the `TeX-AMS-MML_HTMLorMML` preset.
Bootstrap tooltips are opt-in. They must be initialized manually. In order to do so, the Bootstrap javascript must be loaded before running the initialization function. Also, because jQuery has been removed from FORD, use the standard compliant `document.querySelectorAll` instead.
In the past, `config.json` was used to generate a customized version of Bootstrap for FORD. However, FORD has since switched to use the official version of Bootstrap. Therefore, the old configuration file is no longer needed and should be removed.
FORD used to depend on `MANIFEST.in` to include its data files. However, the same purpose is now served more reliably by `pyproject.toml`.
ZedThree
approved these changes
Jan 6, 2025
Member
ZedThree
left a comment
ZedThree
left a comment
There was a problem hiding this comment.
Amazing, thanks @kuanchihwang!
I also really appreciate the commit messages with the explanations of some of the changes.
Is there a list somewhere of the font-awesome v4 stuff that we'll need to fix?
Contributor
Author
|
There is an upgrade guide in the Font Awesome documentation: https://docs.fontawesome.com/web/setup/upgrade/upgrade-from-v4 It seems that we have to change the prefix of icons, and rename the icons that have gone through name changes between version 4 and 6.
|
Member
|
Lovely, thanks @kuanchihwang! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the web page dependencies (i.e., scripts and stylesheets) of FORD. Specifically:
Note that Font Awesome was updated with its 4-to-6 compatibility mode enabled. As future work, all web pages that contain icon references to Font Awesome version 4 will need to be updated to version 6 before the compatibility mode can be dropped.
Additionally, Bootstrap tooltips are also fixed. It was previously broken in commit 22cb0b5 due to jQuery being removed. Some unused configuration files are removed to reduce clutter.
All 305 unit tests pass, including the ones that are "slow".
Closes #635.