Difference between revisions of "Installing Helpfile"

From FreeCAD Documentation
Jump to navigation Jump to search
(Created page with "==FreeCAD Helpfiles== The FreeCAD offline documentation is created with scripts from the FreeCAD-Wiki. It has actual grown to a file size of more than 100 megabyte. These big...")
 
({{TOCright}})
 
(24 intermediate revisions by 11 users not shown)
Line 1: Line 1:
==FreeCAD Helpfiles==
+
<languages/>
The FreeCAD offline documentation is created with scripts from the FreeCAD-Wiki. It has actual grown to a file size of more than 100 megabyte. These big files are not part of development installers and executables of FreeCAD. But the offline documentation can be installed separately, which is explained here.
+
{{TOCright}}
 +
<translate>
  
The offline documentation has now also made been available in French and Italian. (Check for other languages.) These files are not part of the official installers of FreeCAD but available as separate packages.
+
==Help module== <!--T:19-->
  
 +
<!--T:20-->
 +
'''Note:''' The FreeCAD offline help files, described below, are being retired. The help system of FreeCAD is now managed by the [https://github.com/yorikvanhavre/FreeCAD-Help Help Addon], which you can install via the [[Std_AddonMgr|Addon manager]]. The Help Addon is able to access online documentation, without the need to download anything, or an offline, downloadable copy of the documentation, which can also be installed via the Addon manager.
  
==Download Helpfiles==
+
==FreeCAD Helpfiles== <!--T:1-->
  
A working offline documentation consist of at least two files: "freecad.qhc" the Qt-helpfile-configuration and "freecad.qch" the compressed Qt-helpfile. They are put together in a ZIP-archive.
+
<!--T:16-->
 +
The FreeCAD offline documentation is built from the FreeCAD wiki by using scripts. It has grown to a file size over 220 MB. These big files are not part of installers and executables of FreeCAD, but can be installed separately as documented here.
  
The helpfiles can be downloaded here: https://github.com/FreeCAD/FreeCAD/releases/tag/0.18_pre
+
<!--T:2-->
 +
Translations from the community are encouraged, so the offline documentation is now also available in French and Italian. Other languages may be in different stages of completeness.
  
As a future option they can be installed from within FreeCAD with the [[AddonManager|Addon manager]].
+
==Download Helpfiles== <!--T:3-->
  
A working offline documentation consist of at least two files: "freecad.qhc" the Qt-helpfile-configuration and "freecad.qch" the compressed Qt-helpfile. They have always the same name. In order to have different version of the helpfiles, these need to be installed in different directories. In case of a manual download, just store the zip-file locally and extract the archive into the wanted directory.
+
<!--T:4-->
 +
A working offline documentation consist of at least two files: {{FileName|freecad.qhc}} the Qt-helpfile-configuration and {{FileName|freecad.qch}} the compressed Qt-helpfile. They are put together in a ZIP-archive.
  
==Register the Documentation==
+
<!--T:5-->
The actual organization of the offline help does allow only one helpfile to be active. It is therefore not possible to have helpfiles in different languages accessible from FreeCAD at the same time.
+
The helpfiles can be downloaded here: https://github.com/FreeCAD/FreeCAD/releases/download/0.19.2/FreeCAD.0_19.Offline.Doc.7z
  
In order to make another FreeCAD documentation active the following steps have to be applied:
+
<!--T:6-->
 +
As a future option they can be installed from within FreeCAD with the [[Std_AddonMgr|Addon Manager]].
 +
 
 +
<!--T:7-->
 +
The help files do always have the same names: {{FileName|freecad.qhc}} and {{FileName|freecad.qch}}. In order to have different version of the helpfiles, these need to be installed in different directories. In case of a manual download, just store the zip-file locally and extract the archive into the wanted directory.
 +
 
 +
==Register the Documentation== <!--T:8-->
  
* Click inside FreeCAD in the Help menu on the Help item. The program Qt-assistant should be open.
+
<!--T:12-->
* In Qt-assistant click in the menu Edit on preferences.
+
The documentation system of FreeCAD uses Qt Assistant. You should install this program first, if you don't have it.
* In the preferences dialog click on the tab Documentation.
 
* In the documentation dialog select org.freecad.usermanual and click on "Remove"
 
* Close the dialog with ok, but do not close the Qt-assistant. This is important as otherwise another helpfile will not be registered.
 
* Open again the preferences dialog via the menu Edit/Preferences.
 
* Select the tab documentation and click the button Add...
 
* In the filedialog navigate to your new helpfile and select freecad.qch
 
* close the filedialog by confirming your selection. The Documentation tab in the preferences should now have again a line with org.freecad.usermanual.
 
* Close the Preferences with Ok.
 
* You should now have the new documentation available in the Qt-assistant, that are accessible from within FreeCAD.
 
  
==Additional Notes==
+
<!--T:17-->
 +
The actual organization of the offline help allow only one helpfile to be active. It is therefore not possible to have helpfiles in different languages accessible from FreeCAD at the same time.
  
In case your operation system has no Qt-Assistant and it is not delivered with FreeCAD, it will be necessary to install one.
+
<!--T:9-->
 +
In order to make another FreeCAD documentation active the following steps have to be applied:
  
 +
<!--T:10-->
 +
* Click inside FreeCAD in the menu {{MenuCommand|Help  → Help}}. The program Qt-assistant should open.
 +
* In Qt-assistant click in the menu {{MenuCommand|Edit → preferences}}.
 +
* In the preferences dialog click on the {{MenuCommand|Documentation}} tab.
 +
* In the list registered documentation select {{incode|org.freecad.usermanual}} and click on the button {{Button|Remove}}.
 +
* Close the dialog with {{Button|OK}}, but do not close the Qt-assistant. This is important as otherwise another helpfile will not be registered.
 +
* Open again the preferences dialog via the menu {{MenuCommand|Edit → preferences}}.
 +
* Select the tab documentation and click the button {{Button|Add...}}
 +
* In the dialog navigate to your new helpfile and select {{FileName|freecad.qch}}
 +
* close the dialog by confirming your selection. In the {{MenuCommand|Documentation}} tab in the preferences there should now be a line with {{incode|org.freecad.usermanual}}.
 +
* Close the {{MenuCommand|Preferences}} with {{Button|OK}}.
 +
* You should now have the new documentation available in the Qt-assistant, which is accessible from within FreeCAD.
  
 +
==A Note About Ubuntu== <!--T:18-->
 +
Difficulties may arise when trying to install the documentation packages on Ubuntu (for example, {{incode|freecad-doc}} or {{incode|freecad-daily-doc}}). If this is found to be the case, then executing the following steps will enable you to have offline documentation.
 +
* Download the {{FileName|freecad.qhc}} and {{FileName|freecad.qch}} help files from https://github.com/FreeCAD/FreeCAD/releases/download/0.19.2/FreeCAD.0_19.Offline.Doc.7z and extract them using 7zip.
 +
* Alternatively, you can instead get the development versions of the {{FileName|freecad.qhc}} and {{FileName|freecad.qch}} help files from [https://github.com/FreeCAD/FreeCAD/tree/master/src/Doc GitHub]. You will need to [http://man7.org/linux/man-pages/man1/cat.1.html concatenate] the .part files together: {{incode|cat freecad.qch.part00 freecad.qch.part01 freecad.qch.part02 freecad.qch.part03 > freecad.qch}}.
 +
* With administrative privileges (e.g., {{incode|sudo}}), copy or move {{FileName|freecad.qhc}} and {{FileName|freecad.qch}} to {{FileName|/usr/share/doc/freecad-doc/}}. If you are using {{incode|freecad-daily}}, this will instead be {{FileName|/usr/share/doc/freecad-daily-doc/}}.
  
{{Docnav|Installing|Getting started}}
 
  
[[Category:User Documentation]]
+
</translate>
 +
{{Userdocnavi{{#translation:}}}}

Latest revision as of 20:50, 11 June 2022

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎polski • ‎português do Brasil • ‎русский

Help module

Note: The FreeCAD offline help files, described below, are being retired. The help system of FreeCAD is now managed by the Help Addon, which you can install via the Addon manager. The Help Addon is able to access online documentation, without the need to download anything, or an offline, downloadable copy of the documentation, which can also be installed via the Addon manager.

FreeCAD Helpfiles

The FreeCAD offline documentation is built from the FreeCAD wiki by using scripts. It has grown to a file size over 220 MB. These big files are not part of installers and executables of FreeCAD, but can be installed separately as documented here.

Translations from the community are encouraged, so the offline documentation is now also available in French and Italian. Other languages may be in different stages of completeness.

Download Helpfiles

A working offline documentation consist of at least two files: freecad.qhc the Qt-helpfile-configuration and freecad.qch the compressed Qt-helpfile. They are put together in a ZIP-archive.

The helpfiles can be downloaded here: https://github.com/FreeCAD/FreeCAD/releases/download/0.19.2/FreeCAD.0_19.Offline.Doc.7z

As a future option they can be installed from within FreeCAD with the Addon Manager.

The help files do always have the same names: freecad.qhc and freecad.qch. In order to have different version of the helpfiles, these need to be installed in different directories. In case of a manual download, just store the zip-file locally and extract the archive into the wanted directory.

Register the Documentation

The documentation system of FreeCAD uses Qt Assistant. You should install this program first, if you don't have it.

The actual organization of the offline help allow only one helpfile to be active. It is therefore not possible to have helpfiles in different languages accessible from FreeCAD at the same time.

In order to make another FreeCAD documentation active the following steps have to be applied:

  • Click inside FreeCAD in the menu Help → Help. The program Qt-assistant should open.
  • In Qt-assistant click in the menu Edit → preferences.
  • In the preferences dialog click on the Documentation tab.
  • In the list registered documentation select org.freecad.usermanual and click on the button Remove.
  • Close the dialog with OK, but do not close the Qt-assistant. This is important as otherwise another helpfile will not be registered.
  • Open again the preferences dialog via the menu Edit → preferences.
  • Select the tab documentation and click the button Add...
  • In the dialog navigate to your new helpfile and select freecad.qch
  • close the dialog by confirming your selection. In the Documentation tab in the preferences there should now be a line with org.freecad.usermanual.
  • Close the Preferences with OK.
  • You should now have the new documentation available in the Qt-assistant, which is accessible from within FreeCAD.

A Note About Ubuntu

Difficulties may arise when trying to install the documentation packages on Ubuntu (for example, freecad-doc or freecad-daily-doc). If this is found to be the case, then executing the following steps will enable you to have offline documentation.

  • Download the freecad.qhc and freecad.qch help files from https://github.com/FreeCAD/FreeCAD/releases/download/0.19.2/FreeCAD.0_19.Offline.Doc.7z and extract them using 7zip.
  • Alternatively, you can instead get the development versions of the freecad.qhc and freecad.qch help files from GitHub. You will need to concatenate the .part files together: cat freecad.qch.part00 freecad.qch.part01 freecad.qch.part02 freecad.qch.part03 > freecad.qch.
  • With administrative privileges (e.g., sudo), copy or move freecad.qhc and freecad.qch to /usr/share/doc/freecad-doc/. If you are using freecad-daily, this will instead be /usr/share/doc/freecad-daily-doc/.