Installing Helpfile/de: Difference between revisions

From FreeCAD Documentation
(Created page with "Wenn in dem Betriebssystem kein Programm Qt-Assistant vorhanden ist und es auch nicht mit FreeCAD mitgeliefert wurde, muss dieses Programm installiert werden.")
(Updating to match new version of source page)
 
(53 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<languages/>
==FreeCAD Hilfedateien==
{{TOCright}}
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.


==Help module==
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.


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


==Herunterlanden der Hilfedateien==
==FreeCAD Hilfedateien==


Die FreeCAD Offline Dokumentation wird aus dem FreeCAD Wiki durch die Verwendung von Skripten erstellt. Sie ist auf eine Dateigröße von über 220 MB angewachsen. Diese großen Dateien sind nicht Teil der Installationsprogramme und ausführbaren Dateien von FreeCAD, können aber, wie hier dokumentiert, separat installiert werden.
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.


Übersetzungen aus der Gemeinschaft sind erwünscht, daher ist die Offline Dokumentation jetzt auch in Französisch und Italienisch verfügbar. Andere Sprachen können sich in unterschiedlichen Stadien der Vollständigkeit befinden.
Die Hilfedateien können hier heruntergeladen werden: https://github.com/FreeCAD/FreeCAD/releases/tag/0.18_pre


==Herunterladen Hilfedateien==
Als zukünftige Option sollen sie auch innerhalb von FreeCAD mit dem [[AddonManager/de|Addon manager]] installiert werden können.


Eine funktionsfähige lokale Dokumentation besteht aus mindestens zwei Dateien: {{FileName|freecad.qhc}}, die Qt-Hilfedatei-Konfiguration und {{FileName|freecad.qch}}, die komprimierte Qt-Hilfedatei. Beide sind zusammen in ein ZIP-Archiv gepackt.
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.


Die Hilfedateien können hier heruntergeladen werden: https://github.com/FreeCAD/FreeCAD/releases/download/0.19.2/FreeCAD.0_19.Offline.Doc.7z
==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.


Als zukünftige Option können sie auch innerhalb von FreeCAD mit dem [[Std_AddonMgr/de|Addon-Manager]] installiert werden.
Um eine andere Version der FreeCAD-Dokumentation aktiv zu machen, sind die folgenden Schritte nötig:


Die Hilfedateien haben immer die gleichen Namen:{{FileName|freecad.qhc}} und {{FileName|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.
* 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.


==Registrieren der Dokumentation==
==Weitere Anmerkungen==


Das Dokumentationssystem von FreeCAD verwendet Qt Assistant. Du solltest dieses Programm zuerst installieren, falls du es noch nicht hast.
Wenn in dem Betriebssystem kein Programm Qt-Assistant vorhanden ist und es auch nicht mit FreeCAD mitgeliefert wurde, muss dieses Programm installiert werden.


Die aktuelle Gliederung der Offline Hilfe erlaubt es, dass nur eine Hilfedatei aktiv sein kann. Es ist daher nicht möglich, gleichzeitig Hilfedateien in verschiedenen Sprachen von FreeCAD aus zugänglich zu machen.


Um eine andere Version der FreeCAD Dokumentation aktiv zu machen, sind die folgenden Schritte anzuwenden:


* Klicke innerhalb von FreeCAD im Menü {{MenuCommand|Hilfe → Hilfe}}. Das Programm Qt-Assistenten sollte sich öffnen.
{{Docnav|Installing|Getting started}}
* Klicke in Qt-Assistenten im Menü {{MenuCommand|Bearbeiten → Einstellungen}}.
* Im Einstellungsdialog klicke auf den {{MenuCommand|Dokumentation}}s Reiter.
* Wähle in der Liste der registrierten Dokumentationen den Eintrag {{incode|org.freecad.usermanual}} und klicke auf die Schaltfläche {{Button|Entfernen}}.
* Schließe den Dialog mit {{Button|OK}}, aber schließe nicht den Qt-Assistenten. Dies ist wichtig, da sonst eine weitere Hilfedatei nicht registriert wird.
* Öffne erneut den Einstellungsdialog über das Menü {{MenuCommand|Bearbeiten→ Einstellungen}}.
* Wähle den Dokumentationsreiter und klicke auf die Schaltfläche {{Button|Hinzufügen...}}
* Navigiere im Dialog zu deiner neuen Hilfedatei und wähle {{FileName|freecad.qch}}
* Schließe den Dialog durch Bestätigen deiner Auswahl. Im Reiter {{MenuCommand|Dokumentation}} in den Voreinstellungen sollte nun eine Zeile mit {{incode|org.freecad.usermanual}} vorhanden sein.
* Schließe die {{MenuCommand|Einstellungen}} mit {{Button|OK}}.
* Du solltest nun die neue Dokumentation im Qt-Assistenten zur Verfügung haben, der von FreeCAD aus zugänglich ist.


==Ein Hinweis zu Ubuntu==
[[Category:User Documentation]]
Beim Versuch, die Dokumentationspakete unter Ubuntu zu installieren (z.B. {{incode|freecad-doc}} oder {{incode|freecad-daily-doc}}), können Schwierigkeiten auftreten. Sollte dies der Fall sein, kannst du durch die Ausführung der folgenden Schritte die Dokumentation offline verfügbar machen.
* Lade die Hilfedateien {{FileName|freecad.qch}} und {{FileName|freecad.qch}} von https://github.com/FreeCAD/FreeCAD/releases/download/0.19.2/FreeCAD.0_19.Offline.Doc.7z herunter und entpacke sie mit 7zip.
* Alternativ kannst du stattdessen die Entwicklungsversionen der Hilfedateien {{FileName|freecad.qhc}} und {{FileName|freecad.qch}} von [https://github.com/FreeCAD/FreeCAD/tree/master/src/Doc GitHub] erhalten. Du musst die .part Dateien zusammen [http://man7.org/linux/man-pages/man1/cat.1.html verketten]: {{incode|cat freecad.qch.part00 freecad.qch.part01 freecad.qch.part02 freecad.qch.part03 > freecad.qch}}.
* Mit administrativen Rechten (z. B. {{incode|sudo}}) kopierst oder verschiebst du {{FileName|freecad.qhc}} und {{FileName|freecad.qch}} nach {{FileName|/usr/share/doc/freecad-doc/}}. Wenn du {{incode|freecad-daily}} verwendest, wird dies stattdessen {{FileName|/usr/share/doc/freecad-daily-doc/}} sein.



<languages/>
{{Userdocnavi{{#translation:}}}}

Latest revision as of 20:51, 11 June 2022

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 Hilfedateien

Die FreeCAD Offline Dokumentation wird aus dem FreeCAD Wiki durch die Verwendung von Skripten erstellt. Sie ist auf eine Dateigröße von über 220 MB angewachsen. Diese großen Dateien sind nicht Teil der Installationsprogramme und ausführbaren Dateien von FreeCAD, können aber, wie hier dokumentiert, separat installiert werden.

Übersetzungen aus der Gemeinschaft sind erwünscht, daher ist die Offline Dokumentation jetzt auch in Französisch und Italienisch verfügbar. Andere Sprachen können sich in unterschiedlichen Stadien der Vollständigkeit befinden.

Herunterladen 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/download/0.19.2/FreeCAD.0_19.Offline.Doc.7z

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

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

Das Dokumentationssystem von FreeCAD verwendet Qt Assistant. Du solltest dieses Programm zuerst installieren, falls du es noch nicht hast.

Die aktuelle Gliederung der Offline Hilfe erlaubt es, dass nur eine Hilfedatei aktiv sein kann. Es ist daher nicht möglich, gleichzeitig Hilfedateien in verschiedenen Sprachen von FreeCAD aus zugänglich zu machen.

Um eine andere Version der FreeCAD Dokumentation aktiv zu machen, sind die folgenden Schritte anzuwenden:

  • Klicke innerhalb von FreeCAD im Menü Hilfe → Hilfe. Das Programm Qt-Assistenten sollte sich öffnen.
  • Klicke in Qt-Assistenten im Menü Bearbeiten → Einstellungen.
  • Im Einstellungsdialog klicke auf den Dokumentations Reiter.
  • Wähle in der Liste der registrierten Dokumentationen den Eintrag org.freecad.usermanual und klicke auf die Schaltfläche Entfernen.
  • Schließe den Dialog mit OK, aber schließe nicht den Qt-Assistenten. Dies ist wichtig, da sonst eine weitere Hilfedatei nicht registriert wird.
  • Öffne erneut den Einstellungsdialog über das Menü Bearbeiten→ Einstellungen.
  • Wähle den Dokumentationsreiter und klicke auf die Schaltfläche Hinzufügen...
  • Navigiere im Dialog zu deiner neuen Hilfedatei und wähle freecad.qch
  • Schließe den Dialog durch Bestätigen deiner Auswahl. Im Reiter Dokumentation in den Voreinstellungen sollte nun eine Zeile mit org.freecad.usermanual vorhanden sein.
  • Schließe die Einstellungen mit OK.
  • Du solltest nun die neue Dokumentation im Qt-Assistenten zur Verfügung haben, der von FreeCAD aus zugänglich ist.

Ein Hinweis zu Ubuntu

Beim Versuch, die Dokumentationspakete unter Ubuntu zu installieren (z.B. freecad-doc oder freecad-daily-doc), können Schwierigkeiten auftreten. Sollte dies der Fall sein, kannst du durch die Ausführung der folgenden Schritte die Dokumentation offline verfügbar machen.

  • Lade die Hilfedateien freecad.qch und freecad.qch von https://github.com/FreeCAD/FreeCAD/releases/download/0.19.2/FreeCAD.0_19.Offline.Doc.7z herunter und entpacke sie mit 7zip.
  • Alternativ kannst du stattdessen die Entwicklungsversionen der Hilfedateien freecad.qhc und freecad.qch von GitHub erhalten. Du musst die .part Dateien zusammen verketten: cat freecad.qch.part00 freecad.qch.part01 freecad.qch.part02 freecad.qch.part03 > freecad.qch.
  • Mit administrativen Rechten (z. B. sudo) kopierst oder verschiebst du freecad.qhc und freecad.qch nach /usr/share/doc/freecad-doc/. Wenn du freecad-daily verwendest, wird dies stattdessen /usr/share/doc/freecad-daily-doc/ sein.