Template:GuiCommand/es: Difference between revisions

From FreeCAD Documentation
m (upgrade "fcinfobox wikitable ct")
m (upgrade)
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{|class="fcinfobox wikitable ct" width=100% height=100% style="float: right; width: 230px; margin-left: 1em" |
{|class="fcinfobox wikitable ct" width=100% height=100% style="float: right; width: 230px; margin-left: 1em" |
| class="ctTitle"|
| class="ctTitle" style="font-weight: bold; font-size: 125%;" |
{{#if:{{{Empty|}}}||
=== [[Image:{{{Name}}}.png|32px]] {{{Name}}} ===
{{#if:{{{Icon|}}}
|[[Image:{{{Icon}}}|32px]]<span> </span>
|{{#ifexist: Image:{{{Name}}}.svg
|[[Image:{{{Name}}}.svg|32px]]<span> </span>
|{{#ifexist: Image:{{{Name}}}.png
|[[Image:{{{Name}}}.png|32px]]<span> </span>
|[[Image:NoIconFound.png|32px|Official icon not found]]<span> </span>}}}}}}}}{{{Name/es}}}
|-
|-
! class="ctOdd"|Ubicación en el Menú
! class="ctOdd"|Ubicación en el Menú
Line 14: Line 21:
|-
|-
| class="ctEven"|{{{Shortcut|None}}}
| class="ctEven"|{{{Shortcut|None}}}
|-
! class="ctOdd"|Introducido en versión
|-
| class="ctEven"|{{{Version|-}}}
|-
|-
! class="ctOdd"|Ver también
! class="ctOdd"|Ver también
Line 26: Line 37:
[[Category:Command Reference/es]]
[[Category:Command Reference/es]]


<noinclude> <!-- Note to editors: Do Not Remove This Line. -->
<noinclude>

==Usage==
==Usage==
This Template is the main anchor on documenting GuiCommands.
This Template is the main anchor on documenting GuiCommands. It should be inserted as the first line in new documents.

<code>{{GuiCommand/es|Name=SampleCommand|Shortcut=Ctrl+X|Workbenches=Wb1,Wb2}}</code>
The minimum code required for this template usage is: (sample result to right)
</noinclude>
<pre>{{GuiCommand/es|Name=SampleCommand|Name/es=SampleCommand|MenuLocation=Sample → Command...|Workbenches=Wb1,Wb2}}</pre>
{{GuiCommand/es|Name=SampleCommand|Name/es=SampleCommand|MenuLocation=Sample → Command...|Workbenches=Wb1,Wb2|Shortcut=DefaultShortcut|SeeAlso=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 [[Image:NoIconFound.png|24px]] 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", or for the Version parameter, a dash sign.
;Shortcut : The default Keyboard shortcut as found in FreeCAD.
;SeeAlso : Optional links to other related commands.
;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 [[Localisation/es|Localization]] page.

* First, a localized version of this template must exist or be created.
* The localized template must be named: <pre>Template:GuiCommand/AA</pre> 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: <pre>{{GuiCommand/AA|Name=SampleCommand|Name/AA=SampleCommand (translated)|MenuLocation=Sample → Commande...|Workbenches=Wb1,Wb2}}</pre> 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/es|GuiCommand model]].

</noinclude> <!-- Note to editors: This must be the last line of the Template. Do Not Remove This Line. -->

Revision as of 18:50, 15 February 2019

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

Ubicación en el Menú
{{{MenuLocation}}}
Entornos de trabajo
{{{Workbenches}}}
Atajo de teclado por defecto
None
Introducido en versión
-
Ver también
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/es|Name=SampleCommand|Name/es=SampleCommand|MenuLocation=Sample → Command...|Workbenches=Wb1,Wb2}}

SampleCommand

Ubicación en el Menú
Sample → Command...
Entornos de trabajo
Wb1,Wb2
Atajo de teclado por defecto
DefaultShortcut
Introducido en versión
-
Ver también
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 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", or for the Version parameter, a dash sign.

Shortcut
The default Keyboard shortcut as found in FreeCAD.
SeeAlso
Optional links to other related commands.
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 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.