Installing Helpfile/de: Difference between revisions

From FreeCAD Documentation
(Created page with "Um eine andere Version der FreeCAD-Dokumentation aktiv zu machen, sind die folgenden Schritte nötig:")
(Created page with "==Weitere Anmerkungen==")
Line 32: Line 32:
* You should now have the new documentation available in the Qt-assistant, that are accessible from within FreeCAD.
* You should now have the new documentation available in the Qt-assistant, that are accessible from within FreeCAD.


==Weitere Anmerkungen==
==Additional Notes==


In case your operation system has no Qt-Assistant and it is not delivered with FreeCAD, it will be necessary to install one.
In case your operation system has no Qt-Assistant and it is not delivered with FreeCAD, it will be necessary to install one.

Revision as of 16:06, 16 June 2018

FreeCAD Hilfedateien

Die lokal verfügbare Dokumentation für FreeCAD wird mit Hilfe von Skripten aus dem FreeCAD-Wiki erzeugt. Sie ist mittlerweile auf eine Größe von mehr als 100 Megabyte angewachsen. Diese großen Dateien sind nicht mehr Teil der Installer der Entwicklungsversionen von FreeCAD. Aber die lokale Dokumentation kann separat installiert werden, was hier näher erklärt wird.

Die lokale Dokumentation wurde inzwischen auch für die Sprachen Französisch und Italienisch erstellt. (Ob weitere Sprachen zur Verfügung stehen, ist nachzuschauen.) Diese Dateien sind nicht Teil der offiziellen Installationspakete, sondern als separate Pakete erhältlich.


Herunterlanden der Hilfedateien

Eine funktionsfähige lokale Dokumentation besteht aus mindestens zwei Dateien: "freecad.qhc" die Qt-Hilfedatei-Konfiguration und "freecad.qch" die komprimierte Qt-Hilfedatei. Beide sind zusammen in ein ZIP-Archiv gepackt.

Die Hilfedateien können hier heruntergeladen werden: https://github.com/FreeCAD/FreeCAD/releases/tag/0.18_pre

Als zukünftige Option sollen sie auch innerhalb von FreeCAD mit dem Addon manager installiert werden können.

Die Hilfedateien haben immer die gleichen Namen: "freecad.qhc" und "freecad.qch". Um verschiedene Versionen dieser Hilfsdateien zu haben, müssen sie in unterschiedlichen Verzeichnissen gespeichert werden. Falls die Dokumentation manuell heruntergeladen wird, ist das ZIP-Datei lokal zu speichern und in das gewünschte Dateiverzeichnis zu extrahieren.

Registrieren der Dokumentation

So wie die lokale Dokumentation organisiert ist, kann immer nur eine Hilfsdatei aktiv sein. Es ist deshalb nicht möglich, gleichzeitig auf Hilfsdateien in verschiedenen Sprachen von FreeCAD aus zuzugreifen.

Um eine andere Version der FreeCAD-Dokumentation aktiv zu machen, sind die folgenden Schritte nötig:

  • Click inside FreeCAD in the Help menu on the Help item. The program Qt-assistant should be open.
  • In Qt-assistant click in the menu Edit on preferences.
  • 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.

Weitere Anmerkungen

In case your operation system has no Qt-Assistant and it is not delivered with FreeCAD, it will be necessary to install one.


Installing
Getting started