Help:Effective use of headers (Português)

From ArchWiki
Jump to navigation Jump to search

Esse artigo foi escrito para auxiliar escritores e editores de wiki na criação de artigos efetivos e expandir a experiência de leitores do ArchWiki.

Você não é obrigado a saber como editar uma página wiki para seguir esse artigo. Essa página é mais um guia geral de estilo, e não um tutorial técnico de edição.

Sobre cabeçalhos de artigo

Cabeçalhos marcam o início de uma nova seção. Seções podem ser organizadas na forma de uma árvore com algumas seções aninhadas com outras seções. Para refletir a estrutura da seção, cabeçalhos podem ser formatados de diferentes formas. Seções e os cabeçalhos correspondentes são divididos em níveis dependendo de seu lugar relativo a outras seções.

Termos usados neste artigo

Uma seção que está contida em outra seção é referida como um nível menor que seu contêiner (ou pai). Então, o parente é de um nível maior.

Cada cabeçalho com o texto se expandindo para o próximo cabeçalho do mesmo nível é chamado de título.

Títulos têm números que descreve seu nível na árvore. Títulos de níveis maiores têm números menores, e vice versa. Por exemplo, o título de artigo sobre ArchWiki tem título nível 1.

Uso de cabeçalhos e títulos

Cabeçalhos e títulos servem para alguns propósitos importantes:

  • eles reduzem a velocidade de leitura para melhor absorção da informação
  • eles agrupam partes do artigo em unidades lógicas
  • eles marcam pedaços importantes do texto

Reduzindo a velocidade do leitor

Ao apresentar seu tópico aos leitores, você deve saber que leva algum tempo para ler até mesmo os artigos mais curtos. Um cabeçalho serve como um buffer para reduzir a velocidade da leitura antes de ler a seção seguinte. Esse "freio" permite que o leitor pense sobre o conteúdo e se prepare para o texto a seguir.

Agrupando parágrafos em subtópicos

Na maioria das vezes, seu artigo não tratará apenas um tópico e você precisará visitar alguns tópicos mais ou menos relacionados para explicar e expandir seu tópico principal. Tais visitas podem ser confusas quando o leitor está tentando olhar rápido pelo artigo. Portanto, você precisa sinalizar esses desvios.

Marcando partes importantes

Às vezes, os leitores só querem olhar através da tabela de conteúdos (TOC), a fim de identificar partes do artigo que são de especial interesse. Eles também podem fazê-lo, observando os próprios cabeçalhos. Em ambos os casos, os cabeçalhos claramente definidos servem para a identificação rápida de seções importantes do seu artigo. Além disso, o TOC é criado automaticamente listando os títulos do seu artigo.

Cabeçalhos e as tabelas de conteúdo

Uma tabela de conteúdo (TOC) para um artigo é criada automaticamente quando mais de dois cabeçalhos são definidos. Para ocultar a TOC, você pode incluir uma linha com o seguinte código em qualquer parte do artigo:

__NOTOC__

Sobre níveis de título

Há algumas coisas importantes para se observar quando se fala sobre níveis de títulos.

Títulos no mesmo nível devem ter igual significância

Isso pode parecer auto-explicativo, mas não é tão simples quanto parece. Considere este exemplo:

  • Introdução
  • Passo 1: Instalando X
  • Passo 2: Editando as configurações do teclado
  • Passo 3: editando as configurações do mouse
  • Passo 4: Editando as configurações de exibição
  • Passo 5: Adicionando opções de fglrx
  • Passo 6: Iniciando o X
  • Conclusões

Se você analisar cuidadosamente esta lista, você notará que as etapas 2 a 4 são realmente menos significativas do que as etapas 1 e 6, e essa etapa 5 é de menor importância. Isso não quer dizer que todas essas etapas tenham mais ou menos texto do que os outros. É o significado conceitual que é importante.

Para corrigir isso, modificaremos os títulos assim:

  • Introdução
  • Passo 1: Instalando X
  • Passo 2: Configurando X
    • Passo 2a: Editando as configurações do teclado
    • Passo 2b: Editando as configurações do mouse
    • Passo 2c: Editando as configurações de exibição
      • Passo 2c-1: Adicionando opções de fglrx
  • Passo 3: Iniciando X
  • Conclusões

Como você pode ver, combinamos as etapas 2 a 4 em um único título intitulado Configurando X e dividimos o cabeçalho em 3 subposições. Além disso, anexamos o passo 5 ao passo 2c e o transformamos em uma subposição.

Títulos de topo de nível devem sempre ser de nível mais alto

Isso também pode parecer um bom senso, mas há um pequeno problema. Os cabeçalhos têm estilo de formatação associado a eles. Muitas pessoas usam essas regras de formatação associadas para manipular o aspecto de seu artigo. Isso, por sua vez, produz uma estrutura de título quebrada.

Vejamos este exemplo:

  • Introdução
  • Passo 1
  • Passo 2
  • Passo 3
    • Conclusão

O autor desse artigo achava que o tipo 24pt em negrito atribuído às cabeçalhos de nível 1 era muito grande e muito ousado para uma seção tão sem importância como a "Conclusão". Assim, o autor achou que seria melhor usar o tipo de itálico 12pt atribuído aos títulos de nível 3. Isso resulta em uma estrutura de cabeçalho que possui a última seção dois níveis abaixo das outras seções. A estrutura correta seria:

  • Introdução
  • Passo 1
  • Passo 2
  • Passo 3
  • Conclusão

A conclusão agora está em linha com o resto do artigo.

Nota: Pode parecer um pouco estranho que seções como Introdução ou Conclusão tenham a mesma importância que o artigo principal, mas essas seções são de fato importantes. É sempre melhor adicionar uma nota (uma como esta) no final do artigo, ou excluir completamente as seções mal formuladas ou faltantes do que rebaixá-las em títulos de nível mais baixo e quebrar a estrutura lógica do artigo em prol das questões estéticas.

Tipos de estruturas de título

Baseado no número de níveis usados e seu propósito, a estrutura de título pode ser dividida nas seguintes categorias:

  1. Estrutura de um único nível
  2. Falsa estrutura multinível
  3. Estrutura multinível

Estrutura de um único nível

Ao escrever um artigo, a maneira mais direta é dividi-lo em etapas. Essas etapas podem não ser necessariamente passos reais, algo pelo qual os leitores precisam passar. Eles podem ser passos que um escritor leva ao desenvolvimento de seu artigo. Em qualquer caso, essas etapas se seguem e estão dispostas em uma estrutura de um único nível.

Uma configuração típica desse tipo pode parecer assim:

  • Introdução
  • Passo 1: fazendo isso ou aquilo
  • Passo 2: limpeza
  • Passo 3: solução de problemas
  • Leitura adicional

Isto é o que um tutorial simples de 3 passos com introdução e referências podem parecer.

Falsa estrutura multinível

Às vezes, é necessário desviar-se da estrutura simples e fluida de um único nível.

Nota

Geralmente, você precisa se desviar rapidamente do fluxo principal para elaborar algo.

  • Introdução
  • Passo 1: fazendo isso ou aquilo
    • Notas sobre a configuração do XYZ
  • Passo 2: limpeza
  • Passo 3: solução de problemas
  • Leitura adicional

Considere essa uma alternativa a adicionar notas e comentários via o template Note (ou, para páginas traduzidas, template Nota).

Marcar informações auxiliares

Talvez você queira adicionar um marcador a alguma parte importante que atue como um argumento adicional para a discussão principal, ou melhore a discussão principal de alguma outra maneira.

  • Introdução
  • Passo 1: fazendo isso ou aquilo
    • Aqui está um código exemplo
  • Passo 2: limpeza
    • Aqui está um código exemplo
  • Passo 3: solução de problemas
    • Aqui está um código exemplo
  • Leitura adicional

Estrutura multinível

A estrutura multinível é típica de artigos mais longos e detalhados. No entanto, também pode ser usado efetivamente em tutoriais mais curtos.

Aqui estão alguns casos em que uma estrutura de vários níveis pode ser útil.

Nota: Tenha em mente que estamos descrevendo as relações pai-filho de níveis de título e que não é importante se o pai for o nível 1, 2 ou 3. O mesmo se aplica a todas as estruturas de vários níveis com 2 ou mais níveis.

Agrupar argumentos

Os subtítulos podem ser para os títulos principais que os títulos são para todo o artigo.

Um exemplo:

  • Introdução
  • Passo 1: fazendo isso ou aquilo
  • Passo 2: limpeza
    • Primeiro faça assim
    • Agora faça assado
    • Está pronto!
  • Passo 3: solução de problemas
  • Leitura adicional

Argumentos alternativos

Às vezes, você precisa dar aos seus leitores alguns ângulos diferentes sobre um assunto.

Por exemplo:

  • Introdução
  • Passo 1: fazendo isso ou aquilo
    • Essa é uma forma de fazê-lo
    • Essa é outra forma de fazê-lo
  • Passo 2: limpeza
  • Passo 3: solução de problemas
  • Leitura adicional

Argumento contraditório

Se você precisa falar sobre argumentos opostos, você pode dar a cada parte uma subposição própria.

Por exemplo:

  • Introdução
  • Passo 1: fazendo isso ou aquilo
    • Você vai querer isso
    • Porém, há motivos para não querer isso
  • Passo 2: limpeza
  • Passo 3: solução de problemas
  • Leitura adicional

O texto de cabeçalho

Vamos resumir alguns dos pontos-chave aqui, e se você quiser mais detalhes, você pode ler Help:Diretrizes para nomenclatura de artigos. As regras listadas aqui se aplicam tanto aos textos do cabeçalho quanto aos nomes dos artigos.

  • Os textos de cabeçalho devem ser tão específicos quanto possível e devem refletir o escopo do título
  • Os textos de cabeçalho devem ser gerais o bastante para permitir futuros aprimoramentos de títulos
  • Os textos de cabeçalho devem ser tão curtos quanto possível (veja também Help:Diretrizes para nomenclatura de artigos)

Formatação

Como já observamos, é crucial não usar os estilos de formatação de cabeçalho para embelezar seus artigos. Se você não gosta do que vê, entre em contato com os administradores ou sysops e peça pela opinião deles, ou ofereça para corrigir a situação de forma a não comprometer as estruturas de cabeçalho.

Para marcar algum texto como um título, dois ou mais sinais de igualdade (==) devem ser usados.

Nota: O nível de título mais baixo ao qual há suporte seria realmente 1 (=), mas esta formatação é reservada para títulos de artigos: as seções de artigos devem sempre começar a partir do nível 2.

Aqui está o código para marcar cabeçalhos:

==Nível de cabeçalho 2==
===Nível de cabeçalho 3===
====Nível de cabeçalho 4====
=====Nível de cabeçalho 5=====
======Nível de cabeçalho 6======

Se você deseja ver como esses são formatos, você pode usar o Sandbox.