Meta:ES/Guides/ReferenceBox

From BlenderWiki

Esta Guía de Cajas de Referencia es una adaptación libre de la original inglesa Meta/ReferenceBoxGuidelines. Se ha añadido a la plantilla Template:RefBox soporte para el español (es).

Las cajas de referencia pueden ser usadas siguiendo los siguientes ejemplos de código. Puedes utilizar versiones de lenguaje localizado de la plantilla ingresando tu código de lenguaje de dos letras en el campo "lang=", por ejemplo, "es" muestra la plantilla en Español.

 {{RefBox
 |mode=Tipo de Modo
 |panel=Contexto → Nombre del panel
 |hotkey={{K|A}}
 |menu=Menú → Sub-Menú 
 |lang=es
 }}
 

Estas son guías para presentar ítemes de referencia y los elementos de información usadas para documentarlos.

• Los elementos marcadas como ESENCIAL son información crucial y deben ser incluidos en cada ítem de referencia, debido a que son importantes para esa herramienta en particular. Ítemes sin esta información podrían ser inútiles como referencia.
• Los elementos marcadas como RECOMENDADO deberían ser incluidas, pero no son 100% necesarias para que el ítem esté en la documentación.
• Los elementos marcadas como ÚTIL son información útil que sería bueno incluir si es relevante y aplicable.

Ver User:Broken/ReferenceBoxTest para ejemplo de este uso.

---

[edit] Nombre de la Herramienta u Opción (como ésta aparece en la IU de Blender)

[edit] Descripción

Una visión general de qué hace la herramienta, desde la perspectiva del artista, incluyendo sobre qué tipo de entradas opera (p.e. 'objetos' o 'bordes seleccionados'). La información técnica detallada no debería estar aquí. ESENCIAL

[edit] Opciones

Si una herramienta presenta opciones adicionales como un menú adicional, botones desplegables, o botones en paneles, deberían ser descritos aquí. (p.e. las opciones de la herramienta subdividir para el número de cortes, o la forma en que cortará las esquinas de los 'quads').

El marcado de listas de definición puede ser útil aquí para describir opciones múltiples si hay varias de las cuales escribir. Por ejemplo:

; Nombre de la opción
: La descripción e información adicional va aquí.
; Otra opción
: y su información...

producirá lo siguiente:

Nombre de la opción

La descripción e información adicional va aquí.

Otra opción

y su información...

ESENCIAL.

[edit] Ejemplos

Imágenes de ejemplo o texto para demostrar como puede ser utilizada esta herramienta en particular, o qué efectos tiene. Esto debería ser una breve demostración, no un tutorial. RECOMENDADO.

[edit] Detalles Técnicos

Información extra que no es crucial para que un artista use la herramienta como una 'caja negra', pero que puede ser interesante o útil para que alguien con una mente más técnica pueda ganar entendimiento adicional en su uso. (p.e. fórmulas y gráficos para la distribución y decaimiento de la iluminación) ÚTIL.

[edit] Consejos

Consejos o trucos que pueden ser útiles cuando se use esta herramienta o combinándola con otras herramientas. ÚTIL

[edit] Optimización

Métodos para optimizar su uso, tanto para acelerar la operación o renderizado, como para mejorar la calidad visual o facilitar/acelerar su utilización. ÚTIL.

[edit] Limitaciones

Si hay limitaciones o problemas con la herramienta tal y como está implementada actualmente, puede ser una buena idea mencionarlos, y si hay forma en que los usuarios puedan superarlos. (p.e. la herramienta de biselado de malla (mesh) solo bisela la malla completa, no una selección. Esto puede superarse separando las caras necesarias en una malla separada, o usando el script bevel center (biselar centro)). ÚTIL.

[edit] Ver También

• Vínculos a otras páginas wiki o herramientas relacionadas, opciones o teoría que pueda ser útil conocer para alguien que use esta herramienta. Debe hacerse en una lista no ordenada. Los vínculos web podrían estar aquí también. RECOMENDADO