Índice
- Poner un índice
- Títulos y tamaños de letra
- Formato de los comandos, archivos, menús....
- Estructura
- Imágenes
Introducción
Con la finalidad que el wiki posea un estilo propio y homogéneo, se han decidido una serie de políticas y recomendaciones a tener en cuenta al momento de edición o creación de los artículos.
1. Poner índice al artículo:
¿Cúando?
Cuando un artículo posee un tamaño considerable que impide un fácil seguimiento del mismo o dispone de varias secciones diferenciadas, es aconsejable la colocación de un índice para mejorar la navegación y facilitar su lectura.
¿Donde?
Éste se colocará al principio del artículo, su ubicación será justo debajo del título y dispondrá de enlaces para una navegación cómoda y ordenada por el artículo.
¿Cómo?
Se recomienda el uso de números para los apartados y subnumeros para los subapartados, quedando a elección del autor la utilización de caracteres en negrita para el título de los apartados principales:
<ol>
<li><strong>Titulo del apartado</strong>
<ol>
<li>Sub-apartado
<ol>
<li>Sub-sub-apartado</li>
</ol>
</li>
</ol>
</li>
</ol>
- Titulo del apartado
- Sub-apartado
- Sub-sub-apartado
- Sub-apartado
Enlaces a los apartados:
La mejor manera de crear un índice es incluir enlaces a las diferentes partes del artículo.
El ejemplo que tenemos arriba para el apartado 4, podríamos mejorarlo siguiendo estos 2 sencillos pasos:
- Primero colocamos, en el propio índice, enlaces a distintas referencias del artículo:
<a href="#referencia-4"><strong>4. Titulo del apartado</strong></a>
<a href="#referencia-4.1">4.1. Sub-apartado</a>
<a href="#referencia-4.1.1">4.1.1. Sub-sub-apartado</a>
- Luego, a lo largo del artículo debemos colocar en el título de los apartados, la referencia correspondiente que usamos en los enlaces del índice:
<h2><a name="referencia-4">4. Titulo del apartado</a></h2>
[... Texto apartado 4 ...]
<h3><a name="referencia-4.1">4.1. Sub-apartado</a></h3>
[... Texto sub-apartado 4.1 ...]
<h3><a name="referencia-4.1.1">4.1.1. Sub-sub-apartado</a></h3>
[... Texto sub-sub-apartado 4.1.1 ...]
Nota: Los atributos para colocar el tamaño del título es conveniente que estén fuera de la referencia.
2. Títulos y tamaños de letra:
El título debe ser descriptivo y ajustado al contenido del artículo/apartado/subapartado, evitando las apreciaciones personales, recuerda que este es un proyecto de documentación.
Título principal del artículo:
Este título se establece al crear por primera vez el artículo. Si crees que necesita ser cambiado, ponte en contacto con moderación.
Nota: Ten en cuenta que este título ya está incluido en el diseño de la propia wiki; no lo pongas en el cuerpo del artículo porque se duplicaría, empieza directamente por el índice o por el título del primer apartado.
Título de los apartados:
Intenta jerarquizar los títulos mediante el uso de las etiquetas destinadas a tal fin (h2 y h3):
<h2> Título </h2>
<h3> Título </h3>
- Para los apartados pricipales:
- Para los sub-apartados:
Intenta no abusar de ellas, se recomienda el siguiente orden:
<h2>1. Titulo del apartado</h2>
<h3>1.x.x. Título de los sub-apartados</h3>
Este es un ejemplo del aspecto final:
1. Título del apartado
1.1. Título del sub-apartado
1.1.1. Título del sub-sub-apartado
3. Formato de los comandos, archivos, menús....
A parte del texto, podemos necesitar indicar un comando de consola o mostrar la salida de este, el contenido de un archivo, opciones en un menú, etc.
- Comandos ejecutados como root :
# comando
- Comandos ejecutados como usuario :
$ comando
- Comandos que entran en una sola linea se puede usar la etiqueta <code> </code>
#/$ comando --opción
- Comandos que entran barias líneas se puede usar la etiqueta <pre> </pre>
#/$ comando --opción #/$ comando --opción
Se seguirá una evolución lógica en la redacción del artículo, buscando la claridad y el orden en los conceptos desarrollados. Se sugiere aportar una pequeña introducción al tema que será tratado, siendo su ubicación, al principio del artículo. Si son necesarios requisitos previos o un explicación de la estructura del artículo, también de incluirá esta justo después de la introducción.
Es posible la inserción de imágenes siempre y cuando estén estrechamente relacionadas con el artículo o con algún párrafo del mismo y/o resulten de utilidad para una mejor comprensión del texto. Intenta no sobrecargar el artículo de éstas. Las puedes insertar con la herramienta adecuada habilitada a tal fin en el editor.