Help:Effective use of headers (Español)

From ArchWiki
Jump to navigation Jump to search
Estado de la traducción
Este artículo es una traducción de Help:Effective use of headers, revisada por última vez el 2018-11-10. Si advierte que la versión inglesa ha cambiado puede ayudar a actualizar la traducción, bien por usted mismo o bien avisando al equipo de traducción.

Este artículo ha sido escrito para ayudar a escritores y editores de la wiki a crear artículos efectivos y ampliar la experiencia de los lectores de ArchWiki.

No es necesario que sepa cómo editar una página wiki para seguir este artículo. Esta página es una guía de estilo más general, en lugar de un Manual técnico para la edición.

Sobre los encabezados de los artículos

Los encabezados marcan el inicio de una nueva sección. Las secciones se pueden organizar en forma de árbol con algunas secciones anidadas dentro de otras secciones. Para reflejar la estructura de la sección, los encabezados pueden tener un formato diferente. Las secciones y sus correspondientes encabezados se dividen en niveles según su posición en relación con otras secciones.

Términos utilizados en este artículo

Una sección que está contenida dentro de otra sección se dice que es de nivel inferior que su contenedor(o padre). Por lo tanto, el padre es de un nivel superior.

Cada encabezado con el texto que se extiende al siguiente encabezado del mismo nivel se denomina título.

Los encabezados tienen números que describen su nivel en el árbol. Los títulos de nivel superior tienen números más bajos, y viceversa. Por ejemplo, el título del artículo en ArchWiki es título de nivel 1.

Uso de encabezados y títulos

Los encabezados y títulos sirven para algunos propósitos importantes:

  • reducen la velocidad de lectura de los lectores para una mejor absorción de la información;
  • agrupan partes del artículo en unidades lógicas;
  • marcan piezas importantes de texto.

Ralentizar la lectura

Al presentar su tema a los lectores, debe saber que se necesita algo de tiempo para leer incluso los artículos más cortos. Un encabezado puede servir como un búfer para relajar al lector antes de leer la siguiente sección. Esta relajación permite al lector pensar en el contenido y prepararse para el siguiente texto.

Agrupar párrafos en subtemas

La mayoría de las veces, su artículo no tratará solo un tema, y ​​tendrá que visitar otros temas, más o menos relacionados, para explicar y ampliar su tema principal. Dichas visitas pueden ser confusas cuando un lector está intentando ahondar en el artículo. Por lo tanto, es necesario señalar estas desviaciones.

Marcar partes importantes

A veces, los lectores solo quieren mirar a través de la tabla de contenido (TOC) para identificar partes del artículo que son de su especial interés. También pueden hacerlo mirando los encabezados mismos. En ambos casos, los encabezados claramente definidos sirven para identificar rápidamente secciones importantes del artículo. Además, el TOC se crea automáticamente al enumerar los encabezados de su artículo.

Encabezados y tabla de contenidos

Una tabla de contenido para un artículo se crea automáticamente cuando se definen más de dos encabezados. Para ocultar la TOC, puede incluir una línea con el siguiente código en cualquier parte de su artículo:

__NOTOC__

Sobre los niveles de los títulos

Hay algunas cosas importantes a tener en cuenta cuando se habla de niveles de encabezado.

Los títulos del mismo nivel deben tener relevancia equivalente

Esto puede parecer autoexplicativo, pero no es tan sencillo como parece. Considere este ejemplo:

  • Introducción
  • Paso 1: Instalar X
  • Paso 2: Editar la configuración del teclado
  • Paso 3: Editar la configuración del ratón
  • Paso 4: Editar de la configuración de pantalla
  • Paso 5: Agregar opciones de fglrx
  • Paso 6: Iniciar X
  • Conclusiones

Si analiza cuidadosamente esta lista, notará que los pasos 2 a 4 son en realidad de menor importancia que los pasos 1 y 6, y que el paso 5 es aún de menor importancia. Esto no quiere decir que todos esos pasos tengan más o menos texto que los otros. Es el significado conceptual lo que es importante.

Para corregir esto, modificaremos los encabezados así:

  • Introducción
  • Paso 1: Instalar X
  • Paso 2: Configurar X
    • Paso 2a: Editar la configuración del teclado
    • Paso 2b: Editar la configuración del ratón
    • Paso 2c: Editar la configuración de pantalla
      • Paso 2c-1: Agregar opciones de fglrx
  • Paso 3: Iniciar X
  • Conclusiones

Como puede ver, hemos fusionado los pasos 2 a 4 en un solo encabezado titulado Configurar X, y hemos dividido el encabezado en 3 subtítulos. Además, adjuntamos el paso 5 al paso 2c, y lo convertimos en un subtítulo suyo.

Los títulos de nivel superior siempre deben ser de nivel más alto

Esto también puede sonar del sentido común, pero hay un pequeño problema. Los encabezados tienen un estilo de formato asociado a ellos. Muchas personas usan esas reglas de formato asociadas para manipular el aspecto de su artículo. Esto a su vez produce una estructura de encabezado rota.

Echemos un vistazo a este ejemplo:

  • Introducción
  • Paso 1
  • Paso 2
  • Paso 3
    • Conclusión

El autor de ese artículo pensó que el tipo de letra 24pt en negrita asignado a los encabezados de nivel 1 era demasiado grande y demasiado audaz para una sección tan poco importante como Conclusión. Así que el autor pensó que sería una mejor idea usar el tipo de cursiva 12pt asignado a los encabezados de nivel 3. Esto proporciona como resultado una estructura de encabezado que da a la última sección dos niveles por debajo de las otras secciones. La estructura correcta sería:

  • Introducción
  • Paso 1
  • Paso 2
  • Paso 3
  • Conclusión

La conclusión está ahora en línea con el resto del artículo.

Nota: Puede parecer chocante que las secciones como Introducción o Conclusión tengan la misma importancia que el artículo principal, pero esas secciones son de hecho importantes. Siempre es mejor agregar una nota (una como esta) al final del artículo, o excluir por completo las secciones mal formuladas o ausentes que degradarlas en encabezados de nivel inferior y romper la estructura lógica del artículo por cuestiones estéticas.

Tipos de estructuras de encabezamiento

Según la cantidad de niveles utilizados y su propósito, la estructura de encabezado puede dividirse en las siguientes categorías:

  1. Estructura de un solo nivel.
  2. Estructura de falto multinivel.
  3. Estructura multinivel.

Estructura de un solo nivel

Al escribir un artículo, la forma más sencilla es dividirlo en pasos. Esos pasos pueden no ser necesariamente pasos reales, algo que los lectores deben notar. Pueden ser pasos que un escritor toma para desarrollar su artículo. En cualquier caso, esos pasos se siguen y se organizan en una estructura de un solo nivel.

Una configuración típica de este tipo puede verse así:

  • Introducción
  • Paso 1: haciendo esto o lo otro
  • Paso 2: limpiando
  • Paso 3: solución de problemas
  • Otras lecturas

Esto es lo que podemos ver en un tutorial sencillo de 3 pasos con introducción y referencias.

Estructura de falso multinivel

A veces, es necesario desviarse de la estructura simple y fluida de un solo nivel.

Nota lateral

Por lo general, es necesario desviarse brevemente del flujo principal para elaborar algo.

  • Introducción
  • Paso 1: haciendo esto o lo otro
    • Notas sobre la configuración de XYZ
  • Paso 2: limpiando
  • Paso 3: solución de problemas
  • Otras lecturas

Considere esto como una alternativa al agregar notas y comentarios a través de la plantilla nota.

Marcar información auxiliar

Quizás desee agregar un marcador a alguna parte importante que actúe como un argumento adicional a la discusión principal, o que mejore la discusión principal de alguna otra manera.

  • Introducción
  • Paso 1: hacer esto o lo otro
    • Aquí está el código de ejemplo
  • Paso 2: limpiar
    • Aquí está el código de ejemplo
  • Paso 3: solución de problemas
    • Aquí está el código de ejemplo
  • Otras lecturas

Estructura multinivel

La estructura multinivel es típica de artículos más largos y más profundos. Sin embargo, también se puede utilizar eficazmente en tutoriales más cortos.

He aquí hay algunos casos en los que una estructura multinivel puede ser útil.

Nota: Tenga en cuenta que estamos describiendo las relaciones padre-hijo de los niveles de encabezado, y que no es importante si el padre es de nivel 1, 2 o 3. Lo mismo se aplica a todas las estructuras de varios niveles que tienen 2 o más niveles.

Argumentos agrupados

Los subtítulos pueden ser a los encabezados de secciones lo que los títulos a todo el artículo.

Un ejemplo:

  • Introducción
  • Paso 1: hacer esto o lo otro
  • Paso 2: limpiar
    • Primero haga esto
    • Después haga esto otro
    • ¡Ya se terminó!
  • Paso 3: solución de problemas
  • Otras lecturas

Argumentos alternativos

Los subtítulos pueden ser a los encabezados principales lo qué los encabezados corresponden a todo el artículo.

Un ejemplo:

  • Introducción
  • Paso 1: haciendo esto o lo otro
    • Esta es una forma de hacerlo
    • Esta es otra forma de hacerlo
  • Paso 2: limpiando
  • Paso 3: solución de problemas
  • Otras lecturas

Argumentos contradictorios

Si necesita hablar sobre argumentos opuestos, puede dar a cada parte un subtítulo propio.

Por ejemplo:

  • Introducción
  • Paso 1: hacer esto o lo otro
    • Usted puede querer esto
    • Sim embargo, hay razones para no querer esto
  • Paso 2: limpiar
  • Paso 3: solución de problemas
  • Otras lecturas

El texto del encabezado

Resumiremos algunos de los puntos clave aquí, y si desea una explicación más detallada, puede leer Help:Article naming guidelines (Español). Las reglas enumeradas aquí son aplicables tanto a los textos de los encabezados como a los títulos de los artículos.

  • Los textos de encabezados deben ser lo más específicos posible, y deben reflejar el alcance de la sección
  • Los textos de encabezados deben ser lo suficientemente generales como para permitir la mejora futura de la sección.
  • Los textos de encabezados deben ser lo más cortos posible (consulte también Help:Article naming guidelines (Español)).

Formato

Como ya hemos señalado, es crucial no abusar de los estilos de formato de encabezado para embellecer sus artículos. Si no le gusta lo que ve, contacte a los administradores o sysops y solicite su opinión, u ofrezca arreglar la situación de una manera que no comprometa las estructuras de los encabezados.

Para marcar un texto como encabezado, se deben usar dos o más signos iguales (==).

Nota: El nivel de título más bajo admitido sería en realidad 1 (=), pero su formato está reservado para los títulos de los artículos: las secciones de los artículos siempre deben comenzar desde el nivel 2.

Aquí está el código para marcar los encabezados:

 == Nivel de encabezado 2 ==
 === Nivel de encabezado 3 ===
 ==== Nivel de encabezado 4 ====
 ===== Nivel de encabezado 5 =====
 ====== Nivel de encabezado 6 ======

Si desea ver cómo están formateados, puede usar Sandbox.