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

Add Offline User Manual. #3853

Merged
merged 4 commits into from
Aug 20, 2021
Merged

Add Offline User Manual. #3853

merged 4 commits into from
Aug 20, 2021

Conversation

abshk-jr
Copy link
Member

@abshk-jr abshk-jr commented Aug 11, 2021

This Pull Request add the functionality to download the OpenSCAD User Manual from OpenSCAD Documentation.

A new CMakeLists.txt has been created inside the resources folder which checks for an active internet connection, and runs the python script to download the documentation.

The downloaded documentation can be accessed from the help menu, which opens the Manual in the default browser present on the system.

offline documentation

By default, the option for downloading the User Manual has been turned to OFF in CMakeLists.txt.
If the user doesn't download the documentation, the option in the help menu is hidden away.

offline docs off

949c456 adds the functionality to access an Offline version of the Cheat Sheet.

offline cs

Copy link
Member

@t-paul t-paul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I'll give it a go on my notebook. Just one small suggestion as there's the possibility to centralize the generation of the path to the documentation.

src/MainWindow.cc Outdated Show resolved Hide resolved
@abshk-jr
Copy link
Member Author

I have changed the function openOfflineUserManualURL() and replaced it with hasOfflineUserManual().
The new function now returns a boolean for if the User Manual exists or not, and also accepts a boolean argument openManual which opens the User Manual if set to true.

@abshk-jr abshk-jr requested a review from t-paul August 12, 2021 21:49
Copy link
Member

@rcolyer rcolyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Solid work, and looks good. Just the one in-line comment to address or fix.

src/UIUtils.cc Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants