WikiPages/es

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

Antes de empezar

 * Esta documentación wiki está basada en MediaWiki, el mismo software que utiliza Wikipedia. Si has contribuido a la Wikipedia, editar las páginas del wiki de FreeCAD debería ser fácil.
 * A diferencia de Wikipedia, el wiki de FreeCAD está protegido contra la escritura para evitar el spam. Debes solicitar una cuenta en el foro.
 * Si nunca has usado el software wiki antes, por favor lee Ayuda:Edición para familiarizarte con el marcado que se usa.
 * Para el uso avanzado del software wiki, vea Ayuda de MediaWiki:Contenido. No todas las características de MediaWiki están disponibles en este wiki de FreeCAD, pero muchas sí.
 * Nos gusta mantener la documentación fácil de leer, así que evita usar características complejas. Mantén la sencillez.
 * Usa un sandbox para probar tu código, por ejemplo, FreeCADDocu:Sandbox o una página particular con tu nombre Sandbox:Yourname.
 * Por favor, ten en cuenta las traducciones. El wiki de FreeCAD utiliza soporte de traducción automática para proporcionar páginas en muchos idiomas. Para cada página pueden existir múltiples versiones lingüísticas. En muchas páginas verás etiquetas como  y muchas etiquetas simples como  . Estas últimas son creadas por el sistema de traducción. Vinculan los títulos y los párrafos a sus versiones traducidas. No debería cambiarlos, ya que eso destruiría esos enlaces. Sin embargo, puede mover los párrafos o cambiar la redacción siempre que las etiquetas permanezcan con ellos. Si elimina un epígrafe o un párrafo, debe eliminar también la etiqueta que le corresponde. Tenga en cuenta que los cambios en los títulos y párrafos existentes afectan a las traducciones actuales. Sus cambios deben valer la pena. No se preocupe cuando añada nuevo material porque el sistema añadirá nuevas etiquetas automáticamente después de sus ediciones. Para más información, consulte Localización y la página original Mediawiki:Extensión:Traducir.

Descripciones concisas
Cuando describas FreeCAD intenta ser conciso y directo y evita las repeticiones. Describe lo que FreeCAD hace, no lo que FreeCAD no hace. Evita también expresiones coloquiales como "un par". Utilice "algunos" cuando se trate de un número indeterminado, o especifique la cantidad correcta.


 * Mala descripción
 * Ambiente de trabajo DiseñoPieza: el Ambiente de trabajo DiseñoPieza es un ambiente de trabajo para el diseño de piezas que pretende proporcionar herramientas para el modelado de piezas sólidas complejas.


 * Buena descripción
 * Ambiente de trabajo DiseñoPieza: tiene como objetivo proporcionar herramientas para el modelado de piezas sólidas complejas.

Información centralizada
Evite duplicar la misma información en diferentes lugares. Inserte la información en una nueva página, y enlace a esta página desde otras páginas que requieran esta información.

No utilices la transclusión de páginas (Ayuda:Edición#Plantillas y páginas transcluidas), ya que esto dificulta la traducción del wiki. Utiliza sólo las plantillas descritas en #Plantillas.

Estilismo
Las plantillas se utilizan para dar estilo a las páginas de ayuda. Proporcionan a la documentación un aspecto consistente. Hay una plantilla para los comandos del menú,, una plantilla para dar estilo a las teclas a pulsar, , para mostrar un valor booleano, , etc. Por favor, familiarícese con la sección #Plantillas antes de escribir páginas de ayuda.

Banderas temporales
Si está trabajando en una página grande, es aconsejable marcar la página como trabajo en curso o como inacabada. Esto asegura que los administradores del wiki no marquen su página como lista para ser traducida mientras usted todavía la está cambiando.

To flag a page add either  or   as the first line. With  you invite others to join you in finishing the page, while   indicates that you will do the work yourself and others should give you some time.

Once the work is done, please don't forget to remove the flags!

Ejemplos
Para familiarizarse rápidamente con la estructura y el estilo del wiki de FreeCAD mira la página del modelo: Modelo de GuiCommando.

Estructura
The User hub provides a Table of Contents. This is used as the main reference for automatically building the offline help you can reach from FreeCAD, as well as the offline PDF documentation.

The Template:Docnav is used to sequentially link pages, following to the structure of the Table of Contents. See #Templates for a list of all templates.

Nombres de páginas
Page names should be short, and they should use sentence case: all words except the first one and proper names, should be in lowercase. This is the style used by Wikipedia for their articles.


 * Bad page name:
 * Construction Of AeroCompany Airplanes


 * Good page name:
 * Construction of AeroCompany airplanes

The names of top level workbench pages must have this format:, where   is the name of the workbench, for example PartDesign Workbench. And the names of pages describing the commands (or tools) belonging to a workbench must have this format:, for example PartDesign Pad. Note that you should use the command name as it occurs in the source code.

A previous convention was to use title case: every word should begin with a capital letter, unless they are articles, prepositions, conjunctions, or other grammatical particles (f.e. 'of', 'on', 'in', 'a', 'an', 'and'). There are many existing pages using this style, but it is discouraged for new pages. This was discussed in the forum thread (Lowercase links) Use a lower case title for a wiki page.

Rúbricas
Like page names, paragraph headings should be short and use sentence case. You should not use  headings  in your wiki markup since the page title is automatically added as the main   heading.

Enlaces
You should use the original link name for links whenever possible. This clarifies the referenced page in printed or offline documentation. Please avoid non-meaningful words for the link.


 * Bad link
 * For more information on drafting 2D objects click here.


 * Good link
 * For more information on drafting 2D objects refer to the Draft Workbench.

The preferred format for a link is:

Translated:

Note that for the part before the  character, the actual link, case is relevant. If your page name is  the link will fail if you type   (upper case P). Before the  character all spaces should be replaced by underscores. This is to assist translators using translation software, without the underscores the link would be translated by the software which is undesirable.

To link to a certain paragraph add a  sign and its headings to the page name. Example:

Translated:

Within the same page you can omit the page name. Example:

To link to the top of the page you can use:

This link will even work if there is no 'Top' paragraph on the page. It is especially useful for long pages as it allows the user to quickly jump back to the table of content. You can put it at the end of each paragraph. Make sure there is an empty line before and after the link.

Páginas del ambiente de trabajo
A top level workbench page should start with:
 * A description of what the workbench is used for.
 * An image to illustrate the description.

See #Screen capture for conventions on including images.

Páginas de comandos
Command pages describing workbench tools should not be too long, they should only explain what a command can do and what it can't, and how to use it. You should keep pictures and examples to a minimum. Tutorials can expand on how to use the tool and provide step-by-step details.

Please refer to the GuiCommand model page for more details.

Tutoriales
A well written tutorial should teach how to achieve certain practical results quickly. It shouldn't be too long, but should include sufficient step-by-step instructions and images to guide the user. As FreeCAD evolves, tutorials may become obsolete, so it is important to mention the FreeCAD version used in, or required for, a tutorial.

For examples visit the Tutorials page.

Platillas
Styling of the FreeCAD wiki pages is achieved through the use of templates (Help:Editing). They ensure a standardized look and feel across all pages, and also make it possible to re-style the wiki. You can see the complete list of defined templates by accessing Special:PrefixIndex/Template:. But please only use the templates listed in the tables below. Only in very special cases should you use HTML tags directly.

Click on the template link to see the usage instructions for a template, and to see its implementation. Templates are a powerful feature of the MediaWiki software. You should be an experienced wiki user if you wish to propose additions and modifications to existing templates. If implemented incorrectly, templates make it difficult to translate pages into other languages, so their use should be limited to text formatting, page transclusion should be avoided. See MediaWiki Help:Templates to learn more.

Plantillas sencillas
These templates accept a simple text parameter, and format it with a particular style.

Plantillas complejas
These templates require more input parameters, or produce a block of text with a particular format.

Gráficos
Images and screenshots are necessary to produce a complete documentation of FreeCAD. They are particularly useful to illustrate examples and tutorials. Images should be shown in their original size, so they present sufficient detail and are readable if they include text. Bitmap images should not be resized.

Avoid animated pictures (GIF) in the general help pages. Animations and videos should be reserved for tutorials not intended to be used as offline PDF documentation.

Images can be uploaded through the Special:Upload page.

Nombre
Give meaningful names to your images. If you have an image that showcases the characteristics of a particular command, you should use the name of that command with at the end. For example for the command Draft Offset the image should be called.

Captura de pantalla
Recommended sizes for screen captures are:
 * Native 400x200 (or width=400 and height<=200), for command reference pages, to allow the picture to fit in the left part of the page, and for other standard snapshots.
 * Native 600x400 (or width=600 and height<=400), for command reference pages, when you really need a bigger picture, and still allow the picture to fit in the left part of the page, and for other standard snapshots.
 * Native 1024x768 (or width=1024 and height<=768), only for full screen images.
 * Smaller sizes are possible when showing details.
 * Avoid images with larger resolutions, as they won't be very portable to other kinds of displays or the printed PDF documentation.

You shouldn't depend on a custom configuration of your desktop or operating system when you create screenshots and you should use the visual defaults of the FreeCAD interface whenever possible.

To create a screenshots you can use the options provided by your operating system, or one of these macros: Macro Snip and  Macro Screen Wiki.

Texto
To ease documentation translations, try to avoid screenshots that contain texts. If you cannot avoid this, consider taking separate screenshots of the interface and the 3D view. The image of the 3D view can be reused in every translation, while a translator can take a screenshot of the localized interface if necessary.

Iconos y gráficos
Refer to the Artwork page for all artwork and icons that have been created for FreeCAD, and which can also be used in documentation pages. If you would like to contribute icons, please read the Artwork Guidelines.

Traducciones
Según el consenso general, la página de referencia en la wiki es la página inglesa, que debería crearse primero. Si quieres cambiar o añadir contenido a una página, debes hacerlo primero en la página inglesa, y sólo una vez completada la actualización, portar la modificación a la página traducida. As per general consensus, the reference page in the wiki is the English page, which should be created first. If you want to change or add content to a page, you should do it to the English page first, and only once the update is completed, port the modification to the translated page.

The FreeCAD wiki supports a translation extension that allows managing translations between pages easier; for details, see Localisation Translating the wiki.

Other useful resources are:
 * ISO language codes to identify the two-letter code for a particular language that you want to translate to.
 * Google Translate for help with translations.
 * Deepl translator for help with translations.

Traducir GuiCommando
Translated:

Traducir navi
Translated:

Traducir enlace
Part Module

Translated:

Atelier Pièces /

Traducir Docnav
Translated:

Example with icons:

Translated:

Cambiar el nombre de las páginas
Since FreeCAD is a project under permanent development, it is sometimes necessary to revise the content of the wiki. If the names of commands are changed in the source code, the wiki pages documenting them have to be renamed as well. This can only be done by wiki administrators. To inform them, open a topic in the Wiki forum and list the necessary renaming operation in this form:

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
In case you need to delete a file, go to its page and edit it. No matter if the page is blank or not, add this as the first element:  and directly below it describe why the page should be deleted. Additionally, open a topic in the Wiki forum.

For pages the procedure is the same.

Debate
The Development/Wiki subforum in the FreeCAD forum provides a dedicated space for discussing wiki topics, the wiki appearance and anything else related to the wiki. Direct your questions and suggestions there.

Inglés
See Glossary.

Otros idiomas

 * Italiano
 * Français
 * Deutsch
 * Polish