WikiPages/cs
Tato stránka je rozšířením stránky Help:Editing a poskytuje obecné pokyny pro psaní a aktualizaci dokumentace wiki FreeCADu. Shrnuje několik diskusí a brainstormingových sezení.
Než začnete
- This wiki documentation is based on MediaWiki, the same software that powers Wikipedia. If you have contributed to Wikipedia, editing FreeCAD wiki pages should be easy.
- If you have never used wiki software before, please read Help:Editing to become familiar with the markup that is used.
- For advanced use of the wiki software, see MediaWiki Help:Contents. Not all features of MediaWiki are available in this FreeCAD wiki, but many are.
- We like to keep the documentation easy to read, so avoid using complex features. Keep it simple.
- Use a sandbox to test your code, for example, FreeCADDocu:Sandbox or a particular page with your name Sandbox:Yourname. Sandbox pages must be placed in the Sandbox category. This is done by adding
[[Category:Sandbox]]at the bottom of the wiki code. - Vezměte prosím na vědomí překlady. Wiki FreeCADu používá automatickou podporu překladu, aby poskytovala stránky v mnoha jazycích. Pro každou stránku může existovat více jazykových verzí. Na mnoha stránkách uvidíte tagy jako
<translate>...</translate>a mnoho jednotlivých tagů jako<!- -T:8-->. Tyto značky označují tzv. překladové jednotky a jsou vytvářeny překladovým systémem, nikdy byste je neměli vytvářet ručně. Propojují nadpisy a odstavce s jejich přeloženými verzemi. Neměli byste je měnit, protože by to tyto odkazy zničilo. Je však v pořádku přesouvat odstavce nebo měnit formulace, pokud u nich zůstanou značky. Pokud odstraníte nadpis nebo odstavec, měli byste také odstranit značku, která k němu patří. Uvědomte si, že změny stávajících nadpisů a odstavců ovlivňují aktuální překlady. Vaše změny by měly být opodstatněné. Při přidávání nového materiálu se nemusíte obávat, protože systém po vašich úpravách automaticky přidá nové značky. Více informací najdete v sekci Lokalizace a na původní stránce Mediawiki:Extension:Translate.
Obecné pokyny
Stručné popisy
Při popisu FreeCADu se snažte být struční a výstižní a vyhýbejte se opakování. Popište, co FreeCAD „dělá“, ne co FreeCAD „nedělá“. Vyhýbejte se také hovorovým výrazům, jako je 'pár'. Při uvádění neurčitého počtu použijte 'několik' nebo uveďte přesné množství.
- Špatný popis
- PartDesign Workbench: Pracovní prostředí PartDesign je určeno pro návrh dílů a jeho cílem je poskytnout nástroje pro modelování složitých pevných dílů.
- Dobrý popis
- Pracovní prostředí PartDesign: má za cíl poskytnout nástroje pro modelování složitých pevných dílů.
Centralized information
Avoid duplicating the same information in different places. Insert the information in a new page, and link to this page from other pages that require this information.
Do not use transclusion of pages (Help:Editing#Templates and transcluding pages), as this makes the wiki difficult to translate. Use only the templates described below in #Templates.
Styling
Templates are used to style the help pages. They give the documentation a consistent look and feel. There is a template for menu commands, File → Save, a template to style keys to be pressed, Shift, to show a Boolean value, true, etc. Please get familiar with the #Templates section before writing help pages.
Temporary flags
If you are working on a large page it is advisable to mark the page either as a work in progress or as unfinished. This assures that wiki admins don't mark your page as ready for translation while you are still changing it.
To flag a page add either {{Page in progress}} or {{UnfinishedDocu}} as the first line. With {{UnfinishedDocu}} you invite others to join you in finishing the page, while {{Page in progress}} indicates that you will do the work yourself and others should give you some time.
Once the work is done, please don't forget to remove the flags!
Příklady
Chcete-li se rychle seznámit se strukturou a stylem wiki FreeCADu, podívejte se na stránku modelu: Model gui příkazu.
Struktura
Uživatelské centrum poskytuje Obsah. Ten slouží jako hlavní reference pro automatické vytváření offline nápovědy, ke které se dostanete z FreeCADu, stejně jako offline dokumentace ve formátu PDF.
Šablona Template:Docnav se používá k postupnému propojování stránek podle struktury obsahu. Seznam všech šablon najdete v sekci #Šablony.
Názvy stránek
Page names should be short and they should 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').
- Bad page name
- Construction of AeroCompany airplanes
- Good page name
- Construction of AeroCompany Airplanes
The names of top level workbench pages must have this format: XYZ Workbench, where XYZ 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: XYZ Command, for example PartDesign Pad. Note that you should use the command name as it occurs in the source code.
Headings
Paragraph headings should be short and use sentence case: all words except the first one and proper names, should be in lowercase. You should not use H1 headings (= Heading =) in your wiki markup since the page title is automatically added as the main H1 heading.
Odkazy
Pokud je to možné, používejte pro odkazy původní název odkazu. Tím se v tištěné nebo offline dokumentaci zřetelněji označí odkazovaná stránka. Vyhněte se prosím používání nesmyslných slov pro odkaz.
- Nesprávný odkaz
- Další informace o kreslení 2D objektů najdete zde.
- Doporučený odkaz
- Další informace o kreslení 2D objektů najdete v sekci Pracovním prostředí Draft.
Preferovaný formát odkazu je:
[[Name_of_Page|Name of Page]]
Přeloženo:
[[Name_of_Page/cs|Název stránky]]
Všimněte si, že u části před znakem |, tedy u samotného odkazu, je důležité rozlišovat velká a malá písmena. Pokud se vaše stránka jmenuje Name_of_page, odkaz nebude fungovat, pokud napíšete Name_of_Page (velké P). Před znakem | by měly být všechny mezery nahrazeny podtržítky (_). To má pomoci překladatelům používajícím překladatelský software, bez podtržítka by odkaz byl softwarem přeložen, což je nežádoucí.
Chcete-li odkazovat na určitý odstavec, přidejte značku # a její nadpis k názvu stránky. Příklad:
[[WikiPages#Links|WikiPages]]
Přeloženo:
[[WikiPages/cs#Odkazy|WikiPages]]
Na stejné stránce můžete vynechat název stránky. Příklad:
[[#Links|Links]]
Pro odkaz na začátek stránky můžete použít:
</translate>{{Top}}<translate>
Tato šablona by měla automaticky zobrazovat správný text v závislosti na jazyku stránky. Odkaz na začátek stránky je obzvláště užitečný u dlouhých stránek, protože umožňuje uživateli rychle se vrátit k obsahu. Můžete ji umístit na konec každého odstavce. Ujistěte se, že před a za šablonou je prázdný řádek.
- Obrázkový odkaz
Použití obrázku jako odkazu:
[[Image:Draft_Wire.svg|24px|Volitelný text, který se zobrazí při najetí myší na obrázek|link=Draft_Wire]]
- Obrázkový odkaz + textový odkaz
- Draft Wire
Pokud vynecháte volitelný text, při najetí kurzorem na obrázek se zobrazí samotný odkaz, což je vhodnější, a za odkaz na obrázek byste měli přidat také textový odkaz:
[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Draft Wire]]
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.
Příklady najdete na stránce Výukové programy.
Šablony
Styling of the FreeCAD wiki pages is achieved through the use of templates (Help:Editing#Templates_and_transcluding_pages). 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.
| Template | Appearance | Description
|
|---|---|---|
| Top |
|
Use it to add a link to the top of the page.
|
| Emphasis | emphasis | Use it to emphasize a piece of text.
|
| KEY | Alt | Use it to indicate a keyboard key that needs to be pressed.
|
| ASCII | 
|
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.
|
| Button | Cancel | Use it to indicate a button in the graphical user interface that needs to be pressed.
|
| RadioButton |  Option
|
Use it to indicate a radio button in the graphical user interface that needs to be  Selected or Not.
|
| CheckBox |  Option
|
Use it to indicate a checkbox in the graphical user interface that needs to be  Checked or Not.
|
| SpinBox | 1.50 
|
Use it to indicate a spinbox in the graphical user interface that needs to be modified.
|
| ComboBox | Menu 1 
|
Use it to indicate a combobox in the graphical user interface that needs to be modified.
|
| LineEdit | Metal Nickel (Ni) | Use it to indicate a LineEdit in the graphical user interface that needs to be modified.
|
| FALSE, false | false, false
|
Use it to indicate a False Boolean value, for example, as a property in the property editor. This is a shortcut. Since it is a value, prefer Template Value false
|
| TRUE, true | true, true
|
Use it to indicate a True Boolean value, for example, as a property in the property editor. This is a shortcut. Since it is a value, prefer Template Value true
|
| MenuCommand | File → Save | Use it to indicate the location of a command inside a particular menu.
|
| FileName | File name | Use it to indicate a name of a file or directory.
|
| SystemInput | Type this text | Use it to indicate user typed input text.
|
| SystemOutput | Output text | Use it to indicate text output from the system.
|
| Incode | import FreeCAD
|
Use it to include in-line source code with a monospace font. It should fit in one line.
|
| PropertyView | PohledColor | Use it to indicate a View property in the property editor. Examples of View properties include Line Color, Line Width, Point Color, Point Size, etc.
|
| PropertyData | ÚdajePosition | Use it to indicate a Data property in the property editor. Data properties are different for different types of objects.
|
| Properties Title / TitleProperty | Base | Use it to indicate the title of a property group in the property editor. The title will not be included in the automatic table of contents.
|
| Obsolete | obsolete in 0.19 | Use it to indicate that a feature became obsolete in the specified FreeCAD version.
|
| VersionNoteObsolete | obsolete in 0.19 | Idem (superscript variant).
|
| Version | introduced in 0.18 | Use it to indicate that a feature was introduces in the specified FreeCAD version.
|
| VersionNote | introduced in 0.18 | Idem (superscript variant).
|
| VersionMinus | 0.16 and below | Use it to indicate that a feature is available in the specified FreeCAD version and earlier versions.
|
| VersionNoteMinus | 0.16 and below | Idem (superscript variant).
|
| VersionPlus | 0.17 and above | Use it to indicate that a feature is available in the specified FreeCAD version and later versions.
|
| VersionNotePlus | 0.17 and above | Idem (superscript variant).
|
| ColoredText | Colored Text | Use this template to color the background, text, or background and text. (ColoredText page for more examples)
|
| ColoredParagraph | Colored Paragraph
|
Use this template to color the background, text, or background and text of an entire paragraph. (ColoredParagraph page for more examples) |
Complex templates
These templates require more input parameters, or produce a block of text with a particular format.
| Template | Appearance | Description
|
|---|---|---|
| Prettytable | This table | Use it to format tables such as this one. Additional table properties can be added.
|
| Caption | Some caption for an image |
Use it to add an explanation below an image. It can be left aligned or center aligned.
|
| 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.
| |
| Code | import FreeCAD
|
Use it to include multi-line code examples with a monospace font. The default language is Python, but other languages can be specified.
Python code should adhere to the general recommendations established by PEP8: Style Guide for Python Code. In particular, parentheses should immediately follow the function name, and a space should follow a comma. This makes the code more readable. |
| CodeDownload | Use it to create a link on a macro page.
| |
| 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")
|
Use it if the code of a macro is too large to be hosted on the Wiki. The code can then be hosted somewhere else, and the raw link to it specified with this template. The Addon Manager will use this link.
|
| Fake heading | Use it to create a heading that will not be automatically included in the table of contents.
| |
| GuiCommand | See GuiCommand model | Use it to create a box with useful information to document workbench commands (tools).
|
| TutorialInfo | See for example Basic modeling tutorial | Use it to create a box with useful information to document tutorials.
|
| Macro | See for example Macro FlattenWire | Use it to create a box with useful information to document macros.
|
| Docnav | Use it to create a bar with arrows and appropriate links, which is useful for putting pages in a particular sequence.
| |
| 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.
|
| Page in progress |  |
Use this for pages that are still in progress or that are currently being reworked. Don't forget to remove this when the page is ready.
|
| 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. |
Use it to create a highlighted box indicating an unfinished documentation page.
|
| 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.
| |
| Quote |
|
Use it to create a box of text with a literal quote and reference.
|
| Userdocnavi, Powerdocnavi | 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.
|
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 _example at the end. For example for the command Draft Offset the image should be called Draft_Offset_example.png.
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.
To create a screenshots you can use the options provided by your operating system, or one of these macros: 
Macro Snip and 
Macro Screen Wiki.
Text
Aby se usnadnil překlad dokumentace, snažte se vyhýbat screenshotům, které obsahují text. Pokud se tomu nelze vyhnout, zvažte pořízení samostatných screenshotů rozhraní a 3D zobrazení. Obrázek 3D zobrazení lze použít v každém překladu, zatímco překladatel může v případě potřeby pořídit screenshot lokalizovaného rozhraní.
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.
Překlady
Podle obecného konsensu je referenční stránkou ve wiki stránka v angličtině, která by měla být vytvořena jako první. Pokud chcete změnit nebo přidat obsah na stránku, měli byste to nejprve udělat na anglické stránce a teprve po dokončení aktualizace přenést úpravy na přeloženou stránku.
Wiki FreeCADu podporuje rozšíření pro překlady, které usnadňuje správu překladů mezi stránkami; podrobnosti najdete v Lokalizace Překlad wiki.
Další užitečné zdroje jsou:
- ISO jazykové kódy pro identifikaci dvoumístného kódu konkrétního jazyka, do kterého chcete překládat.
- Google Translate pro pomoc s překlady.
- Deepl translator pro pomoc s překlady.
Několik tipů pro překladatele
Překlad Gui příkazů
{{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]]
}}
Přeloženo:
{{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]]
}}
{{FEM_Tools_navi}}
Přeloženo:
{{FEM_Tools_navi/fr}}
Překlad odkazu
[[Part_Workbench|Part Workbench]]
Translated:
[[Part_Workbench/fr|Atelier Part]]
{{Docnav
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}
Přeloženo:
{{Docnav/fr
|[[About_FreeCAD/fr|À propos de FreeCAD]]
|[[Installing_on_Windows/fr|Installation sous Windows]]
}}
Příklad s 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
}}
Přeloženo:
{{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
}}
Vytváření, přejmenování a mazání stránek
Tvorba stránek
Před vytvořením nové stránky byste měli nejprve zkontrolovat, zda již podobná stránka neexistuje. Pokud ano, je obvykle lepší upravit stávající stránku. V případě pochybností nejprve otevřete téma na Wiki fóru.
Chcete-li vytvořit novou stránku, proveďte jednu z následujících akcí:
- Navštivte URL adresu s požadovaným názvem stránky, například:
https://wiki.freecad.org/My_New_Page, a klikněte na „vytvořit tuto stránku“. - Vyhledejte název stránky ve wiki a klikněte na červený text v části 'Create the page "My New Page" on this wiki!'.
Přejmenování stránek
Vzhledem k tomu, že FreeCAD je projekt v neustálém vývoji, je někdy nutné revidovat obsah wiki. Pokud se ve zdrojovém kódu změní názvy příkazů, je nutné přejmenovat také wiki stránky, které je dokumentují. To mohou provést pouze administrátoři wiki. Chcete-li je informovat, otevřete téma ve Wiki fóru a uveďte seznam potřebných přejmenování v tomto formuláři:
old name new name Old_page_name_1 New_page_name_1 Old_page_name_2 New_page_name_2 ...
Mazání souborů a stránek
Pokud potřebujete smazat soubor, přejděte na jeho stránku (https://wiki.freecad.org/File:***.***) a upravte ho. Bez ohledu na to, zda je stránka prázdná nebo ne, přidejte jako první prvek: {{Delete}} a přímo pod ním popište, proč by měla být stránka smazána. Navíc otevřete téma ve Wiki fóru.
U stránek je postup stejný.
Diskuse
Development/Wiki podforum ve FreeCAD fóru poskytuje vyhrazený prostor pro diskusi o tématech týkajících se wiki, vzhledu wiki a všem ostatním, co s wiki souvisí. Své dotazy a návrhy směřujte sem.
Terminology - naming policy
English
See Glossary.