Template:Macro

Usage
This template is the main tool to document macros. It should be inserted as the first line in documentation pages, after the and tags. See a sample to the right.

The required parameters are:

Other parameters may be omitted or their value left empty.

Required parameters
Parameters are specified with its value after the equals sign,.

Each parameter in the list is separated by a pipe symbol. |... |Name=SomeMacro|Author=WikiUserName| ... Parameters can be placed in the same line, or each in a separate line. |...
 * Name=SomeMacro
 * Author=WikiUserName

The following parameters are required.


 * Name
 * The properly capitalized name of the macro to be documented.
 * The name is used to retrieve the icon graphic  or   from the wiki repository. The template works properly if the icon does not exist; in this case, a generic icon [[Image:Text-x-python.png|24px]] is displayed.


 * Description
 * A description for the macro, this description will be displayed in Addon manager.


 * Author
 * The author of the macro. This name is linked to the user's page in the wiki, that is, User:Author. Since macros are not part of the official FreeCAD code, users should direct their questions about them to their particular creators. The author of a macro should be reachable in the forum, with the same username as in the wiki.


 * Date
 * All macros must have a date. This is helpful to indicate the last time the macro was modified, and warn the user of the age of the code. Macros that are very old may be obsolete and may not work with a recent version of FreeCAD.

Optional Parameters
The following parameters are optional. If they are not included in the template, they will display a default value.
 * Name/xx
 * The name translated in your language (/fr, /it, /de, /es ...) which will be displayed in the window. For example


 * Version
 * The version of the macro. If no value is given, it will default to . This is helpful for authors, so that they can document particular versions of their own macros.


 * Shortcut
 * Some macros may introduce shortcuts to launch specific tools. Indicate the shortcut buttons to press with this value. If no value is given, it will default to None.


 * SeeAlso
 * Optional links to other related commands, for example,.


 * Icon
 * An image file different from  or   to use as icon. This can be used to include a specific icon that is not named after the command, for example,