WikiPages/pl

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

Zanim rozpoczniesz pracę

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

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


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


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

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

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

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

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

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

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

Przykłady
Możesz szybko zapoznać się ze strukturą i stylem wiki FreeCAD patrząc na poniższe strony, które mogą być uważane jako strony wzorcowe dla pozostałej części dokumentacji FreeCAD.
 * Draft: Kształt napisu
 * Draft: Linia

Ogólnie
Zazwyczaj nie należy używać sekcji =header= dla strony, ponieważ tytuł strony jest dodawany automatycznie.

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 służy do tworzenia odnośników na początku i na końcu strony, zgodnie ze strukturą Spisu treści pomocy online. Lista wszystkich szablonów znajduje się w sekcji Szablony.

Nazwy stron
Nazwy stron powinny być krótkie, a w odróżnieniu od "opisu sprawy" powinny zawierać "tytuł sprawy". Jest to styl używany przez Wikipedię dla ich artykułów.


 * Przewodnik na temat budowy samolotów AeroCompany.
 * Przewodnik Na Temat Budowy Samolotów AeroCompany.


 * Good page name:
 * Construction of AeroCompany airplanes

The names of top level workbench pages must have this format:, where   is the name of the workbench, for example PartDesign Workbench. And the names of pages describing the commands (or tools) belonging to a workbench must have this format:, for example PartDesign Pad. Note that you should use the command name as it occurs in the source code.

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 (f.e. 'of', 'on', 'in', 'a', 'an', 'and'). There are many existing pages using this style, but it is discouraged for new pages. This was discussed in the forum thread (Lowercase links) Use a lower case title for a wiki page.

Headings
Like page names, paragraph headings should be short and use sentence case. You should not use  headings  in your wiki markup since the page title is automatically added as the main   heading.

Odnośniki internetowe
You should use the original link name for links whenever possible. This clarifies the referenced page in printed or offline documentation. Please avoid non-meaningful words for the link.


 * Bad link
 * For more information on drafting 2D objects click here.


 * Good link
 * For more information on drafting 2D objects refer to the Draft Workbench.

Ogólny format odnośnika jest następujący:

pagename

Aby przetłumaczyć ten wiersz:

etykieta_do_wyświetlenia

Note that for the part before the  character, the actual link, case is relevant. If your page name is  the link will fail if you type   (upper case P). Before the  character all spaces should be replaced by underscores. This is to assist translators using translation software, without the underscores the link would be translated by the software which is undesirable.

To link to a certain paragraph add a  sign and its headings to the page name. Example:

Aby przetłumaczyć ten wiersz:

Within the same page you can omit the page name. Example:

Linki do górnej części strony
Wystarczy, że w miejscu, w którym chcesz umieścić link wiodący w górę strony, wpiszesz następujący tekst.

top

Mógłbyś go umieścić na końcu każdego rozdziału. Upewnij się, że masz przed sobą pustą linijkę, aby nie zawierała ostatniego akapitu.

Workbench pages
A top level workbench page should start with:
 * A description of what the workbench is used for.
 * An image to illustrate the description.

See #Screen capture for conventions on including images.

Command pages
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.

Please refer to the GuiCommand model page for more details.

Tutorials
A well written tutorial should teach how to achieve certain practical results quickly. It shouldn't be too long, but should include sufficient step-by-step instructions and images to guide the user. As FreeCAD evolves, tutorials may become obsolete, so it is important to mention the FreeCAD version used in, or required for, a tutorial.

For examples visit the Tutorials page.

Szablony
Styling of the FreeCAD wiki pages is achieved through the use of templates (Help:Editing). They ensure a standardized look and feel across all pages, and also make it possible to re-style the wiki. You can see the complete list of defined templates by accessing Special:PrefixIndex/Template:. But please only use the templates listed in the tables below. Only in very special cases should you use HTML tags directly.

Click on the template link to see the usage instructions for a 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 MediaWiki Help:Templates to learn more.

Simple templates
These templates accept a simple text parameter, and format it with a particular style.

Complex templates
These templates require more input parameters, or produce a block of text with a particular format.

Graphics
Images and screenshots are necessary to produce a complete documentation of FreeCAD. They are particularly useful to illustrate examples and tutorials. Images should be shown in their original size, so they present sufficient detail and are readable if they include text. Bitmap images should not be resized.

Avoid animated pictures (GIF) in the general help pages. Animations and videos should be reserved for tutorials not intended to be used as offline PDF documentation.

Images can be uploaded through the Special:Upload page.

Name
Give meaningful names to your images. If you have an image that showcases the characteristics of a particular command, you should use the name of that command with at the end. For example for the command Draft Offset the image should be called.

Screen capture
Recommended sizes for screen captures are:
 * Native 400x200 (or width=400 and height<=200), for command reference 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 command reference 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.
 * Avoid images with larger resolutions, as they won't be very portable to other kinds of displays or the printed PDF documentation.

You shouldn't depend on a custom configuration of your desktop or operating system when you create screenshots and you should use the visual defaults of the FreeCAD interface whenever possible.

W przypadku obrazu możesz użyć Makra Snip do pobrania obrazu w wybranym oknie lub  Makra Screen Wiki  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.

Text
To ease documentation translations, try to avoid screenshots that contain texts. If you cannot avoid this, consider taking separate screenshots of the interface and the 3D view. The image of the 3D view can be reused in every translation, while a translator can take a screenshot of the localized interface if necessary.

Icons and graphics
Refer to the Artwork page for all artwork and icons that have been created for FreeCAD, and which can also be used in documentation pages. If you would like to contribute icons, please read the Artwork Guidelines.

Translations
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.

The FreeCAD wiki supports a translation extension that allows managing translations between pages easier; for details, see Localisation Translating the wiki.

Other useful resources are:
 * ISO language codes to identify the two-letter code for a particular language that you want to translate to.
 * Google Translate for help with translations.
 * Deepl translator for help with translations.

Translate GuiCommand
przetłumaczone:

Ustawienia szablonu
przetłumaczone:

Ustawienia odnośnika
Part Module

przetłumaczone:

Atelier Pièces /

Ustawienia Docnav
Translated:

Example with icons:

Translated:

Rename pages
Since FreeCAD is a project under permanent development, it is sometimes necessary to revise the content of the wiki. If the names of commands are changed in the source code, the wiki pages documenting them have to be renamed as well. This can only be done by wiki administrators. To inform them, open a topic in the Wiki forum and list the necessary renaming operation in this form:

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
In case you need to delete a file, go to its page and edit it. No matter if the page is blank or not, add this as the first element:  and directly below it describe why the page should be deleted. Additionally, open a topic in the Wiki forum.

Dla stron procedura jest taka sama.

Discussion
The Development/Wiki subforum in the FreeCAD forum provides a dedicated space for discussing wiki topics, the wiki appearance and anything else related to the wiki. Direct your questions and suggestions there.

Angielski
Zobacz Słownik

Inne języki

 * włoski
 * francuski
 * niemiecki