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

1377 help manual fix #1381

Merged
merged 2 commits into from
Nov 23, 2024
Merged

1377 help manual fix #1381

merged 2 commits into from
Nov 23, 2024

Conversation

synthfi
Copy link
Collaborator

@synthfi synthfi commented Nov 20, 2024

Changes

  • Adds javafx.web as a dependency
  • Adds a new form, ScrWebView, that opens a dialog with a WebView instance
    • 1 constructor for generic string url, 1 constructor for file
    • has a back button and a forward button
  • Added second help option titled Help (Local), that unzips the help and opens it in a ScrWebView dialog
  • minor cleanup, updates

Notes

  • Unfortunately, it's not as easy as I thought it would be to get the ScrWebView to look good on all platforms. Some annoyances I have with it:
    • slower than traditional browsers
    • Offers only the basics out of the box. I implemented a back and forward button myself. UI scaling currently is not tied to the scaling of the rest of the app, which will take more work
    • Breaks the feature of clicking on CONTACT AUTHOR opening a draft email for the user. It looks like another thing I would have to implement
  • As the issue this feature solves only affects a portion of users on linux, I figured that it would make sense to leave this as a fallback for those users. Unfortunately there is no way for me to programmatically tell if this is the case for any user

Draft:

  • UI/UX testing on MacOS

Closes #1377

- adds javafx-web dependency
- Adds ScrWebView to open web pages, both remote and local
- Adds a second help option to open the help in a ScrWebView
   - this is a fallback option for when the user's browser is unable to open the file (targeting linux - snap application users)
   - currently, the scrwebview is not good enough to completely replace opening the help menu in an external browser
@synthfi synthfi force-pushed the 1377-help-manual-fix branch from 09678ff to 7e7c505 Compare November 23, 2024 02:57
@synthfi synthfi marked this pull request as ready for review November 23, 2024 03:19
@synthfi
Copy link
Collaborator Author

synthfi commented Nov 23, 2024

view on linux:
image

this largely looks the same on windows & macos, albeit with the fonts on macos missing the characters for the back and forward buttons

@synthfi
Copy link
Collaborator Author

synthfi commented Nov 23, 2024

zoom isn't controllable, side scrolling apparently isn't implemented. At the very least it opens though.

With this I can at least give people who have issues with opening the help on snap-packaged browsers from being out of luck. (also in the extremely weird case of not having an installed browser lol)

I don't plan on keeping this weird setup around forever for sure. Just have it here for the 3.6 release

@synthfi synthfi merged commit 9a236d7 into master Nov 23, 2024
@synthfi synthfi deleted the 1377-help-manual-fix branch November 23, 2024 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to open readme.html in snap-based applications
1 participant