Uso de HTML en las páginas web de Debian

Esta página es aún un borrador.

Prólogo

Esta página está dedicada a ayudar a editores y traductores a crear páginas que usen de manera adecuada las etiquetas web. Esta página contiene recomendaciones acerca del uso de etiquetas y cómo crear páginas nuevas que sean más fáciles de traducir.

Algunas recomendaciones generales

Esta es una lista de recomendaciones generales para páginas nuevas o traducciones

No usar líneas largas
El ancho de línea de los ficheros wml y otros ficheros debe ser el adecuado para que pueda ser leído en una terminal. Esto hace que sea fácil de editar en vi, mejora la búsqueda y facilita la traducción. Esto también es importante por que el sistema de control de versiones hace uso de las líneas individuales y es más difícil resolver conflictos en líneas largas.
Poner las etiquetas en líneas separadas de ser posible
Muchas etiquetas HTML pueden ser puestas en una línea separada. Algunas de estas son <div>, <p>, <table>, <ul>. Para facilitar el trabajo a los traductores, se debe mantener las etiquetas que puedan ser usadas de esta manera en líneas separadas. De lo contrario los traductores pueden borrar etiquetas accidentalmente y olvidar colocarlas de nuevo.
No usar espacios o saltos de línea en etiquetas de tipo inline
Algunas etiquetas pueden producir espacios si están en distintas líneas que su contenido. Una de estas es la etiqueta <q> usada para citas cortas. Las etiquetas de apertura y cierre deben estar en la misma línea. De lo contrario se generará un espacio después de la etiqueta. Entre palabras pertenecientes a la etiqueta puede haber tantos espacios y saltos de línea como se desee.

Abreviaciones y acrónimos

Para abreviaciones y acrónimos se debe usar la etiqueta HTML <acronym>. Hay dos razones por las cuales la etiqueta <abbr> no es recomendable: primero no todos los navegadores la soportan y segundo hay definiciones inconsistentes de qué es un acrónimo y qué una abreviatura.

Un acrónimo se añade con la siguiente sintaxis: <acronym lang="código del idioma" title="Definición Del Acrónimo" >ACRONYM</acronym>. La definición contiene las palabras a las cuales el acrónimo hace referencia. Si el acrónimo está formado por las letras iniciales de las palabras, esas letras deben estar en mayúscula en el título del acrónimo. El atributo del idioma sólo es necesario si el acrónimo o abreviación está en un idioma diferente.

Existe un conjunto de acrónimos predefinidos en las plantillas wml que se pueden usar en las páginas, para usarlos se debe incluir acronyms en el fichero wml. Por ejemplo la etiqueta wml para DD es <acronym_DD />.

Referencias y citas

Hay reglas diferentes acerca de qué es una referencia o cita para diferentes idiomas. Si se tiene una pequeña cita se usa la etiqueta <q>. La representación final del contenido es responsabilidad del código CSS. No debe haber espacio entre las etiquetas de apertura y cierre con el contenido.

Para citas más largas se usa la etiqueta <blockquote>. Una etiqueta <blockquote> encierra uno o más párrafos demarcados con <p>. Por favor no usar la etiqueta <blockquote> para centrar texto que no sea una cita. <blockquote> es específico para citas y su representación final será dependiente del código CSS en el futuro.

También existe la etiqueta <cite> en HTML. La etiqueta <cite> no es la cita. Esta etiqueta se usa para especificar la referencia de la cita. Esto puede ser el nombre de la persona a la cual la cita pertenece, esto puede hacer parte de <blockquote> como una URL.

Nombres de programas y código

Para referirse a nombres de programas y código existe la etiqueta <code>. Los navegadores habitualmente saben como representar código y nombres de programas, pero su representación final puede ser modificada mediante código CSS. No es recomendable usar la etiqueta <tt> ya que esta no dice nada acerca del contenido.

La salida por pantalla

Para representar la salida en pantalla existe una etiqueta especial llamada <samp>. Si la salida del ordenador es demasiado larga, se debe revisar el código CSS en el caso que haya una clase especial para ello.

Entrada por teclado

Si hay ejemplos donde el usuario tenga que ingresar información por el teclado se usa la etiqueta <kbd> para representar la entrada por teclado. Véase el capítulo acerca de variables para saber cómo especificar que la entrada es variable.

Variables

Algunas veces es necesario representar alguna entrada variable como es el caso de una dirección IP específica o el nombre de usuario que se debe dar al programa en la línea de comandos. Para esas entradas variables se usa la etiqueta <var>.

Contenido preformateado

La etiqueta <pre> se usa únicamente para contenido preformateado. Aspectos como tamaño de línea, número de espacios y otras cosas se preservarán usando esta etiqueta. Como es de esperar esta etiqueta no puede contener muchas de las otras etiquetas HTML.

Imágenes

De haber imágenes en la página no es necesario añadir el atributo border=0. Sin embargo si es posible se debe especificar el tamaño de imagen y el atributo alt. Si no se especifica el tamaño el wml lo agrega pero esto añade tiempo de compilación. El atributo alt debe tener un texto informativo que diga qué hay en la imagen esto es útil para usuarios que naveguen con lynx o usuarios invidentes.