Where is the current "Help File"?

Post here for help on using FreeCAD's graphical user interface (GUI).
Forum rules
and Helpful information
IMPORTANT: Please click here and read this first, before asking for help

Also, be nice to others! Read the FreeCAD code of conduct!
RobZ_inT
Posts: 31
Joined: Thu Jul 26, 2018 11:34 pm

Where is the current "Help File"?

Post by RobZ_inT »

I need help finding the Help file. Apparently it's maintained separately, although it seems like it should be included (?) in the install packages for Windows and Linux. You also can't search for Help File on the Wiki, because it's too generic! :lol: After much digging, I found this: https://www.freecadweb.org/wiki/Installing_Helpfile
A working offline documentation consist of at least two files: "freecad.qhc" the Qt-helpfile-configuration and "freecad.qch" the compressed Qt-helpfile.
The help files aren't found on the linked page at https://github.com/FreeCAD/FreeCAD/rele ... g/0.18_pre. If an Admin type person happens to read this, perhaps they can update the referenced Wiki pages? If you know where the Helpfile is, maybe update the installation page to reference it? Speaking of the main Wiki, why doesn't the side link for tutorials take you here? https://www.freecadweb.org/wiki/Category:Tutorials I found this by accident searching the webs outside the Wiki.
User avatar
bejant
Veteran
Posts: 6075
Joined: Thu Jul 11, 2013 3:06 pm

Re: Where is the current "Help File"?

Post by bejant »

It's there; you want the .7z file with "doc" in the name:
https://github.com/FreeCAD/FreeCAD/rele ... g/0.18_pre

specifically this one:
https://github.com/FreeCAD/FreeCAD/rele ... oc_0.18.7z

Other releases, but no help documentation:
https://github.com/FreeCAD/FreeCAD/releases
RobZ_inT
Posts: 31
Joined: Thu Jul 26, 2018 11:34 pm

Re: Where is the current "Help File"?

Post by RobZ_inT »

bejant wrote: Thu Aug 02, 2018 12:30 pm It's there; you want the .7z file with "doc" in the name:
specifically this one: https://github.com/FreeCAD/FreeCAD/rele ... oc_0.18.7z
Thanks! As a lay person, I was looking for freecad.qhc" or "freecad.qch" as referenced in the wiki page...maybe someone can update the instructions?
RobZ_inT
Posts: 31
Joined: Thu Jul 26, 2018 11:34 pm

Re: Where is the current "Help File"?

Post by RobZ_inT »

Does anyone running Linux know the full path for where to put the help files? FreeCad is looking for (/tmp/.mount_FreeCAijx6r1/usr/lib/freecad/././/share/doc/freecad-doc/freecad.qhc). I can't seem to figure out what the "./." should be for the file path in order to drop them in.

Apparently this has been a past issue:
Manual Where?
https://forum.freecadweb.org/viewtopic. ... 6&start=10
User avatar
NormandC
Veteran
Posts: 18587
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: Where is the current "Help File"?

Post by NormandC »

Please remember to provide your FreeCAD info as explained in the "IMPORTANT: Please click here..." link located in the red banner above.

I had to go back to your post history to find out you're using the AppImage on Linux Mint. Is there a reason not to use the freecad package available through our Stable PPA repository? Then it is just a matter of installing the freecad-doc package. The AppImage is really for other distros than Ubuntu and derivatives.

Install on Unix

RobZ_inT wrote: Thu Aug 02, 2018 1:02 pm Apparently this has been a past issue:
I believe that was fixed a long time ago on the Daily PPA. Yours is a different issue pertaining to the AppImage. It has issues because it is not system-installed and looks for /tmp directories. I'm not associated with the AppImage packaging and I don't know what would be the fix. I do know that the PPA-installed freecad-doc package works with the PPA-installed FreeCAD, that's what I use.
ulrich1a
Veteran
Posts: 1957
Joined: Sun Jul 07, 2013 12:08 pm

Re: Where is the current "Help File"?

Post by ulrich1a »

RobZ_inT wrote: Thu Aug 02, 2018 1:02 pm Does anyone running Linux know the full path for where to put the help files?
In theory it should work with every path, where you are allowed to put files in. The help page gives Information how to activate your local copy. Allthough I have not tested it with an Appimage.

Ulrich
User avatar
NormandC
Veteran
Posts: 18587
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: Where is the current "Help File"?

Post by NormandC »

RobZ_inT wrote: Thu Aug 02, 2018 12:11 pm Speaking of the main Wiki, why doesn't the side link for tutorials take you here? https://www.freecadweb.org/wiki/Category:Tutorials I found this by accident searching the webs outside the Wiki.
Well, there were many reasons:
  • Because it is a confusing page that lists tutorials alphabetically. It cannot be sorted any other way.
  • Because it's an automatically generated page, it's bland and we can't format its content and add descriptions and images.
  • Because the list cannot be translated into other languages, as the page names must rename in English with the language suffix appended (/de, /fr, etc.) - this is a big usability issue for non-English speakers.
  • Because it lists Sandbox (draft) pages that are not complete or may be obsolete, confusing users.
  • Because the recent Tutorials rework I did a few months ago aimed to address these issues. The few who commented on it (there are always very few people who contribute and give feedback) agreed it was an improvement. Two topics where this was discussed (there are other topics but I didn't find them, we're not always disciplined regarding discussions...)
    https://forum.freecadweb.org/viewtopic.php?t=27592
    https://forum.freecadweb.org/viewtopic.php?t=27674
And finally, if you actually read the description at the top of Tutorials, you'll see that it already provides the link to Category:Tutorials in the very first sentence.
RobZ_inT
Posts: 31
Joined: Thu Jul 26, 2018 11:34 pm

Re: Where is the current "Help File"?

Post by RobZ_inT »

NormandC wrote: Thu Aug 02, 2018 3:25 pm Is there a reason not to use the freecad package available through our Stable PPA repository? [...] The AppImage is really for other distros than Ubuntu and derivatives.
Install on Unix
To be honest- I don't recall from exactly which page I downloaded that. I had previously installed using PPAs, but then had to reload Mint and when I got back to reinstalling FreeCAD- that was how it went. It's not the first time I've had quirky navigation and trouble viewing/finding the same pages. I looked for that same Linux page you linked too, but didn't find it. (might be the residual brain damage?) It sometimes seems like there are other versions/pages with similar info.. (?)
I seriously appreciate all the help I'm getting from you and others. I'm going to reinstall and see how it goes.
User avatar
NormandC
Veteran
Posts: 18587
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: Where is the current "Help File"?

Post by NormandC »

RobZ_inT wrote: Thu Aug 02, 2018 4:21 pm It sometimes seems like there are other versions/pages with similar info.. (?)
That can certainly happen. The wiki is huge with thousands of pages, and duplication is bound to happen. We do try to improve it, but none of us are professional technical writers... :D

In prior versions of the wiki, there was some duplication between Download and Install on Unix.
User avatar
sgrogan
Veteran
Posts: 6499
Joined: Wed Oct 22, 2014 5:02 pm

Re: Where is the current "Help File"?

Post by sgrogan »

NormandC wrote: Thu Aug 02, 2018 3:25 pm I'm not associated with the AppImage packaging and I don't know what would be the fix.
We don't include the docs in the AppImage because they are huge 140+ MB in binary format so compression doesn't help reduce this. The offline docs aren't updated regularly, usually only just prior to a stable release. We should include them in the stable release AppImage, I will add this to my list.

As NormandC has said on the PPA it is a separate package.

On Windows, we do provide the docs in the stable releases packages, but not in the developer builds, because of the size and the fact that users would just be downloading the same 140 MB every time they update.

The help files are OS/Distro agnostic so you can download and extract them anywhere you want. Then start FreeCAD, go to help, and in the QT-assistant pup-up go to Edit > Preferences, Documents tab > Add, then navigate to where you put the .qhc file and you should be good to go.
"fight the good fight"
Post Reply