Instalacja dokumentacji pomocy
FreeCAD dokumentacja pomocy
Dokumentacja FreeCAD offline jest budowana z wiki FreeCAD przy użyciu skryptów. Rozrósł się do rozmiaru pliku przekraczającego 100 MB. Te duże pliki nie są częścią instalatorów i plików wykonywalnych FreeCAD, ale mogą być instalowane oddzielnie, tak jak zostało to tutaj przedstawione.
Zachęca się do pracy nad tłumaczeniami społeczności, dzięki czemu dokumentacja offline jest teraz dostępna również w języku francuskim i włoskim. Dla innych języków mogą istnieć różne etapy zaawansowania.
Pobierz pliki pomocy
Dokumentacja działająca w trybie offline składa się z co najmniej dwóch plików: freecad.qhc konfiguracja pliku Qt-helpfile i freecad.qch skompresowany plik Qt-helpfile. Są one umieszczone razem w archiwum ZIP.
Pliki pomocy można pobrać tutaj: https://github.com/FreeCAD/FreeCAD/releases/tag/0.18_pre
W przyszłości będzie można je zainstalować z poziomu FreeCAD za pomocą Addon Manager.
Pliki pomocy mają zawsze te same nazwy: freecad.qhc i freecad.qch. Aby mieć różne wersje plików pomocy, pliki te muszą być zainstalowane w różnych katalogach. W przypadku ręcznego pobierania, wystarczy zapisać plik zip lokalnie i rozpakować archiwum do wybranego katalogu.
Zarejestrowanie dokumentacji
System dokumentacji FreeCAD wykorzystuje Qt Assistant. Powinieneś najpierw zainstalować ten program, jeśli go nie posiadasz.
Obecna organizacja pomocy offline pozwala, aby aktywny był tylko jeden plik pomocy. Dlatego nie jest możliwe posiadanie plików pomocy w różnych językach dostępnych jednocześnie z FreeCAD.
Aby aktywować kolejną dokumentację FreeCAD, należy wykonać następujące kroki:
- Kliknij na liście menu w FreeCAD Pomoc → Pomoc. Program Qt-assistant powinien się otworzyć.
- W programie Qt-assistant kliknij w menu Edit → preferencje.
- W oknie dialogowym preferencji kliknij zakładkę Documentation.
- Na liście zarejestrowanych dokumentów wybierz
org.freecad.usermanuali kliknij przycisk Remove. - Zamknij okno dialogowe za pomocą OK, ale nie zamykaj okna programu Qt-assistant. Jest to ważne, ponieważ w przeciwnym razie inny plik pomocy nie zostanie zarejestrowany.
- Otwórz ponownie okno dialogowe preferencji poprzez menu Edit → preferencje.
- Wybierz zakładkę dokumentacja i kliknij przycisk Dodaj....
- W oknie dialogowym przejdź do nowego pliku pomocy i wybierz freecad.qch.
- Zamknij okno dialogowe, potwierdzając wybór. W zakładce Documentation w preferencjach powinna teraz znajdować się linia z
org.freecad.usermanual. - Zamknij Preferences za pomocą OK.
- Powinieneś teraz mieć nową dokumentację dostępną w Qt-assistant, która jest dostępna z poziomu 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.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 usingfreecad-daily, this will instead be /usr/share/doc/freecad-daily-doc/.