WikiPages/pl: Difference between revisions
No edit summary |
No edit summary |
||
(17 intermediate revisions by 2 users not shown) | |||
Line 4: | Line 4: | ||
Ta strona jest rozszerzeniem strony [[Help:Editing|Pomoc: Edycja]] i podaje wspólne wytyczne dotyczące pisania i aktualizowania dokumentacji wiki FreeCAD. Podsumowuje kilka dyskusji i sesji burzy mózgów. |
Ta strona jest rozszerzeniem strony [[Help:Editing|Pomoc: Edycja]] i podaje wspólne wytyczne dotyczące pisania i aktualizowania dokumentacji wiki FreeCAD. Podsumowuje kilka dyskusji i sesji burzy mózgów. |
||
<span id="Before_starting"></span> |
|||
==Zanim rozpoczniesz pracę== |
==Zanim rozpoczniesz pracę== |
||
Line 15: | Line 16: | ||
*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 <code><translate>...</translate></code> oraz wiele pojedynczych znaczników takich jak <code><!--T:8--></code>. Te ostatnie oznaczają tzw. jednostki tłumaczeniowe i są tworzone przez system tłumaczeń, nigdy nie należy ich tworzyć ręcznie. Łą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 [[Localisation/pl|Lokalizacja]] oraz na oryginalnej stronie [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example Mediawiki:Extension:Translate]. |
*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 <code><translate>...</translate></code> oraz wiele pojedynczych znaczników takich jak <code><!--T:8--></code>. Te ostatnie oznaczają tzw. jednostki tłumaczeniowe i są tworzone przez system tłumaczeń, nigdy nie należy ich tworzyć ręcznie. Łą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 [[Localisation/pl|Lokalizacja]] oraz na oryginalnej stronie [https://www.mediawiki.org/wiki/Help:Extension:Translate/Page_translation_example Mediawiki:Extension:Translate]. |
||
<span id="General_guidelines"></span> |
|||
==Wytyczne ogólne== |
==Wytyczne ogólne== |
||
<span id="Concise_descriptions"></span> |
|||
===Dokładne opisy=== |
===Dokładne opisy=== |
||
Line 27: | Line 30: | ||
: [[PartDesign_Workbench/pl|PartDesign]]: ma na celu dostarczenie narzędzi do modelowania złożonych brył części. |
: [[PartDesign_Workbench/pl|PartDesign]]: ma na celu dostarczenie narzędzi do modelowania złożonych brył części. |
||
<span id="Centralized_information"></span> |
|||
===Scentralizowane informacje=== |
===Scentralizowane informacje=== |
||
Line 33: | Line 37: | ||
Nie używaj funkcji przechodzenia stron ''([[Help:Editing#Templates_and_transcluding_pages|Pomoc:Edycja#Szablony i transkluzja stron]])'', ponieważ utrudnia to tłumaczenie wiki. Używaj tylko szablonów opisanych poniżej w sekcji [[#Szablony|#Szablony]]. |
Nie używaj funkcji przechodzenia stron ''([[Help:Editing#Templates_and_transcluding_pages|Pomoc:Edycja#Szablony i transkluzja stron]])'', ponieważ utrudnia to tłumaczenie wiki. Używaj tylko szablonów opisanych poniżej w sekcji [[#Szablony|#Szablony]]. |
||
<span id="Styling"></span> |
|||
===Stylizacja=== |
===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, {{MenuCommand|Plik → Zapisz}}, szablon dla klawiszy, które mają być wciśnięte, {{KEY|Shift}}, dla wyświetlania wartości logicznej, {{TRUE}}, itd. Proszę zapoznać się z sekcją [[#Szablony|#Szablony]] przed rozpoczęciem pisania stron pomocy. |
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, {{MenuCommand|Plik → Zapisz}}, szablon dla klawiszy, które mają być wciśnięte, {{KEY|Shift}}, dla wyświetlania wartości logicznej, {{TRUE}}, itd. Proszę zapoznać się z sekcją [[#Szablony|#Szablony]] przed rozpoczęciem pisania stron pomocy. |
||
<span id="Temporary_flags"></span> |
|||
===Flagi tymczasowe=== |
===Flagi tymczasowe=== |
||
Line 45: | Line 51: | ||
Po zakończeniu pracy, proszę nie zapomnieć o usunięciu flag! |
Po zakończeniu pracy, proszę nie zapomnieć o usunięciu flag! |
||
<span id="Examples"></span> |
|||
==Przykłady== |
==Przykłady== |
||
Line 51: | Line 58: | ||
<div class="mw-collapsible mw-collapsed toccolours"> |
<div class="mw-collapsible mw-collapsed toccolours"> |
||
<span id="Structure"></span> |
|||
==Struktura== |
==Struktura== |
||
<div class="mw-collapsible-content"> |
<div class="mw-collapsible-content"> |
||
Line 58: | Line 67: | ||
Lista wszystkich szablonów znajduje się w sekcji [[#Szablony|Szablony]]. |
Lista wszystkich szablonów znajduje się w sekcji [[#Szablony|Szablony]]. |
||
<span id="Page_names"></span> |
|||
===Nazwy stron=== |
===Nazwy stron=== |
||
Line 70: | Line 80: | ||
Nazwy stron środowisk pracy o najwyższym poziomie muszą mieć taki format: <code>XYZ Workbench</code>, gdzie <code>XYZ</code> jest nazwą środowiska, na przykład [[PartDesign_Workbench/pl|PartDesign Workbench]]. A nazwy stron opisujących polecenia ''(lub narzędzia)'' należące do danego środowiska muszą mieć taki format: <code>XYZ Command</code>, na przykład [[PartDesign_Pad/pl|PartDesign Pad]]. Zwróć uwagę, że powinieneś używać nazwy polecenia tak, jak występuje ona w kodzie źródłowym. |
Nazwy stron środowisk pracy o najwyższym poziomie muszą mieć taki format: <code>XYZ Workbench</code>, gdzie <code>XYZ</code> jest nazwą środowiska, na przykład [[PartDesign_Workbench/pl|PartDesign Workbench]]. A nazwy stron opisujących polecenia ''(lub narzędzia)'' należące do danego środowiska muszą mieć taki format: <code>XYZ Command</code>, na przykład [[PartDesign_Pad/pl|PartDesign Pad]]. Zwróć uwagę, że powinieneś używać nazwy polecenia tak, jak występuje ona w kodzie źródłowym. |
||
<span id="Headings"></span> |
|||
===Nagłówki=== |
===Nagłówki=== |
||
Nagłówki akapitów powinny być krótkie i zawierać wielkie litery: wszystkie wyrazy, z wyjątkiem pierwszego i nazw własnych, powinny być pisane małymi literami. Nie należy używać nagłówków <code><nowiki>H1</nowiki></code> (<code><nowiki>= Heading =</nowiki></code>) w znacznikach Wiki, ponieważ tytuł strony jest automatycznie dodawany jako główny nagłówek <code><nowiki>H1</nowiki></code>. |
Nagłówki akapitów powinny być krótkie i zawierać wielkie litery: wszystkie wyrazy, z wyjątkiem pierwszego i nazw własnych, powinny być pisane małymi literami. Nie należy używać nagłówków <code><nowiki>H1</nowiki></code> (<code><nowiki>= Heading =</nowiki></code>) w znacznikach Wiki, ponieważ tytuł strony jest automatycznie dodawany jako główny nagłówek <code><nowiki>H1</nowiki></code>. |
||
<span id="Links"></span> |
|||
===Odnośniki internetowe=== |
===Odnośniki internetowe=== |
||
Line 126: | Line 138: | ||
<code><nowiki>[[Image:Draft_Wire.svg|24px|link=Draft_Wire/pl]] [[Draft_Wire/pl|Polilinia]]</nowiki></code> |
<code><nowiki>[[Image:Draft_Wire.svg|24px|link=Draft_Wire/pl]] [[Draft_Wire/pl|Polilinia]]</nowiki></code> |
||
<span id="Workbench_pages"></span> |
|||
===Strony Środowisk pracy=== |
===Strony Środowisk pracy=== |
||
Line 134: | Line 147: | ||
Zobacz sekcję [[#Zrzut_ekranu|#Zrzut ekranu]] dla rozwiązań dotyczących dołączania obrazów. |
Zobacz sekcję [[#Zrzut_ekranu|#Zrzut ekranu]] dla rozwiązań dotyczących dołączania obrazów. |
||
<span id="Command_pages"></span> |
|||
===Strony poleceń=== |
===Strony poleceń=== |
||
Line 140: | Line 154: | ||
Proszę odnieść się do strony [[GuiCommand_model/pl|GuiCommand model]] po więcej szczegółów. |
Proszę odnieść się do strony [[GuiCommand_model/pl|GuiCommand model]] po więcej szczegółów. |
||
<span id="Tutorials"></span> |
|||
===Poradniki=== |
===Poradniki=== |
||
Line 150: | Line 165: | ||
<div class="mw-collapsible mw-collapsed toccolours"> |
<div class="mw-collapsible mw-collapsed toccolours"> |
||
<span id="Templates"></span> |
|||
==Szablony== |
==Szablony== |
||
<div class="mw-collapsible-content"> |
<div class="mw-collapsible-content"> |
||
Line 156: | Line 172: | ||
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 [https://www.mediawiki.org/wiki/Help:Templates/pl Pomoc MediaWiki:Szablony] aby dowiedzieć się więcej. |
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 [https://www.mediawiki.org/wiki/Help:Templates/pl Pomoc MediaWiki:Szablony] aby dowiedzieć się więcej. |
||
<span id="Simple_templates"></span> |
|||
===Proste szablony=== |
===Proste szablony=== |
||
Line 210: | Line 227: | ||
|{{ComboBox|Menu 1}} |
|{{ComboBox|Menu 1}} |
||
|Użyj go do wskazania pola listy wyboru w graficznym interfejsie użytkownika, które należy zmienić. |
|Użyj go do wskazania pola listy wyboru w graficznym interfejsie użytkownika, które należy zmienić. |
||
|-- |
|||
|[[Template:LineEdit|LineEdit]] |
|||
|{{LineEdit|Metal Nikiel ''(Ni)''}} |
|||
|Służy do wskazywania Linii Edycji w graficznym interfejsie użytkownika, która wymaga modyfikacji. |
|||
|-- |
|-- |
||
Line 228: | Line 250: | ||
|-- |
|-- |
||
|[[Template:FileName|FileName]] |
|[[Template:FileName|FileName]] |
||
|{{FileName| |
|{{FileName|Nazwa pliku}} |
||
|Użyj go do wskazania nazwy pliku lub katalogu. |
|Użyj go do wskazania nazwy pliku lub katalogu. |
||
Line 292: | Line 314: | ||
|} |
|} |
||
<span id="Complex_templates"></span> |
|||
===Złożone szablony=== |
===Złożone szablony=== |
||
Line 321: | Line 344: | ||
|Użyj go, aby dołączyć wielowierszowe przykłady kodu z czcionką monospace. Domyślnym językiem jest Python, ale można podać inne języki. |
|Użyj go, aby dołączyć wielowierszowe przykłady kodu z czcionką monospace. Domyślnym językiem jest Python, ale można podać inne języki. |
||
Użyty kod [[Python/pl|Python]] powinien stosować się do ogólnych zaleceń ustanowionych przez [https://www.python.org/dev/peps/pep-0008/ PEP8: Style Guide for Python Code]. W szczególności, nawiasy powinny następować bezpośrednio po nazwie funkcji, a spacja powinna następować po przecinku. Dzięki temu kod jest bardziej czytelny |
Użyty kod [[Python/pl|Python]] powinien stosować się do ogólnych zaleceń ustanowionych przez [https://www.python.org/dev/peps/pep-0008/ PEP8: Style Guide for Python Code]. W szczególności, nawiasy powinny następować bezpośrednio po nazwie funkcji, a spacja powinna następować po przecinku. Dzięki temu kod jest bardziej czytelny. |
||
|-- |
|||
|[[Template:CodeDownload|CodeDownload]] |
|||
|{{CodeDownload|https://wiki.freecad.org/Main_Page|Niektóre oznaczenia}} |
|||
|Użyj go, aby utworzyć link na stronie [[Macros/pl|makrodefinicji]]. |
|||
|-- |
|||
|[[Template:Codeextralink|Codeextralink]] |
|||
|{{Codeextralink|https://wiki.freecad.org/Main_Page}} |
|||
|Użyj go, jeśli kod [[Macros/pl|makrodefinicji]] jest zbyt duży, by umieścić go na Wiki. Kod może być hostowany gdzie indziej, a surowy link do niego może być określony za pomocą tego szablonu. [[Std_AddonMgr/pl|Menedżer dodatków]] użyje tego linku. |
|||
|-- |
|-- |
||
Line 345: | Line 378: | ||
|-- |
|-- |
||
|[[Template:Docnav|Docnav]] |
|[[Template:Docnav|Docnav]] |
||
|{{Docnav| |
|{{Docnav|Strona startowa pomocy online|Lista funkcji}} |
||
|Użyj go, aby utworzyć pasek ze strzałkami i odpowiednimi linkami, który jest przydatny do umieszczania stron w określonej kolejności. |
|||
|Use it to create a bar with the words 'next', 'previous', and 'index', and the appropriate links, which is useful for putting pages in a particular sequence. |
|||
|-- |
|-- |
||
Line 384: | Line 417: | ||
<div class="mw-collapsible mw-collapsed toccolours"> |
<div class="mw-collapsible mw-collapsed toccolours"> |
||
<span id="Graphics"></span> |
|||
==Grafika== |
==Grafika== |
||
<div class="mw-collapsible-content"> |
<div class="mw-collapsible-content"> |
||
Line 392: | Line 427: | ||
Pliki graficzne mogą być załadowane poprzez stronę [[Special:Upload|Special:Upload]]. |
Pliki graficzne mogą być załadowane poprzez stronę [[Special:Upload|Special:Upload]]. |
||
<span id="Name"></span> |
|||
===Nazwa=== |
===Nazwa=== |
||
Nadawaj obrazkom znaczące nazwy. Jeśli masz obrazek, który pokazuje charakterystykę konkretnego polecenia, powinieneś użyć nazwy tego polecenia z {{incode|_example}} na końcu. Na przykład dla polecenia [[Draft_Offset/pl|Draft Offset]] obrazek powinien mieć nazwę {{incode|Draft_Offset_example.png}}. |
Nadawaj obrazkom znaczące nazwy. Jeśli masz obrazek, który pokazuje charakterystykę konkretnego polecenia, powinieneś użyć nazwy tego polecenia z {{incode|_example}} na końcu. Na przykład dla polecenia [[Draft_Offset/pl|Draft Offset]] obrazek powinien mieć nazwę {{incode|Draft_Offset_example.png}}. |
||
<span id="Screen_capture"></span> |
|||
===Zrzut ekranu=== |
===Zrzut ekranu=== |
||
Line 409: | Line 446: | ||
Aby utworzyć zrzuty ekranu, możesz użyć opcji dostarczonych przez system operacyjny lub jednej z tych makroinstrukcji: [[Image:Snip.png|24px]] [[Macro_Snip|Macro Snip]] lub [[Image:Macro_Screen_Wiki.png|24px]] [[Macro_Screen_Wiki|Macro Screen Wiki]]. |
Aby utworzyć zrzuty ekranu, możesz użyć opcji dostarczonych przez system operacyjny lub jednej z tych makroinstrukcji: [[Image:Snip.png|24px]] [[Macro_Snip|Macro Snip]] lub [[Image:Macro_Screen_Wiki.png|24px]] [[Macro_Screen_Wiki|Macro Screen Wiki]]. |
||
<span id="Text"></span> |
|||
===Treść=== |
===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 [[3D_view/pl|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. |
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 [[3D_view/pl|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. |
||
<span id="Icons_and_graphics"></span> |
|||
===Ikonki i grafika=== |
===Ikonki i grafika=== |
||
Line 420: | Line 459: | ||
<div class="mw-collapsible mw-collapsed toccolours"> |
<div class="mw-collapsible mw-collapsed toccolours"> |
||
<span id="Translations"></span> |
|||
==Tłumaczenia== |
==Tłumaczenia== |
||
<div class="mw-collapsible-content"> |
<div class="mw-collapsible-content"> |
||
Line 431: | Line 472: | ||
* [https://www.deepl.com/translator tłumacz Deepl] do pomocy przy tłumaczeniach. |
* [https://www.deepl.com/translator tłumacz Deepl] do pomocy przy tłumaczeniach. |
||
<span id="Some_tips_for_translators"></span> |
|||
==Kilka wskazówek dla tłumaczy== |
==Kilka wskazówek dla tłumaczy== |
||
<span id="Translate_GuiCommand"></span> |
|||
===Tłumaczenie komend Gui=== |
===Tłumaczenie komend Gui=== |
||
Line 460: | Line 503: | ||
</pre> |
</pre> |
||
<span id="Translate_navi"></span> |
|||
===Ustawienia szablonu=== |
===Ustawienia szablonu=== |
||
Line 472: | Line 516: | ||
</pre> |
</pre> |
||
<span id="Translate_link"></span> |
|||
===Tłumaczenie odnośnika=== |
===Tłumaczenie odnośnika=== |
||
Line 484: | Line 529: | ||
</pre> |
</pre> |
||
<span id="Translate_Docnav"></span> |
|||
===Tłumaczenie Docnav=== |
===Tłumaczenie Docnav=== |
||
Line 531: | Line 577: | ||
</div> <!-- END of Translation section collapsible element. Do not remove! --> |
</div> <!-- END of Translation section collapsible element. Do not remove! --> |
||
<span id="Create,_rename_and_delete_pages"></span> |
|||
==Tworzenie, zmiana nazwy i usuwanie strony== |
==Tworzenie, zmiana nazwy i usuwanie strony== |
||
<span id="Create_pages"></span> |
|||
===Tworzenie stron=== |
===Tworzenie stron=== |
||
Line 538: | Line 586: | ||
Aby utworzyć nową stronę wykonaj jedną z poniższych czynności: |
Aby utworzyć nową stronę wykonaj jedną z poniższych czynności: |
||
* Odwiedź adres URL z żądaną nazwą strony, na przykład: <code><nowiki>https://wiki.freecadweb.org/ |
* Odwiedź adres URL z żądaną nazwą strony, na przykład: <code><nowiki>https://wiki.freecadweb.org/Moja_Nowa_Strona</nowiki></code>, i kliknij na przycisk ''utwórz tą stronę''. |
||
* Wyszukaj w Wiki nazwę strony i kliknij na czerwony tekst w ''Utwórz stronę '''Moja |
* Wyszukaj w Wiki nazwę strony i kliknij na czerwony tekst w ''Utwórz stronę '''Moja Nowa Strona''' w tej Wiki!'. |
||
<span id="Rename_pages"></span> |
|||
===Zmiana nazwy stron=== |
===Zmiana nazwy stron=== |
||
Line 552: | Line 601: | ||
</pre> |
</pre> |
||
<span id="Delete_files_and_pages"></span> |
|||
===Usuwanie plików i stron=== |
===Usuwanie plików i stron=== |
||
Line 558: | Line 608: | ||
Dla stron procedura jest taka sama. |
Dla stron procedura jest taka sama. |
||
<span id="Discussion"></span> |
|||
==Dyskusja== |
==Dyskusja== |
||
Subforum [http://forum.freecadweb.org/viewforum.php?f=21 Development/Wiki] w [https://forum.freecadweb.org 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. |
Subforum [http://forum.freecadweb.org/viewforum.php?f=21 Development/Wiki] w [https://forum.freecadweb.org 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. |
||
<span id="Terminology_-_naming_policy"></span> |
|||
==Terminologia - Zasady nazewnictwa== |
==Terminologia - Zasady nazewnictwa== |
||
<span id="English"></span> |
|||
===Angielski=== |
===Angielski=== |
||
Zobacz [[Glossary|Słownik]] |
Zobacz [[Glossary|Słownik]] |
||
<span id="Other_languages"></span> |
|||
===Inne języki=== |
===Inne języki=== |
||
Line 574: | Line 628: | ||
* [[German_Translation|niemiecki]] |
* [[German_Translation|niemiecki]] |
||
* [[Polish_Translation|polski]] |
* [[Polish_Translation|polski]] |
||
* [[Spanish_Translation|hiszpański]] |
|||
Revision as of 09:58, 19 April 2024
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.
Strony Piaskownicy muszą być umieszczone w kategorii Piaskownica. Robi się to poprzez dodanie składni [[Category:Sandbox]]
na dole kodu wiki.
- 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
<translate>...</translate>
oraz wiele pojedynczych znaczników takich jak<!--T:8-->
. Te ostatnie oznaczają tzw. jednostki tłumaczeniowe i są tworzone przez system tłumaczeń, nigdy nie należy ich tworzyć ręcznie. Łą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.
Wytyczne ogólne
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, Plik → Zapisz, szablon dla klawiszy, które mają być wciśnięte, Shift, dla wyświetlania wartości logicznej, true
, 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 {{Page in progress}} lub {{UnfinishedDocu}}
jako pierwszą linię do strony. Z {{UnfinishedDocu}}
zapraszasz wszystkich do przyłączenia się i ukończenia strony, podczas gdy z {{Page in progress}} 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 dla 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 tytułach należy stosować wielką literę: każdy wyraz powinien zaczynać się wielką literą, chyba że są to przedimki, przyimki, spójniki lub inne formy gramatyczne (np. "of", "on", "in", "a", "an", "and").
- 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: XYZ Workbench
, gdzie XYZ
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: XYZ Command
, na przykład PartDesign Pad. Zwróć uwagę, że powinieneś używać nazwy polecenia tak, jak występuje ona w kodzie źródłowym.
Nagłówki
Nagłówki akapitów powinny być krótkie i zawierać wielkie litery: wszystkie wyrazy, z wyjątkiem pierwszego i nazw własnych, powinny być pisane małymi literami. Nie należy używać nagłówków H1
(= Heading =
) w znacznikach Wiki, ponieważ tytuł strony jest automatycznie dodawany jako główny nagłówek H1
.
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:
[[Name_of_Page|Name of Page]]
przetłumaczone:
[[Nazwa_Strony/pl|Nazwa Strony]]
Zauważ, że w przypadku części przed znakiem |
istotny jest faktyczny link, wielkość liter. Jeśli nazwa Twojej strony to Name_of_page
, link nie powiedzie się, jeśli wpiszesz Name_of_Page
(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:
[[WikiPages#Links|WikiPages]]
przetłumaczone:
[[WikiPages/pl#Odnośniki|Strona Wiki]]
W obrębie tej samej strony możesz pominąć nazwę strony. Przykład:
[[#Links|Links]]
Aby przejść do górnej części strony możesz użyć:
</translate>{{Top}}<translate>
Szablon ten powinien automatycznie wyświetlać poprawny tekst w zależności od tego w jakim języku dana strona jest napisana. Link do góry strony jest szczególnie przydatny w przypadku długich stron, ponieważ pozwala użytkownikowi szybko przeskoczyć z powrotem do spisu treści. Możesz go umieścić na końcu każdego akapitu. Upewnij się, że przed i po szablonie znajduje się pusta linia.
Aby użyć obrazka jako odsyłacza:
[[Image:Draft_Wire.svg|24px|Opcjonalny tekst, który jest wyświetlany po najechaniu kursorem na obszar obrazka|link=Draft_Wire/pl]]
- Link do obrazu + link tekstowy
Polilinia
Jeśli pominiesz opcjonalny tekst, sam link zostanie wyświetlony po najechaniu kursorem myszki na obraz, co jest lepszym rozwiązaniem, a także powinieneś dodać link tekstowy po linku do obrazka:
[[Image:Draft_Wire.svg|24px|link=Draft_Wire/pl]] [[Draft_Wire/pl|Polilinia]]
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.
Szablon | Wygląd | Opis |
---|---|---|
Top | Użyj go, aby dodać link na początek strony. | |
Emphasis | zaakcentowanie | Użyj go do zaakcentowania fragmentu tekstu. |
KEY | Alt | Użyj go do wskazania klawisza klawiatury, który należy nacisnąć. |
ASCII | Użyj go do wskazania klawisza ascii w obrazie (.svg), który musi zostać naciśnięty. Należy wprowadzić żądany znak lub numer kodu ascii tego znaku. | |
Button | Anuluj | Użyj go do wskazania przycisku w graficznym interfejsie użytkownika, który należy nacisnąć. |
RadioButton | Użyj go, aby wskazać przycisk wyboru w graficznym interfejsie użytkownika, który należy | |
CheckBox | Użyj go, aby wskazać pole wyboru w graficznym interfejsie użytkownika, które należy | |
SpinBox | 1.50 |
Użyj go do wskazania pola wyboru w graficznym interfejsie użytkownika, które ma zostać zmodyfikowane. |
ComboBox | Menu 1 |
Użyj go do wskazania pola listy wyboru w graficznym interfejsie użytkownika, które należy zmienić. |
LineEdit | Metal Nikiel (Ni) | Służy do wskazywania Linii Edycji w graficznym interfejsie użytkownika, która wymaga modyfikacji. |
FALSE, False | FAŁSZ , Fałsz
|
Użyj go, aby wskazać wartość logiczną False, na przykład, jako właściwość w Edytorze właściwości. To jest skrót. Ponieważ jest to wartość, wywołanego szablonu Value. False
|
TRUE, True | PRAWDA , Prawda
|
Użyj go, aby wskazać wartość logiczną True, na przykład, jako właściwość w Edytorze właściwości. To jest skrót. Ponieważ jest to wartość, wywołanego szablonu Value. true
|
MenuCommand | Plik → Zapisz | Użyj go do wskazania lokalizacji polecenia wewnątrz danego menu. |
FileName | Nazwa pliku | Użyj go do wskazania nazwy pliku lub katalogu. |
SystemInput | Wprowadź ten tekst | Użyj go do wprowadzenia tekstu wejściowego, wprowadzonego przez użytkownika. |
SystemOutput | Tekst wyjściowy | Użyj go do wskazania tekstu wychodzącego z systemu. |
Incode | import FreeCAD
|
Użyj go, aby dołączyć kod źródłowy w wierszu z czcionką o stałej szerokości. Powinien zmieścić się w jednej linii. |
PropertyView | WIDOKKolor | Użyj go, aby wskazać właściwość widoku w Edytorze właściwości. Przykłady właściwości widoku to Kolor linii, Szerokość linii, Kolor punktu, Rozmiar punktu, itd. |
PropertyData | DANEPozycja | Użyj go, aby wskazać właściwość Data w Edytorze właściwości. Właściwości danych są różne dla różnych typów obiektów. |
Properties Title / TitleProperty | Podstawowe | Użyj go, aby wskazać nazwę grupy właściwości w Edytorze właściwości. Nazwa nie zostanie uwzględniona w automatycznym spisie treści. |
Obsolete | przestarzałe w wersji 0.19 | Użyj go, aby wskazać, że cecha stała się przestarzała w określonej wersji FreeCAD. |
Version | dostępne w wersji 0.18 | Użyj go, aby wskazać, że cecha została wprowadzona w określonej wersji FreeCAD. |
VersionMinus | wersja 0.16 i poniżej | Użyj go, aby wskazać, że cecha jest dostępna w określonej wersji FreeCAD i wcześniejszych wersjach. |
VersionPlus | wersja 0.17 i powyżej | Użyj go, aby wskazać, że cecha jest dostępna w określonej wersji FreeCAD i nowszych wersjach. |
ColoredText | Kolorowy tekst | Użyj tego szablonu do pokolorowania tła, tekstu lub tła i tekstu. (ColoredText - strona zawierająca więcej przykładów). |
ColoredParagraph | Kolorowy akapit
|
Użyj tego szablonu do pokolorowania tła, tekstu lub tła i tekstu całego akapitu. (ColoredParagraph strona dla więcej przykładów) |
Złożone szablony
Szablony te wymagają większej ilości parametrów wejściowych, lub generują blok tekstu o określonym formacie.
Szablon | Wygląd | Opis |
---|---|---|
Prettytable | Ta oto tabela | Użyj go do formatowania tabel, takich jak ta. Można dodać dodatkowe właściwości tabeli. |
Caption | Jakiś podpis do obrazka |
Użyj go, aby dodać wyjaśnienie pod obrazem. Możesz ustawić wyrównanie do lewej lub do środka. |
Clear | Użyj go do wyczyszczenia kolumn. Aby uzyskać szczegółowe wyjaśnienie, postępuj zgodnie z definicją szablonu. Jest on często używany do zatrzymania przepływu tekstu obok niepowiązanych obrazów. | |
Code | import FreeCAD
|
Użyj go, aby dołączyć wielowierszowe przykłady kodu z czcionką monospace. Domyślnym językiem jest Python, ale można podać inne języki.
Użyty kod Python powinien stosować się do ogólnych zaleceń ustanowionych przez PEP8: Style Guide for Python Code. W szczególności, nawiasy powinny następować bezpośrednio po nazwie funkcji, a spacja powinna następować po przecinku. Dzięki temu kod jest bardziej czytelny. |
CodeDownload | Użyj go, aby utworzyć link na stronie makrodefinicji. | |
Codeextralink | Temporary code for external macro link. Do not use this code. This code is used exclusively by Addon Manager. Link for optional manual installation: Macro # This code is copied instead of the original macro code # to guide the user to the online download page. # Use it if the code of the macro is larger than 64 KB and cannot be included in the wiki # or if the RAW code URL is somewhere else in the wiki. from PySide import QtGui, QtCore diag = QtGui.QMessageBox(QtGui.QMessageBox.Information, "Information", "This macro must be downloaded from this link\n" "\n" "https://wiki.freecad.org/Main_Page" + "\n" "\n" "Quit this window to access the download page") diag.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint) diag.setWindowModality(QtCore.Qt.ApplicationModal) diag.exec_() import webbrowser webbrowser.open("https://wiki.freecad.org/Main_Page") |
Użyj go, jeśli kod makrodefinicji jest zbyt duży, by umieścić go na Wiki. Kod może być hostowany gdzie indziej, a surowy link do niego może być określony za pomocą tego szablonu. Menedżer dodatków użyje tego linku. |
Fake heading | Użyj go, aby utworzyć nagłówek, który nie będzie automatycznie umieszczany w spisie treści. | |
GuiCommand | Zobacz Model polecenia GUI | Za jego pomocą można utworzyć pole z przydatnymi informacjami do dokumentowania poleceń (narzędzi) środowiska pracy. |
TutorialInfo | Zobacz przykład Poradnik: Podstawy modelowania | Użyj go do stworzenia ramki z przydatnymi informacjami, aby udokumentować Poradniki. |
Macro | Zobacz przykład Macro FlattenWire | Użyj go do stworzenia ramki z przydatnymi informacjami, aby udokumentować makrodefinicje. |
Docnav | Użyj go, aby utworzyć pasek ze strzałkami i odpowiednimi linkami, który jest przydatny do umieszczania stron w określonej kolejności. | |
VeryImportantMessage | Ważny komunikat
|
Użyj go, aby utworzyć wyróżnione pole z bardzo ważną wiadomością. Używaj rzadko, tylko do wskazania poważnych problemów w funkcjonalności oprogramowania, zaprzestania używania narzędzi itp. |
Page in progress | Użyj tego dla stron, które są w trakcie tworzenia lub które są obecnie przerabiane. Nie zapomnij usunąć tej opcji, gdy strona będzie gotowa. | |
UnfinishedDocu | This documentation is not finished. Please help and contribute documentation. GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands. See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute. |
Użyj go, aby utworzyć podświetlone pole wskazujące niedokończoną stronę dokumentacji. |
Softredirect | Użyj go zamiast normalnego przekierowania, gdy przekierowujesz na specjalną stronę (taką jak Media: lub Kategoria:), w których to przypadkach normalne przekierowanie jest wyłączone. | |
Quote |
|
Użyj go, aby utworzyć pole tekstu z dosłownym cytatem i odniesieniem. |
Userdocnavi, | Użyj ich do stworzenia okien nawigacyjnych dla dokumentacji użytkownika, dokumentacji użytkownika zaawansowanych funkcji oraz dokumentacji programisty. Pozwala to na szybkie przeskakiwanie pomiędzy różnymi sekcjami dokumentacji. Umieszczają one również odpowiednią stronę we właściwej kategorii. |
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 _example
na końcu. Na przykład dla polecenia Draft Offset obrazek powinien mieć nazwę Draft_Offset_example.png
.
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.
Kilka wskazówek dla tłumaczy
Tłumaczenie komend Gui
{{GuiCommand |Name=FEM EquationFlux |MenuLocation=Solve → Flux equation |Workbenches=[[FEM_Workbench|FEM]] |Shortcut={{KEY|F}} {{KEY|S}} |Version=0.17 |SeeAlso=[[FEM_tutorial|FEM tutorial]] }}
przetłumaczone:
{{GuiCommand/fr |Name=FEM EquationFlux |Name/fr=FEM Équation d'écoulement |MenuLocation=Solveur → Équation de flux |Workbenches=[[FEM_Workbench/fr|Atelier FEM]] |Shortcut={{KEY|F}} {{KEY|S}} |Version=0.17 |SeeAlso=[[FEM_tutorial/fr|FEM Tutoriel]] }}
Ustawienia szablonu
{{FEM_Tools_navi}}
przetłumaczone:
{{FEM_Tools_navi/fr}}
Tłumaczenie odnośnika
[[Part_Module|Part Module]]
przetłumaczone:
[[Part_Module/fr|Atelier Part]]
{{Docnav |[[About_FreeCAD|About FreeCAD]] |[[Installing_on_Windows|Installing on Windows]] }}
przetłumaczone:
{{Docnav/fr |[[About_FreeCAD/fr|À propos de FreeCAD]] |[[Installing_on_Windows/fr|Installation sous Windows]] }}
Przykład z ikonami:
{{Docnav |[[Std_Save|Save]] |[[Std_SaveCopy|SaveCopy]] |[[Std_File_Menu|Std File Menu]] |IconL=Std_Save.svg |IconR=Std_SaveCopy.svg |IconC=Freecad.svg }}
przetłumaczone:
{{Docnav/fr |[[Std_Save/fr|Enregistrer]] |[[Std_SaveCopy/fr|Enregistrer une copie]] |[[Std_File_Menu/fr|Menu fichier]] |IconL=Std_Save.svg |IconR=Std_SaveCopy.svg |IconC=Freecad.svg }}
Tworzenie, zmiana nazwy i usuwanie strony
Tworzenie stron
Przed utworzeniem nowej strony powinieneś najpierw sprawdzić, czy podobna strona już istnieje. Jeśli tak, to zazwyczaj lepiej jest edytować istniejącą stronę. W razie wątpliwości najpierw otwórz temat na forum w dziale Wiki forum.
Aby utworzyć nową stronę wykonaj jedną z poniższych czynności:
- Odwiedź adres URL z żądaną nazwą strony, na przykład:
https://wiki.freecadweb.org/Moja_Nowa_Strona
, i kliknij na przycisk utwórz tą stronę. - Wyszukaj w Wiki nazwę strony i kliknij na czerwony tekst w Utwórz stronę Moja Nowa Strona w tej Wiki!'.
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ę (https://www.freecadweb.org/wiki/File:***.***
) i edytuj ją. Nie ważne czy strona jest pusta czy nie, dodaj to jako pierwszy element: {{Delete}}
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.
Terminologia - Zasady nazewnictwa
Angielski
Zobacz Słownik