Template:GuiCommand/cs
|
|
| Umístění Menu |
|---|
| Nikdo |
| Pracovní stoly |
| {{{Workbenches}}} |
| Výchozí zástupce |
| Nikdo |
| Představen ve verzi |
| - |
| Viz také |
| Nikdo |
Použití
Tato šablona je základem pro dokumentaci GuiPříkazů. měla by být vložena na prvním řádku nového dokumentu.
Minimální kód pro použití této šablony je: (výsledek příkladu je vpravo) This Template is the main anchor on documenting GuiCommands. It should be inserted as the first line in new documents.
The minimum code required for this template usage is: (sample result to right)
{{GuiCommand/cs|Name=SampleCommand|Name/cs=TestCommand/cs|MenuLocation=Sample → Command...|Workbenches=Wb1,Wb2}}
|
|
| Umístění Menu |
|---|
| Sample → Command... |
| Pracovní stoly |
| Wb1,Wb2 |
| Výchozí zástupce |
| DefaultShortcut |
| Představen ve verzi |
| - |
| Viz také |
| OtherTopic |
Minimální parametry
Následující parametry jsou použity ve formátu [parametr]=[hodnota], kde jsou parametry vzájemně odděleny znakem potrubí (|):
- Name
- Jméno příkazu, který bude dokumentován, s velkými písmeny na začátku každého slova ve jméně. In this case a generic icon
is displayed. - Jméno je také použito pro získání grafické ikony ve formátu .png z repozitáře WIKI
- MenuLocation
- Umístění příkazu ve struktuře menu FreeCADu
- Workbenches
- Jedna nebo více pracovních ploch FreeCADu ve kterých může být příkaz a ikona umístěna
Volitelné parametery
Následující parametry jsou volitelné. Jestliže nejsou zadány v kódu šablony, jsou defaultně nastaveny na hodnotu "None".
- Shortcut
- Defaultní klávesová zkratka jaká je ve FreeCADu.
- SeeAlso
- Volitelný odkaz na další související témata.
- Icon
- an icon with a different name as pagename.png can be used by defining the variable Icon (other format can be used eg: myIcon.svg)
- Empty
- if Empty=1 no icon is displayed
- Version
- inserts the FreeCAD version number in which the command was first introduced. No need to add the revision number. Please consider adding this parameter for all new commands.
Localization
The code required for this template is different if you are using a localized version. For more information see the Lokalizace page.
- First, a localized version of this template must exist or be created.
- The localized template must be named:
Template:GuiCommand/AA
where /AA is the 2 letter code for the desired language, for example /fr = French localization. - The method for calling the localized GuiCommand template in a GuiCommand document is:
{{GuiCommand/AA|Name=SampleCommand|Name/AA=SampleCommand (translated)|MenuLocation=Sample → Commande...|Workbenches=Wb1,Wb2}}where /AA is the 2 letter code for the desired language, for example /fr = French localization.- In the sample code above, the Name parameter format is critical. The Name=SampleCommand allows the correct icon file to be displayed, which is not normally localized. The Name/AA=SampleCommand (translated) displays the correct localized version of the GUI command documentation.
- Make sure you add the localized version of this template to the Languages list below.
GuiCommand Model
For a complete model of a GuiCommand, see Model Gui Command.