Reglas para editar

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. Cuándo y cómo poner un índice

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.

É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.

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 inicio:

4. Titulo
4.1 Subapartado
4.1.1 Sub-subapartado

La manera de crear un índice con enlaces a las diferentes partes del artículo es la siguiente: en el propio índice colocamos un enlace a una referencia en el propio artículo:

<a href="#referencia"><strong>1. Título</strong></a>
<a href="#referencia">2.1. Subapartado</a>

En el título del apartado del artículo al cual queremos dirigir desde el índice debemos colocar la referencia así (los atributos para colocar el tamaño del títulos es conveniente que estén fuera de la referencia):

<h2><a name="referencia">1. Titulo</a></h2>

2. Títulos y tamaños de letra.

El título debe ser ajustado y descriptivo al contenido del artículo/apartado/subapartado, evitando las apreciaciones personales, recuerda que este es un proyecto de documentación. Además el título principal ya esta incluido, no lo dupliques en el cuerpo del artículo.

Intenta jerarquizar los títulos mediante el uso de las etiquetas destinadas a tal fin, sin abusar de ellas, se recomienda el siguiente orden.

<h2>1. Titulo del apartado</h2>
<h3>1.x.x. Título de los subapartados</h3>

Este es un ejemplo del aspecto final:

1. Título del apartado

1.1. Título del subapartado

1.1.1. Título del subsubapartado

3. Formato de los comandos, archivos, menús....

  • Comandos en tty: <tt> #/$ comando </tt> . Ejemplo: #/$ comando
  • Opción de un comando en la tty: <tt> --opción </tt> . Ejemplo: --opción
  • Atributo o parametro de un comando/opción en tty: <em> parametro </em> . Ejemplo: #/$comando --opción parametro
  • Opción en menú: <tt> <strong> opción menú </strong> </tt>. Ejemplo: opción menú
  • Referencia a archivo del sistema: <em> /nombre/del/archivo </em>. Ejemplo: /nombre/del/archivo
  • Salida de un comando en tty y contenido de un archivo:

    <code>
    ls /
    bin cdrom etc initrd lib media opt root srv tmp var
    boot dev home initrd.img lost+found mnt proc sbin sys usr vmlinuz
    </code>

    Ejemplo:

    ls /
    bin   cdrom  etc   initrd      lib         media  opt   root  srv  tmp  var
    boot  dev    home  initrd.img  lost+found  mnt    proc  sbin  sys  usr  vmlinuz

4. Estructura.

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 sera tratado, siendo su ubicación, al principio del artículo. Si son necesarios requisitos previos o un explicación de la estructura del articulo también de incluirá esta justo después de la introducción.

5. Imágenes

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.