WikiPages/pl: Difference between revisions

From FreeCAD Documentation
No edit summary
No edit summary
Tag: Manual revert
 
(303 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<languages/>
<languages/>

[[Category:Documentation{{#translation:}}]]
[[Category:Wiki{{#translation:}}]]
[[Category:Wiki Documentation{{#translation:}}]]
[[Category:Administration{{#translation:}}]]
{{TOCright}}
{{TOCright}}
Ta strona jest rozszerzeniem strony [[Help:Editing|Help: Editing]] i zawiera wspólne wytyczne dotyczące najlepszych praktyk, których należy przestrzegać podczas pisania lub aktualizacji dokumentacji FreeCAD. Podsumowuje ona dyskusje i burze mózgów w odniesieniu do dokumentacji FreeCAD.


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.
W przypadku obrazu możesz użyć [[Macro_Snip|Makra Snip]] [[Image: Snip.png | 24px]] do pobrania obrazu w wybranym oknie lub [[Macro_Screen_Wiki | Makra Screen Wiki]] [[Image: Macro_Screen_Wiki.png | 24px]] i utwórz obraz w standardowym formacie, obraz obrotowy lub ekran zapisany w serii. Możesz go złożyć za pomocą programu Gimp lub innego, aby utworzyć jeden plik animowany '''Gif'''.


<span id="Before_starting"></span>
==Zanim rozpoczniesz pracę==
==Zanim rozpoczniesz pracę==

*Ta dokumentacja wiki jest oparta na [https://www.mediawiki.org/wiki/MediaWiki MediaWiki], tym samym oprogramowaniu, które zasila [https://en.wikipedia.org/wiki/Main_Page Wikipedię]. Jeśli już wcześniej brałeś udział w Wikipedii, edycja stron wiki FreeCAD powinna być łatwa.
*Ta dokumentacja wiki jest oparta na [https://www.mediawiki.org/wiki/MediaWiki MediaWiki], tym samym oprogramowaniu, które zasila [https://en.wikipedia.org/wiki/Main_Page 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 [http://forum.freecadweb.org/viewtopic.php?f=21&t=6830 forum].
*W przeciwieństwie do Wikipedii, wiki FreeCAD jest zabezpieczona przed pisaniem, aby uniknąć spamu. Musisz poprosić o utworzenie konta na [http://forum.freecadweb.org/viewtopic.php?f=21&t=6830 forum].
Line 17: Line 13:
*Chcemy, aby dokumentacja była przejrzysta i łatwa do odczytania, więc unikaj używania skomplikowanych funkcji. Utrzymuj ją w formie prostej.
*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]].
*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 <code><nowiki>[[Category:Sandbox]]</nowiki></code> 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. To jest jak trzeci wymiar: każda strona może istnieć w wielu wersjach językowych.
** Na wielu stronach zobaczysz tagi takie jak <code><nowiki><translate>...</translate></nowiki></code> i wiele pojedynczych tagów takich jak ten <code><nowiki><!--T:8--></nowiki></code> w wielu sekcjach. Te pierwsze umożliwiają obsługę tłumaczeń. Nie należy ich zmieniać. Te drugie tworzone przez system. Łączą one nagłówki/paragrafy z ich przetłumaczonymi wersjami. Jeśli zmienisz numerację, oczywiście zniszczysz te linki. Można jednak przenosić akapity lub zmieniać ich treść tak długo, jak długo pozostają przy nich znaczniki. Jeśli usuniesz akapit, powinieneś usunąć tag z nim. Należy pamiętać, że zmiany w istniejących nagłówkach i akapitach mogą mieć wpływ na aktualne tłumaczenia. Twoje zmiany powinny być tego warte. Nie martw się przy dodawaniu nowego materiału, ponieważ system będzie automatycznie dodawał nowe tagi po Twoich edycjach. Więcej informacji można znaleźć w sekcji [[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>&lt;translate&gt;...&lt;/translate&gt;</code> oraz wiele pojedynczych znaczników takich jak <code>&lt;!--T:8--&gt;</code>. Te ostatnie oznaczają tzw. jednostki tłumaczeniowe i 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===
Opisując funkcjonalność FreeCAD należy starać się być zwięzłym i maksymalnie rzeczowym. Opisz co FreeCAD ''robi'', a nie czego FreeCAD ''nie robi''. Mogą istnieć wyjątki uzasadniające dlaczego FreeCAD nie wspiera określonej funkcjonalności, na przykład, aby wyjaśnić jak bardzo FreeCAD różni się od innych systemów CAD.


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_Workbench/pl|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_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===

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.
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 ''([[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]].
Do not use transclusion of pages ([[Help:Editing#Templates and transcluding pages|Help:Editing#Templates and transcluding pages]]), as this makes the wiki difficult to translate. Use only the templates described below in [[#Style|#Templates]].


===Styling===
<span id="Styling"></span>
===Stylizacja===
Templates are used for styling the text used in the help pages.


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.
There is a template for styling menu commands, like {{MenuCommand|File → Save}}, another template to style keys to be pressed, like {{KEY|Shift}}, another template to show a Boolean value {{TRUE}}, etc. This allows the documentation to have a consistent look and feel, as well as being able to be translated without much effort. Please get familiar with the [[#Style|#Templates]] section before writing help pages.


<span id="Temporary_flags"></span>
===Temporary Flags===
===Flagi tymczasowe===
If you are working on a large page it is advised that you mark the page either as work-in-progress or as unfinished. This assures that the Wiki admins don't mark your page as ready for translation while you are still frequently change it.


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.
To flag a page, simply add either '''<nowiki>{{Page in progress}}</nowiki>''' or '''<nowiki>{{UnfinishedDocu}}</nowiki>''' as first line to a page. With '''<nowiki>{{UnfinishedDocu}}</nowiki>''' you invite everybody to join and finish the page while with '''<nowiki>{{Page in progress}}</nowiki>''' you will do the work and others should give you some time.


Aby oznaczyć stronę, po prostu dodaj albo '''<nowiki>{{Page in progress}}</nowiki>''' lub '''<code><nowiki>{{UnfinishedDocu}}</nowiki></code>''' jako pierwszą linię do strony. Z '''<code><nowiki>{{UnfinishedDocu}}</nowiki></code>''' zapraszasz wszystkich do przyłączenia się i ukończenia strony, podczas gdy z '''<nowiki>{{Page in progress}}</nowiki>''' możesz wykonać pracę, a inni powinni dać ci trochę czasu.
Once the work is done, please don't forget to remove the flags!


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


<span id="Examples"></span>
You can quickly get familiar with the structure and style of the FreeCAD wiki by looking at the following pages, which can be considered reference pages for the rest of the FreeCAD documentation.
==Przykłady==
* [[Draft ShapeString]]

* [[Draft Line]]
Aby szybko zapoznać się ze strukturą i stylem Wiki dla FreeCAD zajrzyj na stronę modelu:
[[GuiCommand_model/pl|GuiCommand model]].


<div class="mw-collapsible mw-collapsed toccolours">
<div class="mw-collapsible mw-collapsed toccolours">

==Structure==
<span id="Structure"></span>
==Struktura==
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
[[User_hub/pl|Centrum użytkownika]] zapewnia [[Online_Help_Toc/pl|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.
===General===
You should normally not use a '''=header=''' section for a page, since the page title is automatically added.


Szablon [[Template:Docnav]] jest używany do sekwencyjnego linkowania stron, zgodnie ze strukturą [[Online_Help_Toc/pl|Spisu treści pomocy online]].
The [[User hub|User hub]] provides a [[Online Help Toc|Table of Contents]]; this is used as the main reference for automatically building the offline help you can reach from FreeCAD, as well as the offline PDF documentation.
Lista wszystkich szablonów znajduje się w sekcji [[#Szablony|Szablony]].


<span id="Page_names"></span>
The [[Template:Docnav]] is used to link to the page before and the page after, according to the structure of the [[Online Help Toc|Table of Contents]].
===Nazwy stron===
See [[#Templates|#Templates]] for a list of all templates.


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")''.
===Page names===
Page names should be short, and they should use "sentence case", as opposed to "title case". This is the [https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Capital_letters#Headings,_headers,_and_captions style used by Wikipedia] for their articles.


; Niewłaściwa nazwa strony:
Essentially, all words except the first one and proper names, should be in lowercase.
: Budowa samolotów AeroCompany


; Prawidłowa nazwa strony:
:{{emphasis|Use:}} Tutorial on the construction of AeroCompany airplanes
:{{emphasis|Avoid:}} Tutorial On The Construction Of AeroCompany Airplanes
: Budowa Samolotów AeroCompany


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.
{{emphasis|Note:}} a previous convention was to use title case; every word should begin with a capital letter, unless they are articles, prepositions, conjunctions, or other grammatical particles, that is, "of, on, in, a, an, and", etc. There are many pages using this style, but this is discouraged for new pages. This is discussed in the forum thread [https://forum.freecadweb.org/viewtopic.php?p=266029#p266029 (Lowercase links) Use a lower case title for a wiki page].


<span id="Headings"></span>
====Page names for workbench and tools====
===Nagłówki===
The top level workbench page must have the format '''XYZ Workbench''', where '''XYZ''' is the name of the workbench. See [[WikiPages#Workbench_pages|Workbench pages]] for the content.


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>=&nbsp;Heading&nbsp;=</nowiki></code>) w znacznikach Wiki, ponieważ tytuł strony jest automatycznie dodawany jako główny nagłówek <code><nowiki>H1</nowiki></code>.
Pages describing the tools ([[Gui Command|Gui Command]]s) of the workbench must have the format '''XYZ Tool''', where '''Tool''' is the name of the specific tool. See [[WikiPages#Command_.28tool.29_pages|Command (tool) pages]] for the content.


<span id="Links"></span>
; Bad name
===Odnośniki internetowe===
:[[Working with architectural objects|Working with architectural objects]]
:[[Working with architectural walls|Working with architectural walls]]
:[[Drafting 2D objects|Drafting 2D objects]]
:[[Tool: building a line between two points|Tool: building a line between two points]]


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.
; Good name
:[[Arch Workbench|Arch Workbench]]
:[[Arch Wall|Arch Wall]]
:[[Draft Workbench|Draft Workbench]]
:[[Draft Line|Draft Line]]


; Nieprawidłowy link
===Links===
: Aby uzyskać więcej informacji na temat rysowania obiektów 2D kliknij [[Draft_Workbench/pl|tutaj]].
You should use the original link name for the links whenever possible. This clarifies the referenced page in printed or offline documentation. You must avoid the usage of non-meaningful words for the link.


;Bad link
; Prawidłowy link
: Więcej informacji na temat rysowania obiektów 2D można znaleźć w Środowisku pracy [[Draft_Workbench/pl|Rysunek roboczy]].
: For more information on this topic, click [[Draft Workbench|here]].


Preferowany format linku to:
;So-so link
: For more information on this topic, refer to [[Draft Workbench|drafting 2D objects]].


<code><nowiki>[[Name_of_Page|Name of Page]]</nowiki></code>
;Good link
: For more information on this topic, see how to draft 2D objects in the [[Draft Workbench|Draft Workbench]].


przetłumaczone:
==== Page navigation ====
Navigation links help the user to browse through the wealth of information in this wiki. Consider the use of following to make browsing more fun to the reader:


<code><nowiki>[[Nazwa_Strony/pl|Nazwa Strony]]</nowiki></code>
* "[[#top|top]]" links. For long pages, you could go back to the table of contents.
* "back" links. This allows to get back to a certain issue. A back link is much ore useful than the browsers "back" button because it contains structural information. A backlink could lead you up one stage on the hierarchy of information. For example see the [[External Workbenches#General|External Workbenches]]: from whereever you arrive an a page about an external workbench you might want to see what other workbenches are available.


Zauważ, że w przypadku części przed znakiem <code><nowiki>|</nowiki> </code> istotny jest faktyczny link, wielkość liter. Jeśli nazwa Twojej strony to <code><nowiki>Name_of_page</nowiki> </code>, link nie powiedzie się, jeśli wpiszesz <code><nowiki>Name_of_Page</nowiki> </code> ''(wielka litera P)''. Przed znakiem <code><nowiki>|</nowiki> </code> wszystkie spacje należy zastąpić podkreśleniami (<code> <nowiki> _ </nowiki> </code>). 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.
See the next section on how to do these links.


Aby połączyć się z konkretnym akapitem, dodaj do nazwy strony znak <code><nowiki>#</nowiki></code> i jego nagłówek. Przykład:
===== Top Page Links =====
Just use type the following at the place where you want the top link.


<nowiki>[[#top|top]]</nowiki>
<code><nowiki>[[WikiPages#Links|WikiPages]]</nowiki></code>


przetłumaczone:
You could put it at the end of each chapter. Make sure to have an empty line before, so it stays free of the last paragraph.


<code><nowiki>[[WikiPages/pl#Odnośniki|Strona Wiki]]</nowiki></code>
:''Note 1: If you know the MediaWiki platform you might note that this works even without defining "top" as a link target using <nowiki><div></nowiki>. This only works of course if the "top" is not used for other things. ''
:''Note 2: Should you think that is useful you can just start to practice a bit by putting a "top" link at the end of every section of this really long page.''


W obrębie tej samej strony możesz pominąć nazwę strony. Przykład:
[[#top|na początek strony]]


<code><nowiki>[[#Links|Links]]</nowiki></code>
===== Back Links =====
For a back link you have 2 choices:
:* go back to the top of another page
:* go back to a certain section of another page
For the user it may be more convenient to get right to the relevant section of a page, e.g. a list of similar items.


Aby przejść do górnej części strony możesz użyć:
The general format of a link is


<nowiki>[[pagename|pagename]]</nowiki>
<code><nowiki>&lt;/translate&gt;{{Top}}&lt;translate&gt;</nowiki></code>


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.
For translate this line:


; Link do obrazu
<nowiki>[[pagename/fr|nom de la page]]</nowiki>
: [[Image:Draft_Wire.svg|24px|Opcjonalny tekst, który jest wyświetlany po najechaniu kursorem na obszar obrazka|link=Draft_Wire/pl]].


Aby użyć obrazka jako odsyłacza:
For this page it would be <code><nowiki>[[WikiPages|WikiPages]]</nowiki></code>. Note that the case is relevant. If your page name is "WikiPages" the link will fail if you type "Wikipages" (lower case 'p'). Best practice is to open the page in another tab and copy & paste the page name.


<code><nowiki>[[Image:Draft_Wire.svg|24px|Opcjonalny tekst, który jest wyświetlany po najechaniu kursorem na obszar obrazka|link=Draft_Wire/pl]]</nowiki></code>
To use a certain section as link target you just add the section name (i.e. the headline text) after a '#' sign behind the page name. Example:


; Link do obrazu + link tekstowy
<nowiki>[[WikiPages#Top Page Links]]</nowiki>
: [[Image:Draft_Wire.svg|24px|link=Draft_Wire/pl]] [[Draft_Wire/pl|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:
The result is a bit ugly, because of the '#' in [[WikiPages#Top Page Links]]. This can be avoided by using the '|' syntax to enter a label. See this example:


<nowiki>[[WikiPages#Top Page Links|WikiPages]]</nowiki>
<code><nowiki>[[Image:Draft_Wire.svg|24px|link=Draft_Wire/pl]] [[Draft_Wire/pl|Polilinia]]</nowiki></code>


<span id="Workbench_pages"></span>
Aby przetłumaczyć ten wiersz:
===Strony Środowisk pracy===


Strona najwyższego poziomu powinna zaczynać się od:
<nowiki>[[WikiPages/fr#Début|WikiPages début]]</nowiki>
* Opisu do czego służy dane środowisko pracy.
* Obrazka ilustrującego opis.


Zobacz sekcję [[#Zrzut_ekranu|#Zrzut ekranu]] dla rozwiązań dotyczących dołączania obrazów.
Instead of "WikiPages" you can put in any text you like. The result is much better: [[WikiPages#Top Page Links|WikiPages]] or [[WikiPages#Top Page Links|WikiPages/Top Page Links]] or whatever you like. Its a bit more to type in the source but thats a small price to pay for excellent usability. Within the same page you do the same but you can omit the page name, e.g. <code><nowiki>[[#Top Page Links|Top Page Links]]</nowiki></code> gives [[#Top Page Links|Top Page Links]].


<span id="Command_pages"></span>
===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.
[[#top|na początek strony]]


Proszę odnieść się do strony [[GuiCommand_model/pl|GuiCommand model]] po więcej szczegółów.
===Workbench pages===
Every page of a workbench should start with:
* the name of the workbench,
* an image of the look of the workbench (menu and toolbar in their default position), and
* a description of what the workbench is used for


<span id="Tutorials"></span>
See [[#Screen capture]] for conventions on including images.
===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.
===Command (tool) pages===
The command pages describing workbench tools should not be too long, they should only explain what a command can do and what it can't, and how to use it. You should keep pictures and examples to a minimum; tutorials can expand on how to use the tool and provide step-by-step details.


Przykłady można znaleźć na stronie [[Tutorials/pl|Poradniki]].
Limitations and shortcomings should be documented right in the command page, possibly under a "restrictions" or "limitations" section.
</div> <!-- End of collapsible element for Structure section. Do not remove! -->
</div> <!-- End of collapsible element for Structure section. Do not remove! -->


<div class="mw-collapsible mw-collapsed toccolours">
Please refer to the [[Gui Command|Gui Command]] page for specific indications on how these commands should be presented, and use the [[GuiCommand model|GuiCommand model]] to start filling the information where appropriate.
Use [[Boiler NonCommand|Boiler NonCommand]] to fill in information that is not related to a command.


<span id="Templates"></span>
===Tutorials===
==Szablony==
A well written tutorial should teach the user how to achieve certain practical results quickly.
<div class="mw-collapsible-content">
It shouldn't be extremely long, but it should include a sufficient amount of step-by-step instructions and pictures to guide the user on using different tools.
Stylizacja stron Wiki FreeCAD jest osiągana poprzez użycie ([[Help:Editing#Templates_and_transcluding_pages|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 [https://www.mediawiki.org/wiki/Help:Templates/pl Pomoc MediaWiki:Szablony] aby dowiedzieć się więcej.
A series of tutorials in which each increases in complexity could be helpful to explore basic, intermediate, and expert tools in one or more workbenches.


<span id="Simple_templates"></span>
See the [[tutorial_guidelines|tutorial guidelines]] for a basic idea on how to set up a tutorial.
===Proste szablony===


Szablony te przyjmują prosty parametr tekstowy i formatują go za pomocą określonego stylu.
See some examples
* [[Tutorials|Tutorials]], already written and accessible from the sidebar,
* [http://freecad-tutorial.blogspot.it FreeCAD tutorial - Unofficial tutorial blog], for other example tutorials.


{|{{Prettytable}}
As FreeCAD evolves, some tutorials may become too old for modern versions of the program, so it is important to mention the version or limitations of the tools used in that specific version of the tutorial.
!style="width:10%;"|Szablon
</div> <!-- End of collapsible element for Structure section. Do not remove! -->
!style="width:20%;"|Wygląd
</div> <!-- End of collapsible element for Structure section. Do not remove! -->
!style="width:70%;"|Opis


|--
<div class="mw-collapsible mw-collapsed toccolours"> <!-- Do not reomove. Start of collapsible element -->
|[[Template:Top|Top]]
|
{{Top}}
|Użyj go, aby dodać link na początek strony.


|--
== Language ==
|[[Template:Emphasis|Emphasis]]
<div class="mw-collapsible-content">
|{{Emphasis|zaakcentowanie}}
|Użyj go do zaakcentowania fragmentu tekstu.


|--
===Expressions===
|[[Template:KEY|KEY]]
You should avoid colloquial generic expressions as "a couple". Please re-phrase as "some" if an indeterminate number, or use the correct quantity.
|{{KEY|Alt}}
|Użyj go do wskazania klawisza klawiatury, który należy nacisnąć.


|--
===Conciseness===
|[[Template:ASCII|ASCII]]
Try to avoid repetitions to keep descriptions short.
|{{ASCII|A}}
|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.


|--
====Bad description====
|[[Template:Button|Button]]
|{{Button|Anuluj}}
|Użyj go do wskazania przycisku w graficznym interfejsie użytkownika, który należy nacisnąć.


|--
[[PartDesign Workbench|PartDesign Workbench]]: the PartDesign Workbench is a workbench for part design that aims to provide tools for modelling complex solid parts.
|[[Template:RadioButton|RadioButton]]
|{{RadioButton|Opcja}}
|Użyj go, aby wskazać przycisk wyboru w graficznym interfejsie użytkownika, który należy {{RadioButton|TRUE|Zaznaczyć}} lub {{RadioButton|FALSE|Nie}}.


|--
====Good description====
|[[Template:CheckBox|CheckBox]]
|{{CheckBox|Opcja}}
|Użyj go, aby wskazać pole wyboru w graficznym interfejsie użytkownika, które należy {{CheckBox|TRUE|wybrać}} lub {{CheckBox|FALSE|Nie}}.


|--
[[PartDesign Workbench|PartDesign Workbench]]: aims to provide tools for modelling complex solid parts.
|[[Template:SpinBox|SpinBox]]
</div> <!-- end of Language collapsible div. Do not remove! -->
|{{SpinBox|1.50}}
</div> <!-- end of Language collapsible div. Do not remove! -->
|Użyj go do wskazania pola wyboru w graficznym interfejsie użytkownika, które ma zostać zmodyfikowane.


|--
<div class="mw-collapsible mw-collapsed toccolours">
|[[Template:ComboBox|ComboBox]]
==Style==
|{{ComboBox|Menu 1}}
<div class="mw-collapsible-content">
|Użyj go do wskazania pola listy wyboru w graficznym interfejsie użytkownika, które należy zmienić.
===Templates===


|--
Styling of FreeCAD wiki pages is achieved through the usage of templates ([[Help:Editing#Templates_and_transcluding_pages]]). Please only use the templates listed in the tables below; doing this will allow re-styling the entire wiki by updating the template, and help achieve a standardized look and feel across all pages. Only for special cases should you use HTML tags directly.
|[[Template:LineEdit|LineEdit]]
|{{LineEdit|Metal Nikiel ''(Ni)''}}
|Służy do wskazywania Linii Edycji w graficznym interfejsie użytkownika, która wymaga modyfikacji.


|--
You can see the complete list of defined templates by accessing [[Special:PrefixIndex/Template:]]. However, not all templates listed there are used for styling the text, and others are deprecated; please use only the ones in the tables below.
|[[Template:FALSE|FALSE]], [[Template:False|False]]
|{{FALSE/pl}}, {{False/pl}}
|Użyj go, aby wskazać wartość logiczną False, na przykład, jako właściwość w [[Property_editor/pl|Edytorze właściwości]]. To jest skrót. Ponieważ jest to wartość, wywołanego szablonu [[Template:Value|Value]]. {{Value|False}}


|--
Click on the template link to see the usage instructions for the template, and to see its implementation. Templates are a powerful feature of the MediaWiki software; you should be an experienced wiki user if you wish to propose additions and modifications to existing templates. If implemented incorrectly, templates make it difficult to translate pages into other languages, so their use should be limited to text formatting; page transclusion should be avoided. See [https://www.mediawiki.org/wiki/Help:Templates MediaWiki Help:Templates] to learn more.
|[[Template:TRUE|TRUE]], [[Template:True|True]]
|{{TRUE/pl}}, {{true/pl}}
|Użyj go, aby wskazać wartość logiczną True, na przykład, jako właściwość w [[Property_editor/pl|Edytorze właściwości]]. To jest skrót. Ponieważ jest to wartość, wywołanego szablonu [[Template:Value|Value]]. {{Value|true}}


|--
====Simple styling templates ====
|[[Template:MenuCommand|MenuCommand]]
These templates accept a simple text parameter, and format it with a particular style.
|{{MenuCommand|Plik → Zapisz}}
{|{{Prettytable}}
|Użyj go do wskazania lokalizacji polecenia wewnątrz danego menu.
!Template

!Appearance
|--
!Description
|[[Template:FileName|FileName]]
|--
|{{FileName|Nazwa pliku}}
|[[Template:Emphasis|Emphasis]]
|Użyj go do wskazania nazwy pliku lub katalogu.
|{{Emphasis|emphasis}}

|Use it to emphasize a piece of text.
|--
|--
|[[Template:KEY|KEY]]
|[[Template:SystemInput|SystemInput]]
|{{SystemInput|Wprowadź ten tekst}}
|{{KEY|Alt}}
|Użyj go do wprowadzenia tekstu wejściowego, wprowadzonego przez użytkownika.
|Use it to indicate a keyboard key that needs to be pressed.

|--
|--
|[[Template:ASCII|ASCII]]
|[[Template:SystemOutput|SystemOutput]]
|{{ASCII|A}}
|{{SystemOutput|Tekst wyjściowy}}
|Use it to indicate a ascii key in a image (.svg) that needs to be pressed. You must give the character desired or the number of the code ascii of the character.
|Użyj go do wskazania tekstu wychodzącego z systemu.
|--

|[[Template:Button|Button]]
|--
|{{Button|Cancel}}
|[[Template:Incode|Incode]]
|Use it to indicate a button in the graphical user interface that needs to be pressed.
|{{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.
|[[Template:RadioButton|RadioButton]]

|{{RadioButton|Cancel}}
|--
|Use it to indicate a radio button in the graphical user interface that needs to be {{RadioButton|TRUE|Checked}} or {{RadioButton|FALSE|not Checked}}.
|[[Template:PropertyView|PropertyView]]
|--
|{{PropertyView/pl|Kolor}}
|[[Template:CheckBox|CheckBox]]
|Użyj go, aby wskazać właściwość widoku w [[Property_editor/pl|Edytorze właściwości]]. Przykłady właściwości widoku to {{emphasis|Kolor linii}}, {{emphasis|Szerokość linii}}, {{emphasis|Kolor punktu}}, {{emphasis|Rozmiar punktu}}, itd.
|{{CheckBox|Cancel}}

|Use it to indicate a checkbox in the graphical user interface that needs to be {{CheckBox|TRUE|Checked}} or {{CheckBox|FALSE|not Checked}}.
|--
|--
|[[Template:SpinBox|SpinBox]]
|[[Template:PropertyData|PropertyData]]
|{{SpinBox|1.50}}
|{{PropertyData/pl|Pozycja}}
|Użyj go, aby wskazać właściwość Data w [[Property_editor/pl|Edytorze właściwości]]. Właściwości danych są różne dla różnych typów obiektów.
|Use it to indicate a spinbox in the graphical user interface that needs to be modified.

|--
|--
|[[Template:ComboBox|ComboBox]]
|[[Template:Properties Title|Properties Title]] / [[Template:TitleProperty|TitleProperty]]
|{{ComboBox|Menu 1}}
|{{Properties_Title|Podstawowe}}
|Use it to indicate a ComboBox in the graphical user interface that needs to be modified.
|Użyj go, aby wskazać nazwę grupy właściwości w [[Property_editor/pl|Edytorze właściwości]]. Nazwa nie zostanie uwzględniona w automatycznym spisie treści.
|--

|[[Template:FALSE|FALSE]], [[Template:false|false]]
|--
|{{FALSE}}, {{false}}
|[[Template:Obsolete|Obsolete]]
|Use it to indicate a False Boolean value, for example, as a property in the [[property editor|property editor]]. This is a shortcut. Since it is a value, prefer Template [[Template:Value|Value]] {{Value|false}}
|{{Obsolete/pl|0.19}}
|--
|Użyj go, aby wskazać, że cecha stała się przestarzała w określonej wersji FreeCAD.
|[[Template:TRUE|TRUE]], [[Template:true|true]]

|{{TRUE}}, {{true}}
|--
|Use it to indicate a True Boolean value, for example, as a property in the [[property editor|property editor]]. This is a shortcut. Since it is a value, prefer Template [[Template:Value|Value]] {{Value|true}}
|[[Template:Version|Version]]
|--
|{{Version/pl|0.18}}
|[[Template:MenuCommand|MenuCommand]]
|Użyj go, aby wskazać, że cecha została wprowadzona w określonej wersji FreeCAD.
|{{MenuCommand|File → Save}}

|Use it to indicate the location of a command inside a particular menu.
|--
|--
|[[Template:FileName|FileName]]
|[[Template:VersionMinus|VersionMinus]]
|{{VersionMinus/pl|0.16}}
|{{FileName|File name}}
|Użyj go, aby wskazać, że cecha jest dostępna w określonej wersji FreeCAD i wcześniejszych wersjach.
|Use it to indicate a name of a file or directory.

|--
|--
|[[Template:SystemInput|SystemInput]]
|[[Template:VersionPlus|VersionPlus]]
|{{SystemInput|Type this text}}
|{{VersionPlus/pl|0.17}}
|Use it to indicate user typed input text.
|Użyj go, aby wskazać, że cecha jest dostępna w określonej wersji FreeCAD i nowszych wersjach.
|--

|[[Template:SystemOutput|SystemOutput]]
|--
|{{SystemOutput|Output text}}
|[[Template:ColoredText|ColoredText]]
|Use it to indicate text output from the system.
|{{ColoredText|Kolorowy tekst}}
|--
|Użyj tego szablonu do pokolorowania tła, tekstu lub tła i tekstu. ''([[Template:ColoredText|ColoredText]] - strona zawierająca więcej przykładów)''.
|[[Template:Optional|Optional]]

|{{Optional|Insert or not}}
|--
|Use it in programming descriptions to indicate a text or function argument that is optional.
|[[Template:ColoredParagraph|ColoredParagraph]]
|--
|{{ColoredParagraph|Kolorowy akapit}}
|[[Template:Choice|Choice]]
|Użyj tego szablonu do pokolorowania tła, tekstu lub tła i tekstu całego akapitu. ''([[Template:ColoredParagraph|ColoredParagraph]] strona dla więcej przykładów)''
|{{Choice|This|That}}
|Use it in programming descriptions to indicate a choice between two values.
|--
|[[Template:Incode|Incode]]
|{{incode|import FreeCAD}}
|Use it to include in-line source code with a monospace font. It should fit in one line.
|--
|[[Template:Variable|Variable]]
|{{Variable|MyAttribute|TYPE}}
|Use it in programming descriptions to indicate a value or a parameter, optionally with a type in front of it.
|--
|[[Template:PropertyView|PropertyView]]
|{{PropertyView|Color}}
|Use it to indicate a View property in the [[property editor|property editor]]. View properties are like {{emphasis|Line Color}}, {{emphasis|Line Width}}, {{emphasis|Point Color}}, {{emphasis|Point Size}}, etc.
|--
|[[Template:PropertyData|PropertyData]]
|{{PropertyData|Position}}
|Use it to indicate a Data property in the [[property editor|property editor]]. Data properties are different for different types of objects.
|--
|[[Template:Properties Title|Properties Title]] / [[Template:TitleProperty|TitleProperty]]
|{{Properties_Title|Base}}
|Use it to indicate the title of a property group in the [[property editor|property editor]]. The title will not be included in the automatic table of contents.
|--
|[[Template:PropertyTasks|PropertyTasks]] / [[Template:TasksTag|TasksTag]]
|{{PropertyTasks|Tasks}}
|Use it to indicate the argument for tasks.
|--
|[[Template:TitleTasks|TitleTasks]]
|{{TitleTasks|Tasks Title}}
|Use it to indicate the title for tasks.
|--
|[[Template:Version|Version]]
|{{Version|0.18}}
|Use it to indicate that a particular feature is available only starting with a specific FreeCAD version.
|--
|[[Template:VersionMinus|VersionMinus]]
|{{VersionMinus|0.16}}
|Use it to indicate that a particular feature is below starting with a specific FreeCAD version.
|--
|[[Template:VersionPlus|VersionPlus]]
|{{VersionPlus|0.17}}
|Use it to indicate that a particular feature is above starting with a specific FreeCAD version.
|--
|[[Template:Obsolete|Obsolete]]
|{{Obsolete|0.19}}
|Use it to indicate that a particular feature is obsolete starting with a specific FreeCAD version.
|--
|[[Template:ColoredText|ColoredText]]
|{{ColoredText|Colored Text}}
|Use this template to colored the background, text or background and text. ([[Template:ColoredText|ColoredText]] page for more examples)
|--
|[[Template:ColoredParagraph|ColoredParagraph]]
|{{ColoredParagraph|Colored Paragraph}}
|Use this template to colored the background, text or background and text along the entire length of the page. ([[Template:ColoredParagraph|ColoredParagraph]] page for more examples)
|}
|}


<span id="Complex_templates"></span>
====More complex templates ====
===Złożone szablony===
These templates require more input parameters, or produce a block of text with a particular format.

{|{{Prettytable}}
Szablony te wymagają większej ilości parametrów wejściowych, lub generują blok tekstu o określonym formacie.
!Template
!Appearance
!Description
|--
|[[Template:Prettytable|Prettytable]]
|This table
|Use it to format tables such as this one; additional table properties can be added.
|--
|[[Template:Caption|Caption]]
|{{Caption|Some caption for an image}} {{Caption|align=center|Some caption for an image (centered)}}
|Use it to indicate an explanation text below an image in the documentation and tutorials. It can be left aligned or center aligned.
|--
|[[Template:Clear|Clear]]
|
|Use it to clear columns. Follow the definition of the template for a detailed explanation. It is often used to stop text from flowing next to unrelated images.
|--
|[[Template:Code|Code]]
|{{Code|code=import FreeCAD}}
|Source code style. Use it to include multi-line code examples with a monospace font. The default language is Python, bur other languages can be specified.
|--
|[[Template:Fake heading|Fake heading]]
|{{Fake heading|Heading|2}}
|Use it to create create a heading that will not be included automatically in the table of contents that is used for the offline documentation.
|--
|[[Template:GuiCommand|GuiCommand]]
|See [[Gui Command|Gui Command]] and [[GuiCommand model|GuiCommand model]]
|Use it to create a box with useful information to document workbench tools (GuiCommands) of FreeCAD.
|--
|[[Template:Macro|Macro]]
|See example [[Macro FlattenWire|Macro FlattenWire]]
|Use it to create a box with useful information to document [[macros|macros]].
|--
|[[Template:Docnav|Docnav]]
|{{Docnav|Online Help Startpage|Feature list}}
|Use it to create a bar with the words "next", "previous", and "index", and links to the appropriate articles, which is useful for navigating certain help pages which go in a particular sequence.
|--
|[[Template:VeryImportantMessage|VeryImportantMessage]]
|{{VeryImportantMessage|Important Message}}
|Use it to create a highlighted box with a very important message. Use sparingly, only to indicate major problems in the functionality of the software, discontinuation of tools, and similar.
|--
|[[Template:Softredirect|Softredirect]]
|
|Use it instead of the normal redirect, when you are redirecting to a special page (such as Media: or Category:), in which cases the normal redirect is disabled.
|--
|[[Template:UnfinishedDocu|UnfinishedDocu]]
|{{UnfinishedDocu}}
|Use it to create a highlighted box indicating an unfinished documentation page.
|--
|[[Template:Quote|Quote]]
|{{Quote|text=Cry "Havoc" and let slip the dogs of war.|sign=William Shakespeare|source=''Julius Caesar'', act III, scene I}}
|Use it to create a box of text with a literal quote and reference.
|--
|[[Template:Userdocnavi|Userdocnavi]], [[Template:Powerdocnavi|Powerdocnavi]], [[Template:Devdocnavi|Devdocnavi]]
|
|Use them to create navigation boxes for the user documentation, the power user documentation, and the developer documentation. This allows quickly jumping between different sections of the documentation.
They also place the corresponding page in the proper category.
{{Emphasis|(2019) Currently the Userdocnavi is the most used, while the others aren't used. It's a work in progress to design them correctly, and add them to all documentation pages.}}
|}


===Deprecated templates===
{|{{Prettytable}}
{|{{Prettytable}}
!style="width:10%;"|Szablon
!Template
!style="width:45%;"|Wygląd
!Appearance
!style="width:45%;"|Opis
!Description
|--
|Click
|'''Deprecated'''
|Use it to superimpose an invisible link on an image. You should use the native wiki picture inclusion method instead.
|--
|DASH
|'''Deprecated'''
|Use it to show a multi-line text box for code, with colorful background. You should use the style you obtain starting the source line with a space.
|--
|Disambig
|'''Deprecated'''
|Use it a disambiguation message in a page.
|--
|Information
|'''Deprecated'''
|Use it to create a standardized table providing complete information about the file, including description of what it shows and how it was made, copyright status and source.
|--
|Languages
|'''Deprecated'''
|Use it to show available translations. It's been obsoleted with the new wiki, which handles translations and languages via a dedicated plugin.
|--
|Message
|'''Deprecated'''
|Use it show a block of text with a colorful background, to indicate a message of low importance.
|--
|Screenshot
|'''Deprecated'''
|Use it to insert screenshots of the software. See [[#Screen capture]] instead.
|}


|--
To have a global view on the chromatic aspect, see [[WikiPagesBasicColors|Basic Graphic Template]].
|[[Template:Prettytable|Prettytable]]
|Ta oto tabela
|Użyj go do formatowania tabel, takich jak ta. Można dodać dodatkowe właściwości tabeli.


|--
===Code===
|[[Template:Caption|Caption]]
Code must be styled using the [[Template:Code|Code]] template. The description of such code should follow afterwards. Accentuation should be strictly used ''only'' on the word or lines that must be accentuated.
|<div style="width:400px;">{{Caption|Jakiś podpis do obrazka}}</div>
|Użyj go, aby dodać wyjaśnienie pod obrazem. Możesz ustawić wyrównanie do lewej lub do środka.


|--
[[Python]] code should adhere to the general recommendations established by [https://www.python.org/dev/peps/pep-0008/ PEP8: Style Guide for Python Code].
|[[Template:Clear|Clear]]
In particular, parentheses should immediately follow the function name, and a space should follow a comma. This makes the code more readable.
|
|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.


|--
====Przykład nieprawidłowego opisu kodu====
|[[Template:Code|Code]]
|{{Code|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/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.
{{Code|code=
makeAngularDimension (center,[angle1,angle2],p3): creates an angular Dimension from the given center,
with the given list of angles, passing through p3. Returns the newly created object.
}}


|--
====Przykład prawidłowego opisu kodu====
|[[Template:CodeDownload|CodeDownload]]
|{{CodeDownload|https://wiki.freecad.org/Main_Page|Niektóre oznaczenia}}
|Użyj go, aby utworzyć link na stronie [[Macros/pl|makrodefinicji]].


|--
{{Code|code=
|[[Template:Codeextralink|Codeextralink]]
Dimension = makeAngularDimension(center, anglelist, p3)
|{{Codeextralink|https://wiki.freecad.org/Main_Page}}
Dimension = makeAngularDimension(center, [angle1, angle2], p3)
|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.
}}


|--
* Creates an angular dimension from the given {{incode|center}} point, the {{incode|anglelist}} containing {{incode|angle1}} and {{incode|angle2}}, and passing through point {{incode|p3}}.
|[[Template:Fake heading|Fake heading]]
* Returns the newly created {{incode|Dimension}} object.
|{{Fake heading|Nagłówek|2}}
|Użyj go, aby utworzyć nagłówek, który nie będzie automatycznie umieszczany w spisie treści.


|--
|[[Template:GuiCommand|GuiCommand]]
|Zobacz [[GuiCommand_model/pl|Model polecenia GUI]]
|Za jego pomocą można utworzyć pole z przydatnymi informacjami do dokumentowania poleceń ''(narzędzi)'' środowiska pracy.

|--
|[[Template:TutorialInfo|TutorialInfo]]
|Zobacz przykład [[Basic_modeling_tutorial/pl|Poradnik: Podstawy modelowania]]
|Użyj go do stworzenia ramki z przydatnymi informacjami, aby udokumentować [[Tutorials/pl|Poradniki]].

|--
|[[Template:Macro|Macro]]
|Zobacz przykład [[Macro_FlattenWire|Macro FlattenWire]]
|Użyj go do stworzenia ramki z przydatnymi informacjami, aby udokumentować [[macros/pl|makrodefinicje]].

|--
|[[Template: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.

|--
|[[Template:VeryImportantMessage|VeryImportantMessage]]
|{{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.

|--
|[[Template:Page in progress|Page in progress]]
|{{Page in progress|Strona w realizacji}}
|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.

|--
|[[Template:UnfinishedDocu|UnfinishedDocu]]
|{{UnfinishedDocu}}
|Użyj go, aby utworzyć podświetlone pole wskazujące niedokończoną stronę dokumentacji.

|--
|[[Template:Softredirect|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.

|--
|[[Template:Quote|Quote]]
|{{Quote|text=Krzyknij "Havoc" i wypuść psy wojny. |sign=William Shakespeare|source=''Juliusz Cezar'', akt III, scena I}}
|Użyj go, aby utworzyć pole tekstu z dosłownym cytatem i odniesieniem.

|--
|[[Template:Userdocnavi|Userdocnavi]],
[[Template:Powerdocnavi|Powerdocnavi]]
|
|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.

|}
</div> <!-- end of collapsible div. Do not remove! -->
</div> <!-- end of collapsible div. Do not remove! -->
</div> <!-- end of collapsible div. Do not remove! -->
</div> <!-- end of collapsible div. Do not remove! -->


<div class="mw-collapsible mw-collapsed toccolours">
<div class="mw-collapsible mw-collapsed toccolours">

==Graphics==
<span id="Graphics"></span>
==Grafika==
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
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/pl|Bitmap]] nie powinny być zmieniane.
Images and screenshots are necessary to produce a complete documentation of FreeCAD. Images are particularly useful to illustrate examples and tutorials.


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.
===General===
Avoid thumbnails and resizing [[bitmap|bitmap]] pictures (downsizing or upscaling). Pictures should be shown in their original size, so they present sufficient detail and are readable if they include text. The exception to this are [[SVG|SVG]] images, which can be scaled to any desired size without losing detail.


Pliki graficzne mogą być załadowane poprzez stronę [[Special:Upload|Special:Upload]].
Avoid animated pictures (GIF) in the general [[Gui Command|Gui Command]] help pages. Animations and videos should be reserved for tutorials not intended to be used as offline PDF documentation.


<span id="Name"></span>
Pictures must be uploaded through the [[Special:Upload]] page.
===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}}.
=== Name ===
Give a meaningful name to your image. If you have a picture that showcases the characteristics of a particular command, you should use the same name as the command with {{incode|_example}} at the end.
* For the command [[Draft Offset|Draft Offset]] the image should be called [[:Image:Draft Offset example.jpg|Draft Offset example.jpg]].
* For the command [[Arch Space|Arch Space]] the image should be called [[:Image:Arch Space example.jpg|Arch Space example.jpg]].


<span id="Screen_capture"></span>
===Screen capture===
===Zrzut ekranu===
Recommended sizes for screen captures are:
* Native 400x200 (or width=400 and height<=200), for [[Gui Command|Gui Command]] pages, to allow the picture to fit in the left part of the page, and for other standard snapshots.
* Native 600x400 (or width=600 and height<=400), for [[Gui Command|Gui Command]] pages, when you really need a bigger picture, and still allow the picture to fit in the left part of the page, and for other standard snapshots.
* Native 1024x768 (or width=1024 and height<=768), only for full screen images.
* Smaller sizes are possible when showing details, however use native resolution, not resizing or thumbnails, unless you have a very good reason to do so.
* Avoid larger resolutions, as they won't be very portable to other kinds of display or in the printed PDF documentation.


Zalecane rozmiary dla zrzutów ekranu to:
You shouldn't depend on any particular configuration of your desktop or operating system when you show screenshots. You should use visual defaults of the FreeCAD interface whenever possible.
* Natywny 400x200 ''(lub szerokość=400 i wysokość<=200)'', dla stron [[GuiCommand_model|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 [[GuiCommand_model|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.
===Text===
To ease documentation translations, take separate pictures of the interface and the 3D model viewport. The picture of the 3D model can be reused in every translation, while a translator can take a picture of the localized interface if necessary.


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]].
If your screen capture contains text use the same resolution of the original interface in FreeCAD so that text is readable.


<span id="Text"></span>
====Good sizing for reading text====
===Treść===
[[Image:partdesign_revolution_parameters.png|PartDesign revolution parameters (original size, 307px)]]


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.
====Bad sizing for reading text====
[[Image:partdesign_revolution_parameters.png|190px|PartDesign revolution parameters (scaled to 190px)]]


<span id="Icons_and_graphics"></span>
In the second picture the text is less clear and there are visual artifacts due to rescaling the original width from 307px to 190px.
===Ikonki i grafika===


Odnieś się do strony [[Artwork/pl|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|Artwork Guidelines]].
===Icons and graphics===
Refer to the [[Artwork|Artwork]] page for all artwork and icons that have been created for FreeCAD, which can be immediately reused in documentation pages.
If you would like to contribute with icons, please read the [[Artwork Guidelines|Artwork Guidelines]].
</div> <!-- end of Graphics collapsible div. Do not remove! -->
</div> <!-- end of Graphics collapsible div. Do not remove! -->
</div> <!-- end of Graphics collapsible div. Do not remove! -->
</div> <!-- end of Graphics collapsible div. Do not remove! -->


<div class="mw-collapsible mw-collapsed toccolours">
<div class="mw-collapsible mw-collapsed toccolours">

==Translations==
<span id="Translations"></span>
==Tłumaczenia==
<div class="mw-collapsible-content">
<div class="mw-collapsible-content">
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ę.
As per general consensus, the reference page in the wiki is the English page, which should be created first. If you want to change or add content to a page, you should do it to the English page first, and only once the update is completed, port the modification to the translated page.


FreeCAD Wiki wspiera rozszerzenie tłumaczenia, które pozwala na łatwiejsze zarządzanie tłumaczeniami między stronami; szczegóły w [[Localisation/pl#T.C5.82umaczenie_dokumentacji_Wiki_dla_FreeCAD|Tłumaczenie dokumentacji Wiki dla FreeCAD]].
The FreeCAD wiki supports a translation extension that allows managing translations between pages easier; for details, see [[Localisation#Translating the wiki|Localisation Translating the wiki]].


Inne przydatne zasoby to:
Other useful resources are:
* [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes ISO language codes] to identify the two-letter code for a particular language that you want to translate to.
* [http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes Kody ISO języków] aby określić dwuliterowy kod dla danego języka, na który chcesz tłumaczyć.
* [http://translate.google.com/ Google Translate] do pomocy przy tłumaczeniach.
* [http://en.wikipedia.org/wiki/Gallery_of_sovereign_state_flags Country flags] to identify a country's flag for use in relevant localized pages.
* [https://www.deepl.com/translator tłumacz Deepl] do pomocy przy tłumaczeniach.
* [http://translate.google.com/ Google Translate] for help with translating languages.
* [https://www.deepl.com/translator Deepl translator] for help with translating languages.


<span id="Some_tips_for_translators"></span>
== Some tips for translators ==
==Kilka wskazówek dla tłumaczy==


<span id="Translate_GuiCommand"></span>
===Setting GuiCommand===
===Tłumaczenie komend Gui===


<pre>
{{Code|code=
<nowiki>{{GuiCommand
{{GuiCommand
|Name=FEM EquationFluxsolver
|Name=FEM EquationFlux
|MenuLocation=Solve → Flux equation
|Icon=Fem-equation-fluxsolver.svg
|Workbenches=[[FEM_Workbench|FEM]]
|MenuLocation= Solve → Equation fluxsolver
|Workbenches=[[Fem Workbench|FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}
}}
</nowiki>
</pre>
}}


przetłumaczone:
translated:


<pre>
{{Code|code=
<nowiki>{{GuiCommand/fr
{{GuiCommand/fr
|Name=FEM EquationFluxsolver
|Name=FEM EquationFlux
|Name/fr=FEM EquationFluxsolver
|Name/fr=FEM Équation d'écoulement
|MenuLocation=Solveur → Équation de flux
|Icon=Fem-equation-fluxsolver.svg
|Workbenches=[[FEM_Workbench/fr|Atelier FEM]]
|MenuLocation= Solveur → Equation fluxsolver
|Workbenches=[[Fem Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM tutoriel]]
|SeeAlso=[[FEM_tutorial/fr|FEM Tutoriel]]
}}
</nowiki>
}}
}}
</pre>


<span id="Translate_navi"></span>
===Setting template===
===Ustawienia szablonu===


<pre>
{{Code|code=
{{FEM_Tools_navi}}
<nowiki>{{FEM Tools navi}}</nowiki>
</pre>
}}


przetłumaczone:
translated:


<pre>
{{Code|code=
{{FEM_Tools_navi/fr}}
<nowiki>{{FEM Tools navi/fr}}</nowiki>
</pre>
}}


<span id="Translate_link"></span>
===Setting link===
===Tłumaczenie odnośnika===


<pre>
{{Code|code=
<nowiki>[[Part_Module]]</nowiki>
[[Part_Module|Part Module]]
</pre>
}}


przetłumaczone:
przetłumaczone:


<pre>
{{Code|code=
<nowiki>[[Part_Module/fr|Atelier Pièces]]</nowiki>
[[Part_Module/fr|Atelier Part]]
</pre>
}}


<span id="Translate_Docnav"></span>
lub:
===Tłumaczenie Docnav===


<pre>
{{Code|code=
{{Docnav
<nowiki>[[Part_Module|Part Module]]</nowiki>
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}
}}
</pre>


przetłumaczone:
przetłumaczone:


<pre>
{{Code|code=
{{Docnav/fr
<nowiki>[[Part_Module/fr|Atelier Pièces]]</nowiki>
|[[About_FreeCAD/fr|À propos de FreeCAD]]
|[[Installing_on_Windows/fr|Installation sous Windows]]
}}
}}
</pre>


Przykład z ikonami:
===Setting Docnav===


<pre>
To localize the [[Template:Docnav]] navigation bar, see this thread in the forum [http://forum.freecadweb.org/viewtopic.php?f=21&t=6716 Docnav previous/next].
{{Docnav
|[[Std_Save|Save]]
|[[Std_SaveCopy|SaveCopy]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}
</pre>


przetłumaczone:
Essentially, a new translated template needs to be created, [[Template:Docnav/it]].


<pre>
The translated template should include the appropriate localized links as the "previous" and "next" parameters, together with the translated text:
{{Docnav/fr
<nowiki>{{docnav/it
|[[Installing/it|Installazione]]
|[[Std_Save/fr|Enregistrer]]
|[[Std_SaveCopy/fr|Enregistrer une copie]]
|[[Mouse Model/it|Navigazione 3D - Tipo di mouse]]
|[[Std_File_Menu/fr|Menu fichier]]
}}</nowiki>
|IconL=Std_Save.svg

|IconR=Std_SaveCopy.svg
The translated template should include the appropriate localized links as the "previous" and "next" parameters with icon, together with the translated text:
|IconC=Freecad.svg
<nowiki>{{Docnav/it
}}
|[[Mesh Import/it|Importa Mesh]]
</pre>
|[[Mesh MeshFromShape/it|Crea uno Mesh da un shape]]
|[[Mesh_Workbench|Mesh]]
|IconL=Mesh_ImportMesh.png
|IconC=Workbench_Mesh.svg
|IconR=Mesh_FromPartShape.svg
}}</nowiki>

Also includes the appropriate language category
<nowiki>[[Category:Template/it]]</nowiki>


If the localized category is not included in the translated template, the translated template will remain in the default English category.
</div> <!-- END of Translation section collapsible element. Do not remove! -->
</div> <!-- END of Translation section collapsible element. Do not remove! -->
</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>
===Using special pages===
==Tworzenie, zmiana nazwy i usuwanie strony==


<span id="Create_pages"></span>
*[[Special:LonelyPages]] lists those pages that are not linked from other pages in the FreeCAD wiki, therefore nobody can access these pages. If you find any in your native language, try to create the connection that exists in the English version of the page, otherwise no one can read them.
===Tworzenie stron===
*[[Special:UncategorizedPages]] lists pages without an assigned category, therefore they do not appear when you browse the wiki by categories. Assign a category.
*[[Special:WantedPages]] lists pages that are called in a page, but that do not exist. These are shown as red links in the text. Deprecated and very annoying.
*Others Wanted (files and templates)
*[[Special:WantedCategories]] lists categories that are used in a page, but that do not exist. They can be created immediately by clicking on the red link. Skip.
*[[Special:Categories]] lists all categories in the wiki. They allow you to compare the number of pages inside a translated category, which should preferably match then number of pages inside the English language category.
*[[Special:ListRedirects]] lists all redirected pages. If there is any red links, something does not work well. Investigate which link is missing. Light blue links lead to pages outside the site, no problem.
*[[Special:RecentChanges]] lists the most recent changes done to the wiki, including the pages changed, the number of changes to a particular page, whether these were additions or subtractions, and the user responsible.
*[[Special:LanguageStats]] shows translation statistics for all message groups for a single language. Shows the parts not translated in a given language, only for those pages marked for translation. To see what has not been translated, set the language code and press ''Show statistics''. It also contains the link to see what has been recently translated into that language. ''Note:'' if entering the English code ''en'' shows pages, it is likely that the original page contains markup errors, with the exception of the sidebar.
*[[Special:PageTranslation]] lists all pages marked for translation, and those unmarked but that have translation tags. Only administrators can mark pages for translation.
*[[:Category:Pages to delete]]: lists all pages that should be deleted because they were created by mistake, are obsolete, or no longer necessary.


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 [https://forum.freecadweb.org/viewforum.php?f=21 Wiki forum].
==Renaming, moving and deleting==


Aby utworzyć nową stronę wykonaj jedną z poniższych czynności:
===Rename pages===
* 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 Nowa Strona''' w tej Wiki!'.


<span id="Rename_pages"></span>
Since FreeCAD is a project under permanent development, it is necessary to revise the Wiki pages. One task is hereby to check if the file and page names are still following the conventions.
===Zmiana nazwy stron===
If a workbench changed for example a component name, the Wiki page describing it must be renamed. Thi can only be done by Wiki administrators. To inform them, open a topic in the [https://forum.freecadweb.org/viewforum.php?f=21 Wiki forum] and list the necessary renaming in this form:


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 [https://forum.freecadweb.org/viewforum.php?f=21 forum Wiki] i w tym formularzu opisz konieczną operację zmiany nazwy:
old name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;new name<br>
OLD_PAGE_NAME&nbsp;&nbsp;&nbsp;&nbsp;NEW_PAGE_NAME<br>
...<br>


<pre>
===Move files===
old name new name
Old_page_name_1 New_page_name_1
Old_page_name_2 New_page_name_2
...
</pre>


<span id="Delete_files_and_pages"></span>
To rename files it is in many cases to move them. That means they will become a new file under a new name while its content remains.
===Usuwanie plików i stron===


To move a file, go to its page (<nowiki>https://www.freecadweb.org/wiki/File:***.***</nowiki>) and click at the upper right on the menu '''More''' and select there the appearing menu '''Move'''. This opens a page with all info on how to perform a movement.
W przypadku, gdy chcesz usunąć plik, przejdź na jego stronę (<code><nowiki>https://www.freecadweb.org/wiki/File:***.***</nowiki></code>) i edytuj ją. Nie ważne czy strona jest pusta czy nie, dodaj to jako pierwszy element: <code><nowiki>{{Delete}}</nowiki></code> i bezpośrednio pod nim opisać, dlaczego strona powinna zostać usunięta. Dodatkowo, otwórz temat w dziale [https://forum.freecadweb.org/viewforum.php?f=21 forum Wiki].


Dla stron procedura jest taka sama.
===Delete files and pages===


<span id="Discussion"></span>
In case you need to delete a file, go to its page (<nowiki>https://www.freecadweb.org/wiki/File:***.***</nowiki>) and edit it. No matter if the page is blank or not, add this command as first element to the page: '''<nowiki>{{Delete}}</nowiki>''' and describe below why this should be deleted. Additonally, open a topic in the [https://forum.freecadweb.org/viewforum.php?f=21 Wiki forum].
==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.
For pages the procedure is the same.


<span id="Terminology_-_naming_policy"></span>
==Robots==
==Terminologia - Zasady nazewnictwa==


<span id="English"></span>
Head to [[WikiRobots|WikiRobots]] to find instructions on how to set up and use robots to automate repetitive tasks on the FreeCAD Wiki.
===Angielski===


Zobacz [[Glossary|Słownik]]
==Discussion==
The [http://forum.freecadweb.org/viewforum.php?f=21 Development/Wiki subforum] in the [https://forum.freecadweb.org FreeCAD forum] provides a dedicated space for discussing improvements on the wiki topics and appearance. Direct your questions and suggestions there.


<span id="Other_languages"></span>
==Brainstorming==
===Inne języki===


* [[Italian_Translation|włoski]]
{{VeryImportantMessage|All that follows is open to discussion. You can stop reading here if you don't intend to suggest modifications to the FreeCAD WikiPages style rules. You should discuss any wiki-related topic on the [[http://forum.freecadweb.org/viewforum.php?f=21 Development/Wiki subforum]]. Contributions are welcome.}}
* [[French_Translation|francuski]]
* [[German_Translation|niemiecki]]
* [[Polish_Translation|polski]]
* [[Spanish_Translation|hiszpański]]


See [[Wiki brainstorming]]. The information here was moved there to avoid cluttering this page.---[[User:Vocx|Vocx]] ([[User talk:Vocx|talk]]) 00:38, 2 November 2018 (UTC)


[[Category:Documentation{{#translation:}}]]
== Terminology - Naming policy==
[[Category:Wiki{{#translation:}}]]

[[Category:Wiki Documentation{{#translation:}}]]
===English===
[[Category:Administration{{#translation:}}]]
See [[Glossary]]

===Other languages===
* [[Italian_Translation|Italiano]]
* [[French Translation|Français]]
* [[German Translation|Deutsch]]

==[[Start Workbench|Start Center]] ==

'''proposal to create the page:'''

See [[Sandbox:Start center]]. The information here was moved there to avoid cluttering this page.---[[User:Vocx|Vocx]] ([[User talk:Vocx|talk]]) 00:28, 2 November 2018 (UTC)

= Sandbox for Macro Dimensions =
See [[Sandbox:Macro dimensions]]. The information here was moved there to avoid cluttering this page.---[[User:Vocx|Vocx]] ([[User talk:Vocx|talk]]) 23:43, 1 November 2018 (UTC)

= Sandbox for PartDesign Fillet =

See [[Sandbox:PartDesign fillet]]. The information here was moved there to avoid cluttering this page.---[[User:Vocx|Vocx]] ([[User talk:Vocx|talk]]) 23:36, 1 November 2018 (UTC)

Latest revision as of 07:29, 6 May 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.

Link do obrazu
Opcjonalny tekst, który jest wyświetlany po najechaniu kursorem na obszar obrazka.

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

Przewiń na górę strony

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 Opcja Użyj go, aby wskazać przycisk wyboru w graficznym interfejsie użytkownika, który należy Zaznaczyć lub Nie.
CheckBox Opcja Użyj go, aby wskazać pole wyboru w graficznym interfejsie użytkownika, które należy wybrać lub Nie.
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")
<class="rawcodeurl"><a href="https://wiki.freecad.org/Main_Page">raw code</a>
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
Nagłówek
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
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.
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
This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.
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

Krzyknij "Havoc" i wypuść psy wojny.

—William Shakespeare, Juliusz Cezar, akt III, scena I
Użyj go, aby utworzyć pole tekstu z dosłownym cytatem i odniesieniem.
Userdocnavi,

Powerdocnavi

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:

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]]

Tłumaczenie Docnav

{{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

Inne języki