Elementos generales de estilo

A continuación mostramos algunos elementos generales de estilo, para que el aspecto de todos los artículos de la documentación sea parecido.

La norma general que debemos tener en cuenta es: no modificar el estilo del documento que estamos editando. Es decir no debemos cambiar el tipo y el tamaño de la fuente, su color, su alineación, etc. De estas cuestiones se ocupa la plantilla que controla el aspecto general del portal de documentación.

Esto no entra en contradicción con que en algunos casos debamos modificar el estilo en alguno de los artículos de la documentación. Pero siempre que exista alguna justificación no estética para hacerlo. Por ejemplo en un artículo dedicado al uso del color puede ser necesario cambiar el color de un texto para resaltar lo que se mostará luego en una escena. Pero no cambiaremos el color de un título por que nos parezca más elegante.

Tras el salto introducido con el botón Insertar etiqueta More mencionaremos algunas cuestiones relativas al estilo que debemos tener en  cuenta. La primera es que, si el artículo es largo, conviene realizar una introducción a cada artículo, o comentar aspectos generales, y después incluir un enlace Leer más. También podemos dividir un artículo en varias páginas, lo que mencionaremos más adelante.

Uso de Títulos

Los títulos disponibles para el tamaño del texto se corresponden con las etiquetas h1 a h6 habituales en html. El texto principal del artículo consideramos que es su título, que va en Tamaño 1. A partir de ahí se pueden usar los siguientes tamaños, comenzando con Tamaño 2 para títulos de apartados, Tamaño 3 para subapartados, etc. El cuerpo del artículo irá en tamaño párrafo.

Observa que los títulos no acaban en punto.

Formato de texto

Para resaltar texto conviene usar la opción negrita. Al hacerlo se añade la etiqueta <strong> al texto y así dejamos que sea la plantilla la que determine el aspecto del texto resaltado. Podemos usar cursiva para términos técnicos (applet), títulos y extranjerismos, pero como norma general no conviene emplearla demasiado, pues puede ser difícil de distinguir.

Solo es conveniente aplicar un color a un texto cuando exista un motivo para hacerlo independiente de querer resaltarlo.

Debemos tener cuidado al copiar y pegar texto que proviene de otra página, pues al hacerlo puede que incluyamos elementos de estilo. Conviene realizar primero una limpieza de código, por ejemplo pegar previamente el texto en un editor de texto plano y copiarlo de nuevo. También se puede usar el botón Pegar como texto plano.

Espaciado y alineación

El texto estará siempre justificado a la izquierda. Esta es la opción por defecto de la plantilla por lo que no es necesario hacer nada en este caso. Para tablas el texto de la fila que la encabeza se centra automáticamente.

No debemos generar espacios de más entre párrafos ni antes o después de una imagen. De nuevo la plantilla lo hace de forma automática.