From BlenderWiki

Jump to: navigation, search


Traducción en progreso
Está pagina se encuentra en proceso de traducción y tiene responsable asignado. Si estás interesado en contribuir con la traducción, por favor verifica previamente la Lista de quehaceres. JuanD



Guía de estilo



Para mantener la consistencia en toda la Documentación Blender, se solicita a los autores que sigan las recomendaciones en la presente Guía de Estilo. Esta Guía de Estilo es una adaptación libre de la original inglesa Style Guide.

Para la gente que desconozca la terminología y sintáxis de MediaWiki, se pueden dirigir también a la MediaWiki Docs oficial.



Generalidades

La documentación de Blender debe ser escrita en un Español claro, conciso y lingüísticamente correcto.

Ésta se divide en capítulos, secciones y subsecciones.

La subdivisión lógica del Corpus documental es dictado por el Documentation Board. Ninguna página nueva será añadida excepto aquellas que sean aprobadas.

La subdivisión lógica de cualquier Tutorial contribuida se deja en manos de su autor. Los Tutoriales deberían contener un resumen de hasta 300 palabras describiendo los tópicos, intereses y contenidos para una rápida navegación.

Estructura del documento

Todos los documentos siguen la siguiente estructura:

Cabecera

Cada página debería tener una plantilla apropiada como Primera línea para mostrar ayudas en la navegación y en qué versión de Blender fue actualizada. Esto se hace mediante:

{{Page/Header|Version.Blender|Manual.es/Pagina.anterior|Manual.es/Pagina.siguiente}}

Cuyo resultado en pantalla es:


Cuerpo Textual

Se mostrarán a continuación las plantillas y formatos de texto así como la inclusión de las imágenes que se utilizarán en todas las páginas como referencia:

Estructura Interna

Para diferenciar entre secciones, subsecciones, divisiones menores y subdivisiones se utilizarán los siguientes commandos:

  • = TÍTULO = - Es una sección.
  • == TÍTULO2 == - Es una subsección de una sección.
  • === TÍTULO3 === - Es una división menor de una subsección.
  • ==== TÍTULO4 ==== - Es una subdivisión de una división menor.
Nota:

Esta estructura, junto con la plantilla de la cabecera, creará automáticamente la Tabla de Contenidos. Si, por alguna cosa extraña (puede ocurrir) no la muestra, justo después de la plantilla de cabecera, en la siguiente línea, se escribe __TOC__ y te la creará.

Nota:

Como puede observar, no es necesario numerar las secciónes y demás, MediaWiki se encarga automáticamente de la numeración.

Plantillas

Hay varias plantillas disponibles para utilizar en las páginas de la documentación. Sólo mencionaremos aquellas que por su generalidad son útiles y recomendadas:

  • UM/navigator.es - Es la plantilla de navegación para la cabecera que se ha comentado anteriormente.
  • {{Literal|TEXTO QUE SE DESEE}} - Esto producirá que el texto se muestre en azul (lo puede ver en el punto anterior). Se utilizará cuando nos refiramos a una etiqueta, un menú o una variable del programa.
  • {{KEY|CONJUNTO DE TECLAS}} - Esto producirá que el texto introducido se muestre como I, siendo el texto introducido TECLA-I. Se utilizará también para términos como BMR y relacionados.
  • {{Tip|TITULO|TEXTO A LEER}} - Esto producirá una salida parecida a la siguiente:
Hola: He escrito 'Hola' y lo ha puesto automáticamente en una caja y con negrita.
  • {{Css/prettytable|PORCENTAJE}} - Esto producirá una tabla estándar de las que puedes ver en todo el Manual. Puede leer más sobre tablas en el enlace suministrado al comenzar la página.
  • {{Version|VERSION}} - Esto creará una cajetilla de texto que mostrará la versión de Blender. Lo puede ver aquí:


Blender VERSION+



  • Hay una última plantilla que, en sí misma, no sirve para nada excepto para aquellos casos en los que nos interese que un objeto no se introduzca en la sección siguiente. Para ello utilizaremos el comando {{clr}} dos veces. La primera para marcar el comienzo y la segunda para marcar el final. Un ejemplo lo puede "ver" en el punto anterior: la cajetilla "versión" se incluía a la derecha en este párrafo, pero encerrándola entre el {{clr}} se ha mantenido en su sección.

Formato de Texto

Aquí se mostrarán las características básicas que utilizaremos para el formato de texto:

  • Negrita - Se consigue encerrando el texto entre un par de ''' (tres comillas simples consecutivas).
  • Cursiva - Se consigue encerrando el texto entre un par de '' (dos comillas simples consecutivas).
  • Para introducir un tabulado al comienzo de la línea, introduce el carácter : al comienzo de la misma (signo dos puntos).
  • Listas sin numerar como la de estos puntos - Se consiguen introduciendo el carácter * (estrella) al comienzo de la línea.
  • Listas numeradas - Se consiguen introduciendo el carácter # (almohadilla) al comienzo de la línea.
  • Tabulador (5 espacios al comienzo de línea) - Se consigue introduciendo uno o varios caracteres : al comienzo de la línea, dependiendo de los niveles que queramos de tabulado.
¡CUIDADO!: Debes de tener cuidado con las siguiente cosas:
  • Dejar un doble espacio entre párrafos crea un nuevo párrafo.
  • Dejar un espacio al principio de la línea, introduce dicha línea en un cajetín.

Imágenes

Hay tres métodos diferentes de incluir una imagen:

Imágenes normales

Utilizaremos el siguiente comando:

[[Image:Manual-Part-XII-rad01.png|frame|none|Radiosity example]]

Cuya salida por pantalla es:

Radiosity example

Las imágenes no tendremos que subirlas, pues ya están en el servidor. Sólo tendremos que verificar el nombre de la imagen guardada en el mismo.

En caso de necesitar subir alguna, pulsad sobre el enlace Upload file del menú de la izquierda.

Imágenes flotantes
Dummy image
Hay otro tipo de imágenes en MediaWiki y son aquellas que se muestran flotando sobre el lado derecho de la página. Para introducirlas utilizaremos el siguiente comando:
[[Image:Dummy.jpg|right|thumb|200px|Dummy image]]

Cuya salida por pantalla es:


Imágenes en el texto

Este último tipo se introducen entre el texto:

Está incrusta[[Image:DemoImage2.png]]a en el texto.

Cuya salida por pantalla es:

Está incrustaDemoImage2.pnga en el texto.

Tablas

Puede consultar una lista de ejemplos aquí: Style Guide - Tables.

Para crear las tablas utilizaremos la plantilla definida {{Css/prettytable|porcentaje}}, donde porcentaje es el porcentaje del ancho de pantalla que se utilizará para mostrar la tabla. Si no se indica ningún número, se supone un 100%.

Aquí puede ver un ejemplo de tabla:

 {| {{Css/prettytable}}
  ! Cabecera !! 2da Cabecera !! Todo en negrita
  |-
  | elemento1 || elemento2 ||align="center"| centrado
  |}
 

Cuya salida por pantalla es:

Cabecera 2da Cabecera Todo en negrita
elemento1 elemento2 centrado

Código fuente

Para introducir código fuente, incluya el texto entre los comandos <nowiki>TEXTO</nowiki>. Si, además, incluye un espacio al principio de la línea, el texto se incluirá automáticamente en un cajetín.

Pie de Página

Cada página debería terminar con una plantilla apropiada como Última línea para mostrar ayudas en la navegación. Esto se hace mediante:

{{Page/Footer|Manual.es/Pagina.anterior|Manual.es/Pagina.siguiente}}

Cuyo resultado en pantalla es:




Conclusiones

Puede ver el código fuente de las páginas aunque no tenga permisos para modificarlas y así comprender un poco más, a través de ejemplos, cómo funciona el código de MetaWiki.