WikiPages/es

Esta página es una extensión de la página Ayuda:Edición y proporciona pautas comunes para escribir y actualizar la documentación wiki de FreeCAD. Resume varias discusiones y sesiones de tormentas de ideas.

Antes de empezar

Directrices generales

Descripciones concisas

Al describir FreeCAD, sea conciso y directo, evitando repeticiones. Describa lo que FreeCAD «hace», no lo que «no hace». Evite también expresiones coloquiales como «un par». Use «algunos» cuando se trate de una cantidad indeterminada o especifique la cantidad correcta.

Descripción incorrecta: PartDesign Workbench: PartDesign Workbench es un entorno de trabajo para el diseño de piezas que tiene como objetivo proporcionar herramientas para modelar piezas sólidas complejas.

Buena descripción: PartDesign Workbench: tiene como objetivo proporcionar herramientas para modelar piezas sólidas complejas.

Información centralizada

Evite duplicar la misma información en distintos lugares. Inserte la información en una página nueva y cree un enlace a esta nueva página desde otras páginas que requieran la información.

No utilice la transclusión de páginas (Help:Editing#Templates_and_transcluding_pages:Editing#Templates and transcluding pages), ya que esto dificulta la traducción de la wiki. Utilice únicamente las plantillas descritas a continuación en #Plantillas.

Estilismo

Las plantillas se utilizan para dar estilo a las páginas de ayuda. Proporcionan a la documentación una apariencia uniforme. Hay una plantilla para los comandos de menú, Archivo → Guardar, una plantilla para dar estilo a las teclas que se deben pulsar, Shift, para mostrar un valor booleano, true, etc. Familiarícese con la sección #Templates antes de escribir las páginas de ayuda.

Banderas temporales

Si está trabajando en una página extensa, es recomendable marcarla como en proceso o como incompleta. Esto garantiza que los administradores de la wiki no la marquen como lista para traducir mientras aún la está modificando.

Para marcar una página, añada {{Página en progreso}} o {{Documentación sin terminar}} como primera línea. Con {{Documentación sin terminar}} invitas a otros a unirse para terminar la página, mientras que {{Página en progreso}} indica que usted hará el trabajo y que los demás deben darle algo de tiempo.

Por favor, una vez finalizado el trabajo, ¡no olvide retirar las banderas!

Ejemplos

Para familiarizarse rápidamente con la estructura y el estilo de la wiki de FreeCAD, consulte la página del modelo: Modelo GuiCommand.

Estructura

El Centro de usuarios proporciona una Tabla de contenido. Esta se utiliza como referencia principal para generar automáticamente la ayuda sin conexión a la que se puede acceder desde FreeCAD, así como la documentación en PDF sin conexión.

La plantilla Template:Docnav se utiliza para enlazar páginas de forma secuencial, siguiendo la estructura de la Tabla de contenido. Consulte #Templates para ver una lista de todas las plantillas.

Nombres de páginas

Los nombres de las páginas deben ser cortos y deben usar mayúsculas iniciales: cada palabra debe comenzar con una letra mayúscula, a menos que sean artículos, preposiciones, conjunciones u otras partículas gramaticales (por ejemplo, 'de', 'en', 'un', 'una', 'una', 'y').

Nombre de página incorrecto

Construcción de aviones de AeroCompany

Nombre de página adecuado

Construcción de aviones de AeroCompany

Los nombres de las páginas de nivel superior del entorno de trabajo deben tener este formato: XYZ Workbench, donde XYZ es el nombre del entorno de trabajo, por ejemplo, Entorno de Trabajo de diseño de Piezas. Y los nombres de las páginas que describen los comandos (o herramientas) pertenecientes a un entorno de trabajo deben tener este formato: XYZ Command, por ejemplo PartDesign Pad. Tenga en cuenta que debe usar el nombre del comando tal como aparece en el código fuente.

Rúbricas

Los encabezados de párrafo deben ser cortos y usar mayúsculas y minúsculas: todas las palabras, excepto la primera y los nombres propios, deben estar en minúsculas. No debe usar encabezados H1 (= Heading =) en su marcado wiki, ya que el título de la página se agrega automáticamente como el encabezado principal H1.

Enlaces

Siempre que sea posible, utilice el nombre original del enlace. Esto facilita la identificación de la página en la documentación impresa o en línea. Evite usar palabras irrelevantes en el enlace.

Enlace incorrecto
Para obtener más información sobre el diseño de objetos 2D, haga clic aquí.
Enlace útil
Para obtener más información sobre el dibujo de objetos 2D, consulte el Entorno de trabajo de Dibujo.

El formato preferido para un enlace es:

[[Name_of_Page|Nombre de la página]]

Traducido:

[[Name_of_Page/es|Nombre de la Página]]

Tenga en cuenta que, para la parte anterior al carácter |, el enlace real, con mayúsculas y minúsculas, es relevante. Si el nombre de su página es Nombre_de_la_página, el enlace fallará si escribe Nombre_de_la_Página (P mayúscula). Antes del carácter |, todos los espacios deben reemplazarse por guiones bajos (_). Esto es para ayudar a los traductores que utilizan software de traducción; sin los guiones bajos, el enlace sería traducido directamente por el software, lo que produciría errores indeseables.

Para enlazar a un párrafo específico, agregue el signo # y sus encabezados al nombre de la página. Ejemplo:

[[WikiPages#Links|WikiPages]]

Traducido:

[[WikiPages/es#Enlaces|WikiPages]]

Dentro de la misma página puede omitir el nombre de la página. Ejemplo:

[[#Links|Enlaces]]

Para enlazar con la parte superior de la página puede usar:

</translate>{{Top}}<translate>

Esta plantilla debería mostrar automáticamente el texto correcto según el idioma de la página. Un enlace al inicio de la página es especialmente útil para páginas largas, ya que permite al usuario volver rápidamente al índice. Puede colocarlo al final de cada párrafo. Asegúrese de dejar una línea en blanco antes y después de la plantilla.

Enlace de la imagen
24px|Texto opcional que se muestra al pasar el cursor sobre la imagen|link=Draft_Wire

Para usar una imagen como enlace:

[[Image:Draft_Wire.svg|24px|Texto opcional que se muestra al pasar el ratón por encima de la imagen|link=Draft_Wire]]

Enlace de imagen + enlace de texto
Alambre de borrador

Si omite el texto opcional, el enlace se mostrará al pasar el cursor sobre la imagen, lo cual es preferible, y también debería agregar un enlace de texto después del enlace de la imagen:

[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire|Alambre de borrador]]

Páginas del ambiente de trabajo

La página principal de un entorno de trabajo debe comenzar con:

  • Una descripción de para qué se utiliza el entorno de trabajo.
  • Una imagen para ilustrar la descripción.

Consulte #Captura_de_pantalla para conocer las convenciones sobre cómo incluir imágenes.

Páginas de comandos

Las páginas de comandos que describen las herramientas del entorno de trabajo no deben ser demasiado largas; solo deben explicar qué puede hacer un comando, qué no puede hacer y cómo usarlo. Se recomienda minimizar el uso de imágenes y ejemplos. Los tutoriales pueden ampliar la explicación sobre cómo usar la herramienta y proporcionar instrucciones paso a paso.

Consulte la página Modelo GuiCommand para obtener más detalles.

Tutoriales

Un buen tutorial debe enseñar cómo lograr resultados prácticos rápidamente. No debe ser demasiado largo, pero sí incluir instrucciones paso a paso e imágenes suficientes para guiar al usuario. A medida que FreeCAD evoluciona, los tutoriales pueden quedar obsoletos, por lo que es importante mencionar la versión de FreeCAD utilizada o requerida para el tutorial.

Para ver ejemplos, visite la página Tutoriales.

Plantillas

El estilo de las páginas wiki de FreeCAD se logra mediante el uso de plantillas (Help:Editing#Templates_and_transcluding_pages). Estas garantizan una apariencia uniforme en todas las páginas y permiten personalizar el estilo de la wiki. Puede consultar la lista completa de plantillas definidas accediendo a Special:PrefixIndex/Plantilla:. Sin embargo, utilice únicamente las plantillas que aparecen en las tablas a continuación. Solo en casos muy específicos debe usar etiquetas HTML directamente.

Haga clic en el enlace de la plantilla para ver las instrucciones de uso y su implementación. Las plantillas son una función muy útil del software MediaWiki. Si desea proponer adiciones o modificaciones a las plantillas existentes, debe ser un usuario experimentado de wikis. Si se implementan incorrectamente, las plantillas dificultan la traducción de páginas a otros idiomas, por lo que su uso debe limitarse al formato de texto y debe evitarse la transclusión de páginas. Consulte MediaWiki Help:Templates para obtener más información.

Plantillas sencillas

Estas plantillas aceptan un parámetro de texto simple y lo formatean con un estilo específico.

Plantilla Apariencia Descripción
Arriba

Inicio

Úselo para añadir un enlace en la parte superior de la página.
Emphasis Énfasis Úselo para enfatizar un fragmento de texto.
TECLA Alt Úsela para indicar una tecla del teclado que debe presionarse.
ASCII Úselo para indicar una tecla ASCII en una imagen (.svg) que deba presionarse. Debe indicar el carácter deseado o el número de su código ASCII.
Button Cancel Úselo para indicar un botón en la interfaz gráfica de usuario que debe presionarse.
RadioButton Option Úselo para indicar un botón de opción en la interfaz gráfica de usuario que debe estar Selected o Not.
CheckBox Option Úselo para indicar una casilla de verificación en la interfaz gráfica de usuario que debe estar Marcada o No.
SpinBox 1.50 Úselo para indicar un cuadro de selección en la interfaz gráfica de usuario que necesita ser modificado.
ComboBox Menu 1 Úselo para indicar un cuadro combinado en la interfaz gráfica de usuario que necesita ser modificado.
LineEdit Metal Nickel (Ni) Úselo para indicar un LineEdit en la interfaz gráfica de usuario que necesite ser modificado.
FALSE, false false, false Úselo para indicar un valor booleano Falso, por ejemplo, como una propiedad en el editor de propiedades. Esto es un atajo. Dado que es un valor, es preferible la plantilla Valor falso.
TRUE, true true, true Úselo para indicar un valor booleano verdadero, por ejemplo, como una propiedad en el editor de propiedades. Esto es un atajo. Dado que es un valor, prefiera la plantilla Valor verdadero.
MenuCommand File → Save Úselo para indicar la ubicación de un comando dentro de un menú específico.
FileName File name Úselo para indicar el nombre de un archivo o directorio.
SystemInput Type this text Úselo para indicar el texto introducido por el usuario.
SystemOutput Output text Úselo para indicar la salida de texto del sistema.
Incode import FreeCAD Úselo para incluir código fuente en línea con una fuente monoespaciada. Debería caber en una sola línea.
PropertyView VistaColor Úselo para indicar una propiedad de Vista en el editor de propiedades. Ejemplos de propiedades de Vista incluyen Line Color, Line Color, Line Width, Point Color, Point Size, etc.
PropertyData DatosPosition Úselo para indicar una propiedad de datos en el editor de propiedades. Las propiedades de datos son diferentes para distintos tipos de objetos.
Properties Title / TitleProperty Base Úselo para indicar el título de un grupo de propiedades en el editor de propiedades. El título no se incluirá en la tabla de contenido automática.
Obsolete obsolete in 0.19 Úselo para indicar que una función quedó obsoleta en la versión de FreeCAD especificada.
VersionNoteObsolete obsolete in 0.19 Idem (variante en superíndice).
Version introduced in 0.18 Úselo para indicar que se introdujo una función en la versión de FreeCAD especificada.
VersionNote introduced in 0.18 Idem (variante en superíndice).
VersionMinus 0.16 and below Úselo para indicar que una función está disponible en la versión de FreeCAD especificada y en versiones anteriores.
VersionNoteMinus 0.16 and below Idem (variante superíndice).
VersionPlus 0.17 and above Úselo para indicar que una función está disponible en la versión de FreeCAD especificada y en versiones posteriores.
VersionNotePlus 0.17 and above Idem (variante superíndice).
ColoredText Colored Text Utilice esta plantilla para colorear el fondo, el texto o ambos. (Consulte la página ColoredText para ver más ejemplos).
ColoredParagraph
Colored Paragraph
Utilice esta plantilla para colorear el fondo, el texto o ambos de un párrafo completo. (Consulte la página ColoredParagraph para ver más ejemplos).

Plantillas complejas

Estas plantillas requieren más parámetros de entrada o generan un bloque de texto con un formato específico.

Plantilla Apariencia Descripción
Prettytable Esta tabla Úsela para formatear tablas como esta. Se pueden agregar propiedades adicionales a la tabla.
Caption

Some caption for an image

Úsalo para añadir una explicación debajo de una imagen. Se puede alinear a la izquierda o al centro.
Clear Úsela para borrar columnas. Consulte la definición de la plantilla para obtener una explicación detallada. Se suele usar para evitar que el texto aparezca junto a imágenes no relacionadas.
Code
import FreeCAD
Úselo para incluir ejemplos de código de varias líneas con una fuente monoespaciada. El lenguaje predeterminado es Python, pero se pueden especificar otros lenguajes.

El código Python debe ajustarse a las recomendaciones generales establecidas en PEP8: Style Guide for Python Code. En particular, los paréntesis deben seguir inmediatamente al nombre de la función, y debe haber un espacio después de una coma. Esto facilita la lectura del código.

CodeDownload Úselo para crear un enlace en una página macro.
Codeextralink

Temporary code for external macro link. Do not use this code. This code is used exclusively by Addon Manager. Link for optional manual installation: Macro


# This code is copied instead of the original macro code
# to guide the user to the online download page.
# Use it if the code of the macro is larger than 64 KB and cannot be included in the wiki
# or if the RAW code URL is somewhere else in the wiki.

from PySide import QtGui, QtCore

diag = QtGui.QMessageBox(QtGui.QMessageBox.Information,
    "Information",
    "This macro must be downloaded from this link\n"
    "\n"
    "https://wiki.freecad.org/Main_Page" + "\n"
    "\n"
    "Quit this window to access the download page")

diag.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint)
diag.setWindowModality(QtCore.Qt.ApplicationModal)
diag.exec_()

import webbrowser 
webbrowser.open("https://wiki.freecad.org/Main_Page")
<class="rawcodeurl"><a href="https://wiki.freecad.org/Main_Page">raw code</a>
Úselo si el código de una macro es demasiado grande para alojarlo en la Wiki. El código se puede alojar en otro lugar y el enlace directo se especifica con esta plantilla. El Administrador de complementos utilizará este enlace.
Fake heading
Heading
Úselo para crear un encabezado que no se incluirá automáticamente en la tabla de contenido.
GuiCommand See GuiCommand model Úselo para crear un cuadro con información útil para documentar los comandos (herramientas) del entorno de trabajo.
TutorialInfo See for example Basic modeling tutorial Úselo para crear un cuadro con información útil para documentar tutoriales.
Macro See for example Macro FlattenWire Úselo para crear un cuadro con información útil para documentar macros.
Docnav
Online Help Startpage
Feature list
Úselo para crear una barra con flechas y enlaces apropiados, lo cual resulta útil para colocar las páginas en una secuencia determinada.
VeryImportantMessage
Important Message
Úselo para crear un recuadro resaltado con un mensaje muy importante. Úselo con moderación, solo para indicar problemas importantes en el funcionamiento del software, la eliminación de herramientas y situaciones similares.
Page in progress
This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.
Utilice esto para páginas que aún estén en desarrollo o que se estén revisando. No olvide eliminarlo cuando la página esté lista.
UnfinishedDocu

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Úselo para crear un cuadro resaltado que indique una página de documentación incompleta.
Softredirect Úselo en lugar de la redirección normal cuando redirija a una página especial (como Media: o Category:), en cuyo caso la redirección normal está deshabilitada.
Quote

Cry "Havoc" and let slip the dogs of war.

—William Shakespeare, Julius Caesar, act III, scene I
Úselo para crear un cuadro de texto con una cita literal y una referencia.
Userdocnavi, Powerdocnavi Úselas para crear cuadros de navegación para la documentación del usuario, la documentación para usuarios avanzados y la documentación para desarrolladores. Esto permite navegar rápidamente entre las diferentes secciones de la documentación. Además, ubican la página correspondiente en la categoría adecuada.

Gráficos

Las imágenes y capturas de pantalla son necesarias para elaborar una documentación completa de FreeCAD. Son especialmente útiles para ilustrar ejemplos y tutoriales. Las imágenes deben mostrarse en su tamaño original para que presenten suficiente detalle y sean legibles si incluyen texto. Las imágenes de tipo Bitmap no deben redimensionarse.

Evite usar imágenes animadas (GIF) en las páginas de ayuda general. Las animaciones y los vídeos deben reservarse para tutoriales que no estén destinados a ser utilizados como documentación PDF sin conexión.

Las imágenes se pueden subir a través de la página Special:Upload.

Nombre

Asigne nombres descriptivos a sus imágenes. Si tiene una imagen que muestre las características de un comando específico, utilice el nombre de dicho comando seguido de _example. Por ejemplo, para el comando Draft Offset, la imagen debería llamarse Draft_Offset_example.png.

Captura de pantalla

Los tamaños recomendados para capturas de pantalla son:

  • 400x200 (o ancho=400 y alto<=200) para páginas referencia de comando, para que la imagen se ajuste a la parte izquierda de la página, y para otras capturas estándar.
  • 600x400 (o ancho=600 y alto<=400) para páginas referencia de comando, cuando se necesita una imagen más grande y que aún así se ajuste a la parte izquierda de la página, y para otras capturas estándar.
  • 1024x768 (o ancho=1024 y alto<=768) solo para imágenes a pantalla completa.
  • Se pueden usar tamaños más pequeños al mostrar detalles.
  • Evite imágenes con resoluciones altas, ya que no se adaptarán bien a otros tipos de pantallas ni a la documentación PDF impresa.

Al crear capturas de pantalla no debe aparecer con una configuración personalizada de su ordenador o sistema operativo. Siempre que sea posible, debe utilizar la configuración visual predeterminada de la interfaz de FreeCAD.

Para crear capturas de pantalla puede usar las opciones que le ofrece su sistema operativo o una de estas macros: Macro Snip y Macro Screen Wiki.

Texto

Para facilitar la traducción de la documentación, intente evitar las capturas de pantalla con texto. Si no puede evitarlo, considere tomar capturas de pantalla separadas de la interfaz y la vista 3D. La imagen de la vista 3D se puede reutilizar en todas las traducciones, mientras que el traductor puede tomar una captura de pantalla de la interfaz localizada si es necesario.

Iconos y gráficos

Consulte la página Artwork para ver todas las ilustraciones e iconos creados para FreeCAD, que también pueden utilizarse en las páginas de documentación. Si desea contribuir con iconos, lea las Artwork Guidelines.

Traducciones

Según el consenso general, la página de referencia en la wiki es la versión en inglés, que debe crearse primero. Si desea modificar o añadir contenido a una página, debe hacerlo primero en la versión en inglés y, solo una vez finalizada la actualización, trasladar la modificación a la versión traducida.

La wiki de FreeCAD admite una extensión de traducción que facilita la gestión de las traducciones entre páginas; para obtener más información, consulte Localisation Translating the wiki.

Otros recursos útiles son: * Códigos de idioma ISO para identificar el código de dos letras del idioma al que desea traducir.

Algunos consejos para los traductores

Traducir GuiCommando

{{GuiCommand
|Name=FEM EquationFlux
|MenuLocation=Solve → Flux equation
|Workbenches=[[FEM_Workbench|FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}

Traducido:

{{GuiCommand/fr
|Name=FEM EquationFlux
|Name/fr=FEM Équation d'écoulement
|MenuLocation=Solveur → Équation de flux
|Workbenches=[[FEM_Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM Tutoriel]]
}}

Traducir enlace

{{FEM_Tools_navi}}

Traducido:

{{FEM_Tools_navi/fr}}

Traducir enlace

[[Part_Workbench|Part Workbench]]

Traducido:

[[Part_Workbench/fr|Atelier Part]]

Traducir Docnav

{{Docnav
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}

Traducido:

{{Docnav/fr
|[[About_FreeCAD/fr|À propos de FreeCAD]]
|[[Installing_on_Windows/fr|Installation sous Windows]]
}}

Ejemplo con iconos:

{{Docnav
|[[Std_Save|Save]]
|[[Std_SaveCopy|SaveCopy]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

Traducido:

{{Docnav/fr
|[[Std_Save/fr|Enregistrer]]
|[[Std_SaveCopy/fr|Enregistrer une copie]]
|[[Std_File_Menu/fr|Menu fichier]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

Crear, renombrar y borrar páginas

Create pages

Antes de crear una página nueva, compruebe si ya existe una similar. En ese caso, suele ser mejor editar la página existente. Si tiene dudas, consulte primero el foro Wiki [1].

Para crear una página nueva, haga una de las siguientes acciones:

  • Visite la URL con el nombre de página deseado, por ejemplo: https://wiki.freecad.org/My_New_Page, y haga clic en «Crear esta página».
  • Realice una búsqueda en la wiki con el nombre de la página y haga clic en el texto rojo que dice «¡Crea la página "Mi nueva página" en esta wiki!».

Cambiar el nombre de las páginas

Dado que FreeCAD es un proyecto en desarrollo permanente, a veces es necesario revisar el contenido de la wiki. Si se modifican los nombres de los comandos en el código fuente, también deben renombrarse las páginas de la wiki que los documentan. Esto solo pueden hacerlo los administradores de la wiki. Para informarles, abra un tema en el foro de la wiki [2] e indique la operación de cambio de nombre necesaria de la siguiente forma:

old name         new name
Old_page_name_1  New_page_name_1
Old_page_name_2  New_page_name_2
...

Eliminar archivos y páginas

En caso de que necesite eliminar un archivo, vaya a su página (https://wiki.freecad.org/File:***.***) y edítela. No importa si la página está en blanco o no, agregue esto como primer elemento: {{Delete}} y justo debajo describa por qué se debe eliminar la página. Además, abra un tema en el foro Wiki.

Para las páginas el procedimiento es el mismo.

Debate

El subforo Desarrollo/Wiki del foro FreeCAD forum ofrece un espacio dedicado a debatir temas relacionados con la wiki, su apariencia y cualquier otro asunto al respecto. Dirija sus preguntas y sugerencias allí.

Terminología - política de nomenclatura

Inglés

Ver Glosario

Otros idiomas