Donate

Uso

Esta plantilla es la principal herramienta para documentar macros. Debe insertarse como la primera línea en las páginas de documentación, después de la <languages/> y <translate> etiquetas. Ver una muestra a la derecha.

{{Macro/es
|Name=SomeMacro
|Description=Esta macro mejora las formas sólidas en todos los sentidos.
|Author=WikiUserName
|Download=[https://www.freecadweb.org/wiki/images/2/2c/Text-x-python.png Text-x-python.png]
|Version=2.0
|Date=2018-11-20
}}

Los parámetros requeridos son:

{{Macro/es
|Name=SomeMacro
|Description=Esta macro mejora las formas sólidas en todos los sentidos.
|Author=WikiUserName
|Download=Possible files to download, example the icon toolBar ...
|Date=2018-11-20
|Version=2.0
|FCVersion= 0.16 to 0.19
}}

Se pueden omitir otros parámetros o dejar su valor vacío.

Parámetros requeridos

Los parámetros se especifican con su valor después del signo igual, parameter=value.

Cada parámetro en la lista está separado por un símbolo de tubería |.

|... |Name=SomeMacro|Author=WikiUserName| ...

Los parámetros se pueden colocar en la misma línea, o cada uno en una línea separada.

|...
|Name=SomeMacro
|Author=WikiUserName
| ...

Se requieren los siguientes parámetros.

Name

El nombre correctamente en mayúsculas de la macro a documentar.

El nombre se usa para recuperar el ícono gráfico Name.svg o Name.png del repositorio de wiki. La plantilla funciona correctamente si el icono no existe; en este caso, se muestra un ícono genérico .

Description

Una descripción de la macro, esta descripción se mostrará en el Administrador de complementos.

Author

El autor de la macro. Este nombre está vinculado a la página del usuario en la wiki, es decir, User:Autor. Dado que las macros no son parte del código oficial de FreeCAD, los usuarios deben dirigir sus preguntas sobre ellos a sus creadores particulares. El autor de una macro debe estar disponible en el forum, con el mismo nombre de usuario que en la wiki.

Download

Posibles archivos para descargar, ejemplo la barra de herramientas del icono y otro archivo. Dar el enlace completo del objeto ex: Download=[https://www.freecadweb.org/wiki/images/2/2c/Text-x-python.png Text-x-python.png]

Date

Todas las macros deben tener una fecha. Esto es útil para indicar la última vez que se modificó la macro y advertir al usuario de la edad del código. Las macros que son muy antiguas pueden estar obsoletas y es posible que no funcionen con una versión reciente de FreeCAD.

FCVersion

Versión (es) de FreeCAD para ejecutar elo macro ejempl: 0.16 to 0.19

Parámetros opcionales

Los siguientes parámetros son opcionales. Si no están incluidos en la plantilla, mostrarán un valor predeterminado.

Translate

El nombre traducido en su idioma que se mostrará en el título de la ventana. Por ejemplo, Translate=Some_translated_name

Links

Otro enlace de ayuda para el ejemplo de macro Vídeo, Página de tutoriales relacionada con la macro.

Version

La versión de la macro. Si no se proporciona ningún valor, se establecerá de forma predeterminada en 1.0. Esto es útil para los autores, para que puedan documentar versiones particulares de sus propias macros.

Shortcut

Algunas macros pueden introducir accesos directos para lanzar herramientas específicas. Indique los botones de acceso directo para presionar con este valor. Si no se da ningún valor, por defecto None.

SeeAlso

Optional links to other related commands, for example, SeeAlso=[[Some Tool|Tool]].

Icon

Un archivo de imagen diferente de Name.svg o Name.png para usar como icono. Esto se puede usar para incluir un icono específico que no lleva el nombre del comando, por ejemplo, Icon=Some_other_name.svg