Installieren einer Hilfedatei

From FreeCAD Documentation
Jump to: navigation, search
This page is a translated version of the page Installing Helpfile and the translation is 44% complete.

Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎français • ‎italiano • ‎polski
Arrow-left.svg Previous: Installing

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 und Programme von FreeCAD, aber die lokale Dokumentation kann separat installiert werden, was hier näher erklärt wird.

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

Übersetzungen aus der Gemeinschaft werden begrüßt, so dass lokale Dokumentationen inzwischen auch für die Sprachen Französisch und Italienisch verfügbar sind. Weitere Sprachen können in unterschiedlichen Zuständen der Vollständigkeit zur Verfügung stehen.

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 die 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.

Wenn in dem Betriebssystem kein Programm Qt-Assistant vorhanden ist, sollte dieses Programm zuerst installiert werden.

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.

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

  • Innerhalb des Programms FreeCAD im Menü Hilfe → Hilfe klicken. Es sollte sich das Programm Qt-Assistant öffnen.
  • Im Qt-Assistant im Menü Bearbeiten → "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 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 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.

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.18.1/FreeCAD.0_18.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/.