Installing Helpfile/de: Difference between revisions

From FreeCAD Documentation
(Created page with "* Innerhalb des Programms FreeCAD in dem Hilfemenü auf den Eintrag "Hilfe" klicken. Es sollte sich das Programm Qt-Assistent öffnen. * Im Qt-Assistenten in dem Menü "Bearbe...")
No edit summary
Line 20: Line 20:
Um eine andere Version der FreeCAD-Dokumentation aktiv zu machen, sind die folgenden Schritte nötig:
Um eine andere Version der FreeCAD-Dokumentation aktiv zu machen, sind die folgenden Schritte nötig:


* Innerhalb des Programms FreeCAD in dem Hilfemenü auf den Eintrag "Hilfe" klicken. Es sollte sich das Programm Qt-Assistent öffnen.
* Innerhalb des Programms FreeCAD in dem Hilfemenü auf den Eintrag "Hilfe" klicken. Es sollte sich das Programm Qt-Assistant öffnen.
* Im Qt-Assistenten in dem Menü "Bearbeiten" auf den Eintrag "Einstellungen..." klicken.
* Im Qt-Assistant in dem Menü "Bearbeiten" auf den Eintrag "Einstellungen..." klicken.
* Im Einstellungen-Dialog auf den Reiter Dokumentation klicken.
* In the preferences dialog click on the tab Documentation.
* In the documentation dialog select org.freecad.usermanual and click on "Remove"
* In der Liste registrierte Dokumentation den Eintrag "org.freecad.usermanual" auswählen und auf den Knopf "Entfernen" klicken.
* Den Einstellungen-Dialog mit ok schließen, aber nicht den Qt-Assistant beenden. Dies ist wichtig, da ansonsten eine neue Hilfedatei nicht registriert werden kann.
* Close the dialog with ok, but do not close the Qt-assistant. This is important as otherwise another helpfile will not be registered.
* Erneut den Einstellungen-Dialog über das Menü Bearbeiten/Einstellungen öffnen.
* Open again the preferences dialog via the menu Edit/Preferences.
* Den Reiter Dokumentation wählen und auf den Knopf "Hinzufügen..." klicken.
* Select the tab documentation and click the button Add...
* In the filedialog navigate to your new helpfile and select freecad.qch
* In dem sich öffnenden Dateiauswahldialog zu der neuen Hilfedatei navigieren und freecad.qch auswählen.
* close the filedialog by confirming your selection. The Documentation tab in the preferences should now have again a line with org.freecad.usermanual.
* Den Dateidialog durch Bestätigung der Auswahl schließen. Im Reiter Dokumentation sollte sich jetzt wieder ein Eintrag "org.freecad.usermanual" befinden.
* Die Einstellungen mit Ok schließen.
* Close the Preferences with Ok.
* Es sollte jetzt die neue Dokumentation in dem Qt-Assistant zur Verfügung stehen, so dass darauf aus FreeCAD zugegriffen werden kann.
* You should now have the new documentation available in the Qt-assistant, that are accessible from within FreeCAD.


==Weitere Anmerkungen==
==Weitere Anmerkungen==

Revision as of 17:48, 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:

  • Innerhalb des Programms FreeCAD in dem Hilfemenü auf den Eintrag "Hilfe" klicken. Es sollte sich das Programm Qt-Assistant öffnen.
  • Im Qt-Assistant in dem Menü "Bearbeiten" auf den Eintrag "Einstellungen..." klicken.
  • Im Einstellungen-Dialog auf den Reiter Dokumentation klicken.
  • In der Liste registrierte Dokumentation den Eintrag "org.freecad.usermanual" auswählen und auf den Knopf "Entfernen" klicken.
  • Den Einstellungen-Dialog mit ok schließen, aber nicht den Qt-Assistant beenden. Dies ist wichtig, da ansonsten eine neue Hilfedatei nicht registriert werden kann.
  • Erneut den Einstellungen-Dialog über das Menü Bearbeiten/Einstellungen öffnen.
  • Den Reiter Dokumentation wählen und auf den Knopf "Hinzufügen..." klicken.
  • In dem sich öffnenden Dateiauswahldialog zu der neuen Hilfedatei navigieren und freecad.qch auswählen.
  • Den Dateidialog durch Bestätigung der Auswahl schließen. Im Reiter Dokumentation sollte sich jetzt wieder ein Eintrag "org.freecad.usermanual" befinden.
  • Die Einstellungen mit Ok schließen.
  • Es sollte jetzt die neue Dokumentation in dem Qt-Assistant zur Verfügung stehen, so dass darauf aus FreeCAD zugegriffen werden kann.

Weitere Anmerkungen

Wenn in dem Betriebssystem kein Programm Qt-Assistant vorhanden ist und es auch nicht mit FreeCAD mitgeliefert wurde, muss dieses Programm installiert werden.


Installing/de
Getting started/de