Std AddonMgr/pl: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
 
(41 intermediate revisions by 2 users not shown)
Line 2: Line 2:


{{Docnav/pl
{{Docnav/pl
|[[Std_DlgCustomize|Dostosuj]]
|[[Std_DlgCustomize/pl|Dostosuj]]
|
|
|[[Std_Tools_Menu/pl|Menu Przybory]]
|[[Std_Tools_Menu/pl|Std: Menu Przybory]]
|IconL=Std_DlgCustomize.svg
|IconL=Std_DlgCustomize.svg
|IconR=
|IconR=
Line 19: Line 19:
}}
}}


<span id="Description"></span>
==Opis==
==Opis==


Polecenie '''Std: Menadżer dodatków''' otwiera Menadżer dodatków. Za jego pomocą możesz zainstalować i zarządzać [[External_workbenches/pl|Zewnętrznymi środowiskami pracy]] oraz [[Macros/pl|makropoleceniami]] dostarczonymi przez społeczność FreeCAD. Dostępne Środowiska pracy i makra pobierane z dwóch repozytoriów, [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] i [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros], oraz ze strony [[Macros_recipes/pl|Przepisy na makropolecenia]].
Polecenie '''Std: Menadżer dodatków''' otwiera Menadżer dodatków. Za jego pomocą możesz zainstalować i zarządzać [[External_workbenches/pl|Zewnętrznymi środowiskami pracy]] oraz [[Macros/pl|makropoleceniami]] i [[Preference_Packs/pl|paczkami ustawień]] dostarczonymi przez społeczność FreeCAD. Domyślnie dostępne dodatki pobierane są z dwóch repozytoriów [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] oraz [[Macros_recipes/pl|Przepisy na makrodefinicje]]. Jeśli w systemie zainstalowane są GitPython i Git, dodatkowe makra zostaną załadowane z [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]. Własne repozytoria można dodać w ustawieniach [[Preferences_Editor/pl#Menad.C5.BCer_dodatk.C3.B3w|Menadżera dodatków]].


Z powodu zmian na platformie GitHub w roku 2020 menedżer dodatków nie działa już, jeśli używasz FreeCAD w wersji 0.17 lub starszej. Musisz zaktualizować program do wersji [https://github.com/FreeCAD/FreeCAD/releases/tag/0.18.5 0.18.5] lub nowszej. Alternatywnie możesz zainstalować dodatki ręcznie, zobacz [[#Uwagi|uwagi]] poniżej.
Dodatki oznaczone {{emphasis|Tylko Python 2}} nie będą działać we FreeCAD w wersji 0.19 lub nowszej.

Z powodu zmian na platformie GitHub w roku 2020 menedżer dodatków nie działa już, jeśli używasz FreeCAD w wersji 0.17 lub starszej. Musisz zaktualizować program do wersji [https://github.com/FreeCAD/FreeCAD/releases/tag/0.18.5 0.18.5] lub nowszej [https://github.com/FreeCAD/FreeCAD/releases/tag/0.19_pre 0.19]. Alternatywnie możesz zainstalować dodatki ręcznie, zobacz [[#Uwagi|uwagi]] poniżej.

[[Image:Std_AddonMgr_dialog.png]]
{{Caption|Okienko dialogowe Menedżera dodatków}}


<span id="Usage"></span>
==Użycie==
==Użycie==


# Wybierz opcję z menu {{MenuCommand|Przybory → [[Image:Std_AddonMgr.svg|16px]] Menedżer dodatków}}.
# Wybierz opcję z menu {{MenuCommand|Przybory → [[Image:Std_AddonMgr.svg|16px]] Menedżer dodatków}}.
# Jeśli używasz menedżera dodatków po raz pierwszy, zostanie otwarte okienko informacyjne z ostrzeżeniem, że rozszerzenia w menedżerze dodatków nie są oficjalnie częścią programu FreeCAD. Naciśnij przycisk {{Button|OK}}, aby potwierdzić zapoznanie się z tą informacją i kontynuować.
# Jeśli używasz menedżera dodatków po raz pierwszy, zostanie otwarte okienko informacyjne z ostrzeżeniem, że rozszerzenia w menedżerze dodatków nie są oficjalnie częścią programu FreeCAD. Przedstawia on również kilka opcji związanych z wykorzystaniem danych przez menedżera dodatków. Dostosuj te opcje do swoich potrzeb i naciśnij przycisk {{Button|OK}}, aby potwierdzić zapoznanie się z tą informacją i kontynuować.
# Otworzy się okno dialogowe Menadżer Dodatków. Więcej informacji znajdziesz w rozdziale [[#Opcje|Opcje]].
# Otworzy się okno dialogowe Menadżer Dodatków. Więcej informacji znajdziesz w rozdziale [[#Opcje|Opcje]].
# Przycisk {{Button|[[Image:Button_valid.svg|16px]]Aktualizuj wszystko}} nie działa w tym momencie.
# Naciśnij przycisk {{Button|[[Image:Process-stop.svg|16px]]Zamknij}} , aby zamknąć okienko dialogowe.
# Jeżeli zainstalowałeś lub zaktualizowałeś Środowisko pracy, otworzy się nowe okno dialogowe informujące o konieczności ponownego uruchomienia programu FreeCAD, aby wprowadzone zmiany zaczęły funkcjonować.
# Jeżeli zainstalowałeś lub zaktualizowałeś Środowisko pracy, otworzy się nowe okno dialogowe informujące o konieczności ponownego uruchomienia programu FreeCAD, aby wprowadzone zmiany zaczęły funkcjonować.


<span id="Options"></span>
==Opcje==
==Opcje==


[[File:AddonManager_Main.png|600px]]
Okno dialogowe Menadżera dodatków posiada dwie zakładki po lewej stronie, jedna z nich zawiera listę dostępnych środowisk pracy, a druga listę dostępnych makr. W panelu informacyjnym po prawej stronie zostanie wyświetlona strona główna wybranego dodatku.


# Menedżer dodatków udostępnia dwa układy widoków: "Zwięzły" i "Rozszerzony". W widoku "Zwięzłym" każdy dodatek zajmuje jedną linię, a jego opis jest obcięty, aby zmieścić się w dostępnym miejscu. Z kolei "Rozszerzony" pokazuje dodatkowe szczegóły, w tym więcej tekstu opisu, a także informacje o opiekunie, więcej szczegółów instalacji itp.
===Odinstalowanie===
# Obsługiwane są trzy różne typy dodatków: [[External_workbenches/pl|środowiska pracy]], [[Macros/pl|makrodefinicje]], oraz [[Preference_Packs/pl|pakiety preferencji]]. Możesz zdecydować, czy chcesz wyświetlić tylko jeden typ, czy wszystkie na jednej liście.
# Lista może być zawężona do pokazania tylko zainstalowanych pakietów, tylko pakietów z dostępnymi aktualizacjami, lub tylko pakietów, które nie są jeszcze zainstalowane.
# Listę można filtrować, szukając słowa kluczowego w tytule, opisie i tagach ''(opis i tagi muszą być określone przez twórcę dodatku w jego metadanych)''. Filtr może być nawet wyrażeniem regularnym, co pozwala na precyzyjną kontrolę dokładnego wyszukiwania.
# Rozszerzony widok pokazuje dostępne informacje o wersji, opisie, opiekunie i wersji instalacji dla pakietów, które dostarczają pliki [[Package_Metadata/pl|metadanych pakietu]] ''(lub dla makrodefinicji z wbudowanymi metadanymi)''.
# Dane dodatków są buforowane lokalnie, ze zmienną częstotliwością aktualizacji pamięci podręcznej ustawioną w preferencjach użytkownika.
# W każdej chwili możesz wybrać ręczne aktualizowanie lokalnej pamięci podręcznej, aby zobaczyć najnowsze aktualizacje dostępne dla każdego dodatku.
# Sprawdzanie aktualizacji może być ustawione jako automatyczne lub wykonywane ręcznie poprzez kliknięcie przycisku ''(skonfigurowane w preferencjach użytkownika)''. Jeśli środowiska GitPython i Git są zainstalowane w systemie, to informacje o aktualizacjach są pobierane przy użyciu Git. Jeśli nie, to informacje o aktualizacjach są uzyskiwane z dowolnego obecnego pliku metadanych.


Kliknięcie dodatku w tym widoku powoduje wyświetlenie strony szczegółów:
# Wybierz zainstalowany dodatek w zakładce [[Image:Folder.svg|16px]] '''Środowiska pracy''' lub [[Image:Applications-python.svg|16px]] '''Makrodefinicje'''.
# Naciśnij przycisk {{Button|[[Image:Delete.svg|16px]] Odinstaluj wybrane}}.


[[File:AddonManager_Details.png|600px]]
===Instalacja / aktualizacja===


Na stronie szczegółów znajdują się przyciski umożliwiające instalację, odinstalowanie, aktualizację i tymczasowe wyłączenie dodatku. Dla zainstalowanych dodatków wyświetlana jest aktualnie zainstalowana wersja i data instalacji oraz informacja, czy jest to najnowsza dostępna wersja. Poniżej znajduje się osadzone okno przeglądarki internetowej pokazujące stronę README dodatku ''(dla środowisk pracy i pakietów preferencji)'' lub stronę Wiki ''(dla makrodefinicji)''.
# Wybierz dodatek w zakładce [[Image:Folder.svg|16px]] '''Środowiska pracy''' lub [[Image:Applications-python.svg|16px]] '''Makrodefinicje'''.
# Wciśnij przycisk {{Button|[[Image:Edit_OK.svg|16px]] Zainstaluj/zaktualizuj wybrane}}.
# Jeśli chcesz dodać makropolecenie do niestandardowego paska narzędzi, nie zapomnij samodzielnie pobrać pliku z obrazem ikony, jeśli jest dostępny, klikając odnośnik na stronie głównej w panelu informacyjnym. Patrz [[Interface_Customization/pl#Paski_narzędzi|Dostosowanie interfejsu]].
# Aby zmienić położenie dodatkowego Środowiska pracy na liście [[Interface_Customization/pl#Środowiska_pracy|Wybór środowiska pracy]] można zapoznać się z informacjami w dokumencie [[Interface_Customization/pl#Środowiska_pracy|Dostosowanie interfejsu]].


<span id="Preferences"></span>
===Konfiguracja===
==Ustawienia==


Preferencje dla menedżera dodatków można znaleźć w [[Preferences_Editor/pl#Menad.C5.BCer_dodatk.C3.B3w|Edytorze ustawień]]. {{Version/pl|0.20}}
# Wciśnij przycisk {{Button|[[Image:Preferences-general.svg|16px]] Konfiguruj...}}
# Zostanie otworzone okienko dialogowe Menadżera dodatków.
# Opcjonalnie zaznacz pole wyboru {{CheckBox|TRUE|Automatyczne sprawdzaj aktualizacje podczas uruchomienia ''(wymaga GitPython)''}}.
# Opcjonalnie dodaj repozytoria do listy '''Repozytoria użytkownika'''. Dodatki z tych repozytoriów zostaną dodane na liście w zakładce [[Image:Folder.svg|16px]] '''Środowiska pracy''' lub [[Image:Applications-python.svg|16px]] '''Makrodefinicje'''.
# Opcjonalnie wybierz ustawienia proxy.
# Wciśnij przycisk {{Button|OK}} lub {{Button|Anuluj}} aby zamknąć okno dialogowe.


<span id="Sorting_by_score"></span>
==Sortowanie według punktacji==

{{Version/pl|1.0}}

Menedżer dodatków obsługuje sortowanie według wielu różnych kryteriów. Większość z nich jest pobierana bezpośrednio z serwerów FreeCAD ''(który buforuje je z GitHub i FreeCAD Wiki)'', ale jeden, "Wynik", nie jest w ogóle dostarczany przez FreeCAD i pojawia się jako opcja tylko wtedy, gdy ustawienie URL źródła wyniku jest podane w Preferencjach.

Źródło URL wyniku jest ścieżką do zdalnego dokumentu sformatowanego jako JSON, który zawiera listę dodatków oraz jakiegoś rodzaju "wynik". Wynik może być obliczany w dowolny sposób, według upodobania dostawcy danych, ale powinien być wartością całkowitą, gdzie wyższe wyniki są w pewnym sensie "lepsze". Każdy dodatek, który nie jest wymieniony, jest wewnętrznie przypisywany wynik zero. Format pliku to pojedynczy słownik JSON, gdzie klucz to URL dodatku ''(dla warsztatów roboczych i pakietów preferencji)'' lub nazwa makrodefinicji ''(dla makr)''. Zobacz [https://gist.githubusercontent.com/chennes/e8f60e80f16e6ffbd057dd47ca36ad2a/raw/7b118cca8e84444c3379919bbd744b99e6ef6711/addon_score_for_testing.json to źródło danych] dla przykładu ''(zauważ, że wynik tam jest po prostu długością opisu dodatku i jest przeznaczony tylko do testów i celów demonstracyjnych)''.

<span id="Notes"></span>
==Uwagi==
==Uwagi==


Line 72: Line 77:
* Możesz również zainstalować dodatki ręcznie. Zobacz artykuł [[How_to_install_additional_workbenches/pl|Jak zainstalować dodatkowe Środowiska pracy]] oraz [[How_to_install_macros/pl|Jak zainstalować makrodefinicje]].
* Możesz również zainstalować dodatki ręcznie. Zobacz artykuł [[How_to_install_additional_workbenches/pl|Jak zainstalować dodatkowe Środowiska pracy]] oraz [[How_to_install_macros/pl|Jak zainstalować makrodefinicje]].


<span id="Information_for_addon_developers"></span>
==Informacja dla programistów==
==Informacje dla twórców dodatków==


Zobacz również informacje o [[Addon/pl#Informacja_dla_programist.C3.B3w|dodatkach]].
Jeśli opracowałeś Środowisko pracy lub makrodefinicję i chcesz zobaczyć je w Menedżerze dodatków, przeczytaj jak to zrobić na stronach repozytorium: ([https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons] i [https://github.com/FreeCAD/FreeCAD-macros/ FreeCAD-macros]). Jeśli dodasz swoje makro do strony [[Macros_recipes/pl|Przepisy na makropolecenia]], nie będziesz miał już nic innego do zrobienia, zostanie ono automatycznie przechwycone przez Menadżer dodatków.


<span id="Scripting"></span>
===Python i środowiska pracy===
==Tworzenie skryptów==


{{Version/pl|0.21}}
Dla pakietów Pythona, nie potrzebujesz żadnej szczególnej zgody, aby Twój pakiet został dodany do Menedżera dodatków. Ponadto, ponieważ Twój dodatek jest poza kodem źródłowym FreeCAD, możesz wybrać licencję, jaką chcesz. Jeśli poprosisz o dodanie twojego środowiska pracy do domyślnej listy Menedżera Dodatków (nie dodamy żadnego nowego środowiska pracy bez prośby jego autorów), albo poprzez zapytanie na forum, albo poprzez otwarcie problemu na repozytorium [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons], twój kod pozostanie na twoim własnym repozytorium git, my tylko dodamy go jako submoduł do repozytorium [https://github.com/FreeCAD/FreeCAD-addons/ FreeCAD-addons]. Oczywiście, przed dodaniem twojego środowiska pracy, przyjrzymy się mu i upewnimy się, że nie ma w nim nic potencjalnie problematycznego. Więcej szczegółów na temat struktury Twojego dodatku, w tym informacje o metadanych używanych przez Menedżera Dodatków, znajdziesz na stronie [[Workbench_creation/pl|Tworzenie Środowiska pracy]].


Niektóre funkcje menedżera dodatków są zaprojektowane tak, aby dostęp do nich był możliwy poprzez API Python programu FreeCAD. W szczególności dodatek może być instalowany, aktualizowany i usuwany za pomocą interfejsu środowiska Python. Większość zastosowań tego API wymaga utworzenia obiektu z co najmniej trzema atrybutami: {{Incode|name}}, {{Incode|branch}} i {{Incode|url}}. Na przykład:
===C++ i środowiska pracy===

{{Code|code=
class MyAddonClass:
def __init__(self):
self.name = "TestAddon"
self.url = "https://github.com/Me/MyTestAddon"
self.branch = "main"
my_addon = MyAddonClass()
}}

nasz obiekt {{Incode|my_addon}} jest teraz gotowy do użycia z API Menedżera addonów.

<span id="Commandline_(non-GUI)_use"></span>
===Użycie z wiersza poleceń (nie-GUI)===

Jeśli twój kod musi zainstalować lub zaktualizować dodatek synchronicznie ''(np. bez GUI)'', kod może być bardzo prosty:

{{Code|code=
from addonmanager_installer import AddonInstaller
installer = AddonInstaller(my_addon)
installer.run()
}}

Zauważ, że ten kod blokuje się do momentu zakończenia, więc nie powinieneś go uruchamiać na głównym wątku GUI. Dla menedżera dodatków, "install" i "update" są tym samym wywołaniem: jeśli ten dodatek jest już zainstalowany, a Git jest dostępny, zostanie zaktualizowany poprzez "Git pull". Jeśli nie jest zainstalowany lub został zainstalowany za pomocą metody instalacji innej niż Git, zostanie pobrany od zera ''(przy użyciu Git, jeśli jest dostępny)''.

Aby odinstalować, należy użyć:

{{Code|code=
from addonmanager_uninstaller import AddonUninstaller
uninstaller = AddonUninstaller(my_addon)
uninstaller.run()
}}

<span id="GUI_use"></span>
===Użycie z GUI===

Jeśli planujesz uruchomić swój kod w GUI, lub wspierać go w pełnej wersji FreeCAD, najlepiej jest uruchomić swoją instalację w oddzielnym wątku bez GUI, aby GUI pozostał responsywny. Aby to zrobić, najpierw sprawdź, czy GUI jest uruchomione, a jeśli tak, utwórz {{Incode|QThread}} ''(nie próbuj tworzyć {{Incode|QThread}}, jeśli GUI nie jest uruchomione: wymagają one aktywnej pętli zdarzeń, aby działać)''.

{{Code|code=
from PySide import QtCore
from addonmanager_installer import AddonInstaller

worker_thread = QtCore.QThread()
installer = AddonInstaller(my_addon)
installer.moveToThread(worker_thread)
installer.success.connect(installation_succeeded)
installer.failure.connect(installation_failed)
installer.finished.connect(worker_thread.quit)
worker_thread.started.connect(installer.run)
worker_thread.start() # Returns immediately
}}


Następnie zdefiniuj funkcje {{Incode|installation_succeeded}} i {{Incode|installation_failed}}, które mają być uruchamiane w każdym przypadku. Do deinstalacji możesz użyć tej samej techniki, choć zwykle jest ona znacznie szybsza i nie zablokuje GUI na bardzo długo, więc generalnie bezpiecznie jest użyć deinstalatora bezpośrednio, jak pokazano powyżej.
Jeśli tworzysz własne środowisko pracy w C++, nie może ono być uruchamiane bezpośrednio przez użytkowników i musi być najpierw skompilowane. Masz wtedy dwie opcje, albo sam dostarczysz prekompilowane wersje swojego Środowiska pracy, dla różnych systemów operacyjnych, albo powinieneś poprosić o połączenie swojego kodu z kodem źródłowym FreeCAD. W tym celu należy skorzystać z licencji LGPL ''(lub w pełni kompatybilnej licencji jak MIT lub BSD)'', a nowe narzędzia należy przedstawić społeczności na forum [https://forum.freecadweb.org FreeCAD] do wglądu. Po przetestowaniu i zatwierdzeniu kodu, powinieneś rozwidlić repozytorium FreeCAD, jeśli jeszcze tego nie zrobiłeś, stworzyć nową gałąź, wcisnąć do niej swój kod i otworzyć polecenie "pull", aby Twoja gałąź została połączona z głównym repozytorium.




{{Docnav/pl
{{Docnav/pl
|[[Std_DlgCustomize|Std: DlgCustomize]]
|[[Std_DlgCustomize/pl|Dostosuj]]
|
|
|[[Std_Tools_Menu/pl|Std: Menu Narzędzia]]
|[[Std_Tools_Menu/pl|Std: Menu Przybory]]
|IconL=Std_DlgCustomize.svg
|IconL=Std_DlgCustomize.svg
|IconR=
|IconR=
Line 96: Line 154:
{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Latest revision as of 10:45, 21 April 2024

Std: Menadżer dodatków

Lokalizacja w menu
Przybory → Menadżer dodatków
Środowisko pracy
Wszystkie
Domyślny skrót
brak
Wprowadzono w wersji
0.17
Zobacz także
Zewnętrzne środowiska pracy, Makrodefinicje

Opis

Polecenie Std: Menadżer dodatków otwiera Menadżer dodatków. Za jego pomocą możesz zainstalować i zarządzać Zewnętrznymi środowiskami pracy oraz makropoleceniami i paczkami ustawień dostarczonymi przez społeczność FreeCAD. Domyślnie dostępne dodatki pobierane są z dwóch repozytoriów FreeCAD-addons oraz Przepisy na makrodefinicje. Jeśli w systemie zainstalowane są GitPython i Git, dodatkowe makra zostaną załadowane z FreeCAD-macros. Własne repozytoria można dodać w ustawieniach Menadżera dodatków.

Z powodu zmian na platformie GitHub w roku 2020 menedżer dodatków nie działa już, jeśli używasz FreeCAD w wersji 0.17 lub starszej. Musisz zaktualizować program do wersji 0.18.5 lub nowszej. Alternatywnie możesz zainstalować dodatki ręcznie, zobacz uwagi poniżej.

Użycie

  1. Wybierz opcję z menu Przybory → Menedżer dodatków.
  2. Jeśli używasz menedżera dodatków po raz pierwszy, zostanie otwarte okienko informacyjne z ostrzeżeniem, że rozszerzenia w menedżerze dodatków nie są oficjalnie częścią programu FreeCAD. Przedstawia on również kilka opcji związanych z wykorzystaniem danych przez menedżera dodatków. Dostosuj te opcje do swoich potrzeb i naciśnij przycisk OK, aby potwierdzić zapoznanie się z tą informacją i kontynuować.
  3. Otworzy się okno dialogowe Menadżer Dodatków. Więcej informacji znajdziesz w rozdziale Opcje.
  4. Jeżeli zainstalowałeś lub zaktualizowałeś Środowisko pracy, otworzy się nowe okno dialogowe informujące o konieczności ponownego uruchomienia programu FreeCAD, aby wprowadzone zmiany zaczęły funkcjonować.

Opcje

  1. Menedżer dodatków udostępnia dwa układy widoków: "Zwięzły" i "Rozszerzony". W widoku "Zwięzłym" każdy dodatek zajmuje jedną linię, a jego opis jest obcięty, aby zmieścić się w dostępnym miejscu. Z kolei "Rozszerzony" pokazuje dodatkowe szczegóły, w tym więcej tekstu opisu, a także informacje o opiekunie, więcej szczegółów instalacji itp.
  2. Obsługiwane są trzy różne typy dodatków: środowiska pracy, makrodefinicje, oraz pakiety preferencji. Możesz zdecydować, czy chcesz wyświetlić tylko jeden typ, czy wszystkie na jednej liście.
  3. Lista może być zawężona do pokazania tylko zainstalowanych pakietów, tylko pakietów z dostępnymi aktualizacjami, lub tylko pakietów, które nie są jeszcze zainstalowane.
  4. Listę można filtrować, szukając słowa kluczowego w tytule, opisie i tagach (opis i tagi muszą być określone przez twórcę dodatku w jego metadanych). Filtr może być nawet wyrażeniem regularnym, co pozwala na precyzyjną kontrolę dokładnego wyszukiwania.
  5. Rozszerzony widok pokazuje dostępne informacje o wersji, opisie, opiekunie i wersji instalacji dla pakietów, które dostarczają pliki metadanych pakietu (lub dla makrodefinicji z wbudowanymi metadanymi).
  6. Dane dodatków są buforowane lokalnie, ze zmienną częstotliwością aktualizacji pamięci podręcznej ustawioną w preferencjach użytkownika.
  7. W każdej chwili możesz wybrać ręczne aktualizowanie lokalnej pamięci podręcznej, aby zobaczyć najnowsze aktualizacje dostępne dla każdego dodatku.
  8. Sprawdzanie aktualizacji może być ustawione jako automatyczne lub wykonywane ręcznie poprzez kliknięcie przycisku (skonfigurowane w preferencjach użytkownika). Jeśli środowiska GitPython i Git są zainstalowane w systemie, to informacje o aktualizacjach są pobierane przy użyciu Git. Jeśli nie, to informacje o aktualizacjach są uzyskiwane z dowolnego obecnego pliku metadanych.

Kliknięcie dodatku w tym widoku powoduje wyświetlenie strony szczegółów:

Na stronie szczegółów znajdują się przyciski umożliwiające instalację, odinstalowanie, aktualizację i tymczasowe wyłączenie dodatku. Dla zainstalowanych dodatków wyświetlana jest aktualnie zainstalowana wersja i data instalacji oraz informacja, czy jest to najnowsza dostępna wersja. Poniżej znajduje się osadzone okno przeglądarki internetowej pokazujące stronę README dodatku (dla środowisk pracy i pakietów preferencji) lub stronę Wiki (dla makrodefinicji).

Ustawienia

Preferencje dla menedżera dodatków można znaleźć w Edytorze ustawień. dostępne w wersji 0.20

Sortowanie według punktacji

dostępne w wersji 1.0

Menedżer dodatków obsługuje sortowanie według wielu różnych kryteriów. Większość z nich jest pobierana bezpośrednio z serwerów FreeCAD (który buforuje je z GitHub i FreeCAD Wiki), ale jeden, "Wynik", nie jest w ogóle dostarczany przez FreeCAD i pojawia się jako opcja tylko wtedy, gdy ustawienie URL źródła wyniku jest podane w Preferencjach.

Źródło URL wyniku jest ścieżką do zdalnego dokumentu sformatowanego jako JSON, który zawiera listę dodatków oraz jakiegoś rodzaju "wynik". Wynik może być obliczany w dowolny sposób, według upodobania dostawcy danych, ale powinien być wartością całkowitą, gdzie wyższe wyniki są w pewnym sensie "lepsze". Każdy dodatek, który nie jest wymieniony, jest wewnętrznie przypisywany wynik zero. Format pliku to pojedynczy słownik JSON, gdzie klucz to URL dodatku (dla warsztatów roboczych i pakietów preferencji) lub nazwa makrodefinicji (dla makr). Zobacz to źródło danych dla przykładu (zauważ, że wynik tam jest po prostu długością opisu dodatku i jest przeznaczony tylko do testów i celów demonstracyjnych).

Uwagi

  • Korzystanie z dodatków nie jest ograniczone do wersji FreeCAD, w której zostały zainstalowane. Będziesz mógł również używać ich w każdej innej wersji programu, obsługiwanej przez dodatek, która może być zainstalowana w Twoim systemie.
  • Dodatki dostępne w menedżerze dodatków nie są częścią oficjalnego programu FreeCAD i nie są wspierane przez główny zespół programistów FreeCAD. Powinieneś uważnie przeczytać zamieszczone informacje, aby upewnić się, że wiesz, co instalujesz.
  • Zgłoszenia błędów i prośby o funkcje powinny być kierowane bezpośrednio do twórcy dodatku poprzez odwiedzenie wskazanej strony internetowej. Wielu twórców dodatków jest stałymi użytkownikami forum FreeCAD i można się z nimi również tam kontaktować.
  • Jeśli pakiet GitPython jest zainstalowany na Twoim komputerze, menedżer dodatków będzie z niego korzystał, dzięki czemu pobieranie będzie szybsze.
  • Możesz również zainstalować dodatki ręcznie. Zobacz artykuł Jak zainstalować dodatkowe Środowiska pracy oraz Jak zainstalować makrodefinicje.

Informacje dla twórców dodatków

Zobacz również informacje o dodatkach.

Tworzenie skryptów

dostępne w wersji 0.21

Niektóre funkcje menedżera dodatków są zaprojektowane tak, aby dostęp do nich był możliwy poprzez API Python programu FreeCAD. W szczególności dodatek może być instalowany, aktualizowany i usuwany za pomocą interfejsu środowiska Python. Większość zastosowań tego API wymaga utworzenia obiektu z co najmniej trzema atrybutami: name, branch i url. Na przykład:

class MyAddonClass:
    def __init__(self):
        self.name = "TestAddon"
        self.url = "https://github.com/Me/MyTestAddon"
        self.branch = "main"
my_addon = MyAddonClass()

nasz obiekt my_addon jest teraz gotowy do użycia z API Menedżera addonów.

Użycie z wiersza poleceń (nie-GUI)

Jeśli twój kod musi zainstalować lub zaktualizować dodatek synchronicznie (np. bez GUI), kod może być bardzo prosty:

from addonmanager_installer import AddonInstaller
installer = AddonInstaller(my_addon)
installer.run()

Zauważ, że ten kod blokuje się do momentu zakończenia, więc nie powinieneś go uruchamiać na głównym wątku GUI. Dla menedżera dodatków, "install" i "update" są tym samym wywołaniem: jeśli ten dodatek jest już zainstalowany, a Git jest dostępny, zostanie zaktualizowany poprzez "Git pull". Jeśli nie jest zainstalowany lub został zainstalowany za pomocą metody instalacji innej niż Git, zostanie pobrany od zera (przy użyciu Git, jeśli jest dostępny).

Aby odinstalować, należy użyć:

from addonmanager_uninstaller import AddonUninstaller
uninstaller = AddonUninstaller(my_addon)
uninstaller.run()

Użycie z GUI

Jeśli planujesz uruchomić swój kod w GUI, lub wspierać go w pełnej wersji FreeCAD, najlepiej jest uruchomić swoją instalację w oddzielnym wątku bez GUI, aby GUI pozostał responsywny. Aby to zrobić, najpierw sprawdź, czy GUI jest uruchomione, a jeśli tak, utwórz QThread (nie próbuj tworzyć QThread, jeśli GUI nie jest uruchomione: wymagają one aktywnej pętli zdarzeń, aby działać).

from PySide import QtCore
from addonmanager_installer import AddonInstaller

worker_thread = QtCore.QThread()
installer = AddonInstaller(my_addon)
installer.moveToThread(worker_thread)
installer.success.connect(installation_succeeded)
installer.failure.connect(installation_failed)
installer.finished.connect(worker_thread.quit)
worker_thread.started.connect(installer.run)
worker_thread.start() # Returns immediately

Następnie zdefiniuj funkcje installation_succeeded i installation_failed, które mają być uruchamiane w każdym przypadku. Do deinstalacji możesz użyć tej samej techniki, choć zwykle jest ona znacznie szybsza i nie zablokuje GUI na bardzo długo, więc generalnie bezpiecznie jest użyć deinstalatora bezpośrednio, jak pokazano powyżej.