Template:GuiCommand
[[Image:{{{Name}}}.png|32px]] {{{Name}}} |
| Menu location |
|---|
| {{{MenuLocation}}} |
| Workbenches |
| {{{Workbenches}}} |
| Default shortcut |
| None |
| See also |
| None |
|
| Menu location |
|---|
| Sample -> Command... |
| Workbenches |
| Wb1,Wb2 |
| Default shortcut |
| DefaultShortcut |
| See also |
| OtherTopic |
Usage
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|Name=SampleCommand|MenuLocation=Sample -> Command...|Workbenches=Wb1,Wb2}}
Minimum Parameters
The following parameters are used in the format [parameter]=[value], with each parameter in the list separated by a pipe symbol (|):
- Name
- The properly capitalized name of the command to be documented.
- The name is also used to retrieve the Icon graphic in .PNG format from the WIKI repository.
- MenuLocation
- The location of the command in the FreeCAD menu structure.
- Workbenches
- One or more workbenches in FreeCAD that the command and icon can be found on.
Optional Parameters
The following parameters are optional. If they are not included in the template code, they will default to a value of "None".
- Shortcut
- The default Keyboard shortcut as found in FreeCAD.
- SeeAlso
- Optional link to other related topics.