Template:Macro/cs

Použití
Tato šablona je hlavním nástrojem pro dokumentaci makra. Měl by být vložen jako první řádek na stránkách dokumentace po and tags. Podívejte se na vzorek napravo.

Požadované parametry jsou:

Jiné parametry mohou být vynechány nebo jejich hodnota zůstává prázdná.

Požadované parametry
Parametry jsou zadány s hodnotou za znaménkem rovnosti,.

Každý parametr v seznamu je oddělen symbolem trubky. |... |Name=SomeMacro|Author=WikiUserName| ... Parameters can be placed in the same line, or each in a separate line. |...
 * Name=SomeMacro
 * Author=WikiUserName

Jsou požadovány následující parametry.


 * Name
 * Správně napsaný název makra, který má být zdokumentován.
 * Název se používá k načtení grafické ikony  or   z úložiště wiki. Šablona funguje správně, pokud ikona neexistuje; v tomto případě obecná ikona [[Image:Text-x-python.png|24px]] je zobrazen.


 * Description
 * Popis makra, tento popis se zobrazí v Správci doplňků.


 * Author
 * Autor makra. Tento název je propojen se stránkou uživatele v wiki, tedy User:Author. Vzhledem k tomu, že makra nejsou součástí oficiálního kódu systému FreeCAD, uživatelé by měli své otázky o nich adresovat svým konkrétním tvůrcům. Autor makra by měl být dostupný na forum, se stejným uživatelským jménem jako v wiki.


 * Download
 * Možné soubory ke stažení, například ikona toolBar a jiný soubor. Uveďte úplný odkaz objektu ex:


 * Date
 * Všechna makra musí mít datum. To je užitečné při označování posledního modifikace makra a upozornění uživatele na věk kódu. Makra, která jsou velmi stará, mohou být zastaralá a nemusí pracovat s nedávnou verzí FreeCADu.


 * FCVersion
 * Verze FreeCADu pro spuštění makra: 0.16 to 0.19

Volitelné parametry
Následující parametry jsou volitelné. Pokud nejsou zahrnuty do šablony, zobrazí se výchozí hodnota.
 * Translate
 * Jméno přeložené ve vašem jazyce, které se zobrazí v názvu okna. Například


 * Links
 * Další odkaz na nápovědu k makru Příklad videa, Návody na stránce týkající se makra.


 * Version
 * Verze makra. Není-li zadána žádná hodnota, výchozí hodnota bude . To je užitečné pro autory, takže mohou dokumentovat konkrétní verze vlastních maker.


 * Shortcut
 * Některá makra mohou představovat zkratky pro spuštění určitých nástrojů. Označte klávesová zkratka a stiskněte tuto hodnotu. Není-li zadána žádná hodnota, výchozí hodnota bude None.


 * SeeAlso
 * Volitelné odkazy na další související příkazy, například,.


 * Icon
 * Soubor obrázku jiný než  or   použít jako ikonu. Toto může být použito k zahrnutí specifické ikony, která není pojmenována po příkazu, například,