WikiPages/pl

Ta strona jest rozszerzeniem strony Pomoc: Edycja i podaje wspólne wytyczne dotyczące pisania i aktualizowania dokumentacji wiki FreeCAD. Podsumowuje kilka dyskusji i sesji burzy mózgów.

Zanim rozpoczniesz pracę

 * Ta dokumentacja wiki jest oparta na MediaWiki, tym samym oprogramowaniu, które zasila Wikipedię. Jeśli już wcześniej brałeś udział w Wikipedii, edycja stron wiki FreeCAD powinna być łatwa.
 * W przeciwieństwie do Wikipedii, wiki FreeCAD jest zabezpieczona przed pisaniem, aby uniknąć spamu. Musisz poprosić o utworzenie konta na forum.
 * Jeśli nigdy wcześniej nie korzystałeś z oprogramowania wiki, przejdź do Help:Editing, aby zapoznać się z znacznikami stosowanymi do edycji stron.
 * Informacje na temat zaawansowanego korzystania z oprogramowania Wiki można znaleźć w MediaWiki  Help:Contents. Nie wszystkie funkcje MediaWiki są dostępne w Wiki FreeCAD, ale wiele z nich jest dostępnych.
 * Chcemy, aby dokumentacja była przejrzysta i łatwa do odczytania, więc unikaj używania skomplikowanych funkcji. Utrzymuj ją w formie prostej.
 * Użyj piaskownicy do przetestowania swojego kodu, na przykład FreeCADDocu:Sandbox lub konkretnej strony o nazwie Sandbox:Yourname.
 * Proszę zwrócić uwagę na tłumaczenia. Wiki FreeCAD używa automatycznej obsługi tłumaczeń, aby dostarczać strony w wielu językach. Dla każdej strony może istnieć wiele wersji językowych. Na wielu stronach zobaczysz znaczniki takie jak  oraz wiele pojedynczych znaczników takich jak  . Te ostatnie są tworzone przez system tłumaczący. Łączą one nagłówki i akapity z ich przetłumaczonymi wersjami. Nie powinieneś ich zmieniać, ponieważ zniszczyłoby to te linki. Można jednak przenosić akapity lub zmieniać ich brzmienie, o ile znaczniki pozostaną z nimi. Jeśli usuwasz nagłówek lub akapit, powinieneś również usunąć należący do niego znacznik. Należy pamiętać, że zmiany w istniejących nagłówkach i akapitach wpływają na aktualne tłumaczenia. Twoje zmiany powinny być tego warte. Nie musisz się martwić o dodawanie nowych materiałów, ponieważ system automatycznie doda nowe tagi po Twoich zmianach. Więcej informacji można znaleźć na stronie Lokalizacja oraz na oryginalnej stronie Mediawiki:Extension:Translate.

Dokładne opisy
Opisując FreeCAD staraj się być zwięzły i konkretny oraz unikaj powtórzeń. Opisuj co FreeCAD robi, a nie czego FreeCAD nie robi. Unikaj również kolokwialnych wyrażeń takich jak parę. Używaj słowa kilka, gdy masz do czynienia z nieokreśloną liczbą, lub określ prawidłową ilość.


 * Opis niewłaściwy
 * PartDesign: Środowisko pracy PartDesign jest stołem roboczym do projektowania części, którego celem jest dostarczenie narzędzi do modelowania złożonych brył części.


 * Opis dobry
 * PartDesign: ma na celu dostarczenie narzędzi do modelowania złożonych brył części.

Scentralizowane informacje
Należy unikać powielania tych samych informacji w różnych miejscach. Umieść informacje na nowej stronie i łącze do tej strony z innych stron, które wymagają tych informacji.

Nie używaj funkcji przechodzenia stron (Pomoc:Edycja#Szablony i transkluzja stron), ponieważ utrudnia to tłumaczenie wiki. Używaj tylko szablonów opisanych poniżej w sekcji #Szablony.

Stylizacja
Szablony są używane do stylizacji stron pomocy. Nadają one dokumentacji spójny wygląd i sposób działania. Istnieje szablon dla poleceń menu,, szablon dla klawiszy, które mają być wciśnięte, , dla wyświetlania wartości logicznej, , itd. Proszę zapoznać się z sekcją #Szablony przed rozpoczęciem pisania stron pomocy.

Flagi tymczasowe
Jeśli pracujesz nad dużą stroną, zaleca się zaznaczenie jej albo jako praca w toku, albo jako niedokończona. Gwarantuje to, że administratorzy Wiki nie zaznaczą twojej strony jako gotowej do tłumaczenia, podczas gdy ty wciąż często ją zmieniasz.

Aby oznaczyć stronę, po prostu dodaj albo   lub    jako pierwszą linię do strony. Z   zapraszasz wszystkich do przyłączenia się i ukończenia strony, podczas gdy z    możesz wykonać pracę, a inni powinni dać ci trochę czasu.

Po zakończeniu pracy, proszę nie zapomnieć o usunięciu flag!

Przykłady
Aby szybko zapoznać się ze strukturą i stylem Wiki FreeCAD zajrzyj na stronę modelu: GuiCommand model.

Struktura
Centrum użytkownika zapewnia Spis treści. Jest on używany jako główny punkt odniesienia do automatycznego budowania pomocy offline, do której można dotrzeć z programu FreeCAD, jak również dokumentacji offline PDF.

Szablon Template:Docnav jest używany do sekwencyjnego linkowania stron, zgodnie ze strukturą Spisu treści pomocy online. Lista wszystkich szablonów znajduje się w sekcji Szablony.

Nazwy stron
Nazwy stron powinny być krótkie, a w odróżnieniu od "opisu sprawy" powinny zawierać "tytuł sprawy", wszystkie wyrazy poza pierwszym i nazwami własnymi piszemy małymi literami. Jest to styl używany przez Wikipedię dla ich artykułów.


 * Niewłaściwa nazwa strony:
 * Budowa samolotów AeroCompany


 * Prawidłowa nazwa strony:
 * Budowa samolotów AeroCompany

Nazwy stron środowisk pracy o najwyższym poziomie muszą mieć taki format:, gdzie   jest nazwą środowiska, na przykład PartDesign Workbench. A nazwy stron opisujących polecenia (lub narzędzia) należące do danego środowiska muszą mieć taki format:, na przykład PartDesign Pad. Zwróć uwagę, że powinieneś używać nazwy polecenia tak, jak występuje ona w kodzie źródłowym.

Poprzednią konwencją było używanie dużej litery w tytule: każde słowo powinno zaczynać się wielką literą, chyba że są to artykuły, przyimki, spójniki lub inne cząstki gramatyczne (np. 'of', 'on', 'in', 'a', 'an', 'and'). Istnieje wiele istniejących stron używających tego stylu, ale jest on odradzany dla nowych stron. Zostało to przedyskutowane w wątku na forum (Linki z małych liter) Używaj małych liter w tytułach stron wiki.

Nagłówki
Podobnie jak nazwy stron, nagłówki akapitów powinny być krótkie i zawierać duże litery. Nie należy używać nagłówków   w znacznikach Wiki, ponieważ tytuł strony jest automatycznie dodawany jako główny nagłówek.

Odnośniki internetowe
Jeśli to możliwe, powinieneś używać oryginalnej nazwy linku dla linków. Dzięki temu w dokumentacji drukowanej lub offline łatwiej jest znaleźć stronę, do której zastosowano odniesienie. Proszę unikać nieistotnych słów dla linku.


 * Nieprawidłowy link
 * Aby uzyskać więcej informacji na temat rysowania obiektów 2D kliknij tutaj.


 * Prawidłowy link
 * Więcej informacji na temat rysowania obiektów 2D można znaleźć w Środowisku pracy Rysunek roboczy.

Preferowany format linku to:

przetłumaczone:

Zauważ, że w przypadku części przed znakiem  istotny jest faktyczny link, wielkość liter. Jeśli nazwa Twojej strony to, link nie powiedzie się, jeśli wpiszesz   (wielka litera P). Przed znakiem  wszystkie spacje należy zastąpić podkreśleniami. Ma to na celu pomoc tłumaczom korzystającym z oprogramowania tłumaczącego, bez podkreślników link zostałby przetłumaczony przez oprogramowanie, co jest niepożądane.

Aby połączyć się z konkretnym akapitem, dodaj do nazwy strony znak  i jego nagłówek. Przykład:

przetłumaczone:

W obrębie tej samej strony możesz pominąć nazwę strony. Przykład:

Aby przejść do górnej części strony możesz użyć:

Ten odnośnik będzie działał nawet wtedy, gdy na stronie nie ma akapitu "Do góry". Jest on szczególnie przydatny w przypadku długich stron, ponieważ pozwala użytkownikowi na szybki powrót do spisu treści. Możesz go umieścić na końcu każdego akapitu. Upewnij się, że przed i po odnośniku znajduje się pusta linia.

Strony Środowisk pracy
Strona najwyższego poziomu powinna zaczynać się od:
 * Opisu do czego służy dane środowisko pracy.
 * Obrazka ilustrującego opis.

Zobacz sekcję #Zrzut ekranu dla rozwiązań dotyczących dołączania obrazów.

Strony poleceń
Strony komend opisujące narzędzia środowiska pracy nie powinny być zbyt długie, powinny jedynie wyjaśniać, co dana komenda może zrobić, a czego nie, oraz jak jej użyć. Obrazki i przykłady należy ograniczyć do minimum. Poradniki mogą wyjaśniać jak używać danego narzędzia i podawać szczegóły krok po kroku.

Proszę odnieść się do strony GuiCommand model po więcej szczegółów.

Poradniki
Dobrze napisany poradnik powinien uczyć, jak szybko osiągnąć pewne praktyczne rezultaty. Nie powinien być zbyt długi, ale powinien zawierać wystarczającą ilość instrukcji krok po kroku i obrazów, aby poprowadzić użytkownika. W miarę rozwoju programu FreeCAD, samouczki mogą stać się nieaktualne, dlatego ważne jest, aby wspomnieć o wersji FreeCAD użytej w poradniku lub wymaganej do jego napisania.

Przykłady można znaleźć na stronie Poradniki.

Szablony
Stylizacja stron Wiki FreeCAD jest osiągana poprzez użycie (szablonów i stron pośrednich). Zapewniają one standardowy wygląd i sposób działania wszystkich stron, a także umożliwiają zmianę stylu wiki. Możesz zobaczyć pełną listę zdefiniowanych szablonów wchodząc na stronę Special:PrefixIndex/Template:. Ale proszę używaj tylko szablonów wymienionych w tabelach poniżej. Tylko w bardzo szczególnych przypadkach powinieneś używać bezpośrednio znaczników HTML.

Kliknij na link do szablonu, aby zobaczyć instrukcje użycia szablonu oraz jego implementację. Szablony są potężną funkcją oprogramowania MediaWiki. Powinieneś być doświadczonym użytkownikiem wiki, jeśli chcesz proponować dodatki i modyfikacje do istniejących szablonów. Nieprawidłowo zaimplementowane szablony utrudniają tłumaczenie stron na inne języki, dlatego ich użycie powinno być ograniczone do formatowania tekstu, należy unikać dołączania stron. Zobacz Pomoc MediaWiki:Szablony aby dowiedzieć się więcej.

Proste szablony
Szablony te przyjmują prosty parametr tekstowy i formatują go za pomocą określonego stylu.

Złożone szablony
Szablony te wymagają większej ilości parametrów wejściowych, lub generują blok tekstu o określonym formacie.

Grafika
Obrazy i zrzuty ekranu są niezbędne do stworzenia kompletnej dokumentacji programu FreeCAD. Są one szczególnie przydatne do ilustrowania przykładów i samouczków. Obrazy powinny być wyświetlane w ich oryginalnym rozmiarze, tak aby prezentowały wystarczającą ilość szczegółów i były czytelne, jeśli zawierają tekst. Obrazy w formacie Bitmap nie powinny być zmieniane.

Unikaj animowanych obrazów (GIF) na ogólnych stronach pomocy. Animacje i filmy powinny być zarezerwowane dla samouczków, które nie są przeznaczone do użycia jako dokumentacja PDF offline.

Pliki graficzne mogą być załadowane poprzez stronę Special:Upload.

Nazwa
Nadawaj obrazkom znaczące nazwy. Jeśli masz obrazek, który pokazuje charakterystykę konkretnego polecenia, powinieneś użyć nazwy tego polecenia z na końcu. Na przykład dla polecenia Draft Offset obrazek powinien mieć nazwę.

Zrzut ekranu
Zalecane rozmiary dla zrzutów ekranu to:
 * Natywny 400x200 (lub szerokość=400 i wysokość<=200), dla stron command reference, aby obrazek zmieścił się w lewej części strony, oraz dla innych standardowych zrzutów.
 * Natywny 600x400 (lub szerokość=600 i wysokość<=400), dla stron command reference, kiedy naprawdę potrzebujesz większego obrazka, i nadal pozwalasz obrazkowi zmieścić się w lewej części strony, oraz dla innych standardowych zrzutów.
 * Natywny rozmiar 1024x768 (lub szerokość=1024 i wysokość<=768), tylko dla obrazów pełnoekranowych.
 * Mniejsze rozmiary są możliwe przy wyświetlaniu szczegółów.
 * Unikaj obrazów o większych rozdzielczościach, ponieważ nie będą one wystarczająco dopasowane do innych rodzajów wyświetlaczy lub drukowanej dokumentacji PDF.

Nie powinieneś polegać na niestandardowej konfiguracji pulpitu lub systemu operacyjnego podczas tworzenia zrzutów ekranu i powinieneś używać domyślnych ustawień wizualnych interfejsu FreeCAD, kiedy tylko jest to możliwe.

Aby utworzyć zrzuty ekranu, możesz użyć opcji dostarczonych przez system operacyjny lub jednej z tych makroinstrukcji:  Macro Snip lub  Macro Screen Wiki.

Treść
Aby ułatwić tłumaczenie dokumentacji, staraj się unikać zrzutów ekranu, które zawierają teksty. Jeśli nie możesz tego uniknąć, rozważ zrobienie osobnych zrzutów ekranu interfejsu i okna widoku 3D. Obraz widoku 3D może być ponownie użyty w każdym tłumaczeniu, podczas gdy tłumacz może w razie potrzeby wykonać zrzut ekranu zlokalizowanego interfejsu.

Ikonki i grafika
Odnieś się do strony Artykuły, aby zobaczyć wszystkie grafiki i ikony, które zostały stworzone dla FreeCAD, a które mogą być również użyte na stronach dokumentacji. Jeśli chciałbyś dodać ikony, proszę przeczytaj Artwork Guidelines.

Tłumaczenia
Zgodnie z ogólnym konsensusem, strona referencyjna w Wiki jest stroną angielską, która powinna być utworzona jako pierwsza. Jeśli chcesz zmienić lub dodać treść do strony, powinieneś zrobić to najpierw na angielskiej stronie, a dopiero po zakończeniu aktualizacji przenieść modyfikację na przetłumaczoną stronę.

FreeCAD Wiki wspiera rozszerzenie tłumaczenia, które pozwala na łatwiejsze zarządzanie tłumaczeniami między stronami; szczegóły w Tłumaczenie dokumentacji Wiki dla FreeCAD.

Inne przydatne zasoby to:
 * Kody ISO języków aby określić dwuliterowy kod dla danego języka, na który chcesz tłumaczyć.
 * Google Translate do pomocy przy tłumaczeniach.
 * tłumacz Deepl do pomocy przy tłumaczeniach.

Tłumaczenie komend Gui
przetłumaczone:

Ustawienia szablonu
przetłumaczone:

Tłumaczenie odnośnika
Part Module

przetłumaczone:

Atelier Pièces /

Tłumaczenie Docnav
przetłumaczone:

Przykład z ikonami:

przetłumaczone:

Zmiana nazwy stron
Ponieważ FreeCAD jest projektem w ciągłym rozwoju, czasami jest konieczne zrewidowanie zawartości Wiki. Jeśli nazwy poleceń są zmieniane w kodzie źródłowym, strony wiki je dokumentujące również muszą być zmieniane. To może być zrobione tylko przez administratorów Wiki. Aby ich o tym poinformować, otwórz temat na forum forum Wiki i w tym formularzu opisz konieczną operację zmiany nazwy:

old name        new name Old_page_name_1 New_page_name_1 Old_page_name_2 New_page_name_2 ...

Usuwanie plików i stron
W przypadku, gdy chcesz usunąć plik, przejdź na jego stronę i edytuj ją. Nie ważne czy strona jest pusta czy nie, dodaj to jako pierwszy element:  i bezpośrednio pod nim opisać, dlaczego strona powinna zostać usunięta. Dodatkowo, otwórz temat w dziale forum Wiki.

Dla stron procedura jest taka sama.

Dyskusja
Subforum Development/Wiki w FreeCAD forum zapewnia dedykowaną przestrzeń do dyskusji na tematy Wiki, wygląd i wszystko inne związane z Wiki. Kieruj tam swoje pytania i sugestie.

Angielski
Zobacz Słownik

Inne języki

 * włoski
 * francuski
 * niemiecki
 * polski