Template:GuiCommand/zh-cn

From FreeCAD Documentation
Jump to: navigation, search

Official icon not found {{{Name/en}}}

菜单位置
{{{MenuLocation}}}
所属工作台
{{{Workbenches}}}
默认快捷键
None
参阅
None


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/zh-cn|Name=SampleCommand|Name/en=SampleCommand|MenuLocation=Sample → Command...|Workbenches=Wb1,Wb2}}

SampleCommand.png SampleCommandMenuLocation=Sample → Command...

菜单位置
{{{MenuLocation}}}
所属工作台
Wb1,Wb2
默认快捷键
DefaultShortcut
参阅
OtherTopic


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. The template works properly, if the Icon graphic does not exist. In this case a generic icon NoIconFound.png is displayed.
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.

The optional parameter

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

Localization

The code required for this template is different if you are using a localized version. For more information see the Localization 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 GuiCommand model.