Flapédia:Livro de estilo

De Flapédia
Ir para: navegação, pesquisa


Este Livro de Estilo (também chamado de Folha de Estilo) deve ser utilizado como referência para uniformizar os artigos da Flapédia: é um guia de estilo. As regras propostas não são obrigatórias. Há várias boas formas de se fazer algo, mas se todos fizerem da mesma forma a Flapédia tornar-se-á muito mais fácil de consultar, manter e expandir. Em vista disso, a seguinte citação do Manual de Estilo de Chicago merece atenção:

Regras e regulamentos como estes, no assunto em questão, não podem ser dados com a rigidez de uma lei talhada em pedra. São adequadas para o caso médio, e devem ser aplicadas com certo grau de elasticidade.

A redação clara, informativa e imparcial é sempre mais importante que a apresentação e a forma. Não se requer que os autores sigam todas ou alguma destas regras: a graça da edição wiki é que não se requer perfeição. Os Flapedistas que fazem copy-edit vão se encaminhar a este manual e gradualmente serão feitas páginas que se ajustam a este guia, ou este guia será mudado para o mesmo efeito.

Contribuidores, notem que, por ser este documento considerado política, mudanças significantes ou substantivas devem ser discutidas antes na página de discussão, ou serão removidas.

Conteúdo

Título dos artigos

A escolha do título para um artigo é o primeiro passo na criação de um novo conteúdo da Flapédia. Preferencialmente, o título deve descrever o assunto a tratar de forma sintética e sem ambiguidade. O uso de maiúsculas e minúsculas num título deve conformar-se à norma em vigor.

Quando o texto de um artigo tem uma ligação interna para outro (por exemplo, O mascote do Flamengo é o [[urubu]]), tenha em consideração que, caso o artigo ligado não exista ainda, esse nome será usado para criá-lo.

Parágrafo introdutório

Todos os artigos devem ter um parágrafo introdutório no qual se define brevemente e se contextualiza o assunto a ser tratado. Este parágrafo pode ser dividido em dois ou mais quando necessário. Neste parágrafo introdutório deve estar indicado o título do artigo em negrito, de preferência no início da primeira linha e o contexto deve ficar claro logo nas primeiras palavras. Veja o exemplo do artigo Deserto:

Em geografia, um deserto é uma forma de paisagem ou região que recebe pouca precipitação pluviométrica. Como conseqüência, os desertos têm a reputação de serem capazes de sustentar pouca vida. Comparando com regiões mais úmidas, isso pode ser verdade, porém, examinando-se mais detalhadamente, os desertos freqüentemente abrigam uma riqueza de vida que normalmente permanece escondida (especialmente durante o dia) para conservar umidade.

Se o título do artigo tiver outra denominação possível e as duas podem ser utilizadas uma no lugar da outra sem perda de sentido para ninguém, então cada um das formas deve aparecer em negrito, preferencialmente ligadas pelo termo ou:

Exemplo: O Reino Protista ou Protoctista é um dos reinos biológicos comumente reconhecidos ...

Se o título do artigo deveria mudar conforme a variante do português empregada, a forma correta para cada variante deve ser indicada e deve ficar claro o que é aceito em cada variante.

Exemplo 1: O Escotismo (termo usado no Brasil; em Portugal, é Escutismo) é um movimento ...
Exemplo 2: O Escotismo, como é conhecido no Brasil, ou Escutismo, em Portugal, é um movimento ...
Exemplo 3: O Desporto (termo usado em Portugal; no Brasil também é aceito, mas Esporte é preferido) ...

Por fim, se o termo que é usado como título do artigo tem uma variante que não esteja relacionada com o português falado em alguma região do mundo, esta pode ser mencionada, não necessariamente no parágrafo introdutório. É elucidadora a explicação do porquê desta variante.

Ligações internas

Ao escrever sobre qualquer assunto para a Flapédia os nomes, palavras, ou frases que você considera que devam ser referidos como informação adicional deverão ser colocados entre dois parênteses retos ou colchetes, de forma a ter dois antes e dois depois do nome, palavra ou frase. Desta forma, será feita uma ligação interna entre esse nome, palavra ou frase no artigo que está a editar e um outro artigo com esse título.

Exemplo: [[Romário]] foi jogador do Flamengo até [[1999]].
Resultado: Romário foi jogador do Flamengo até 1999.

O uso das ligações internas para outros artigos é encorajado. Use-as em todas as palavras e termos em que a consulta do artigo ligado ajude na compreensão ou aprofunde o artigo que está editando. No entanto, um excesso de ligações internas numa página tem um efeito inestético, por isso não abuse delas. Nomeadamente, não coloque uma ligação em todas as ocorrências de uma palavra: basta ligar a primeira.

As ligações internas que seguem a convenção de nomenclatura têm maior probabilidade de ligarem a artigos já existentes, mas se ainda não existir um artigo sobre esse assunto, torna mais provável a criação de um artigo com nome correto por futuros editores. Tente criar as ligações com precisão. Se o artigo para o qual você quer criar a ligação ainda não existe, faça uma pequena busca para verificar: pode ocorrer que o nome do artigo seja ligeiramente diferente do que o que você digitou.

Muitas vezes o título do artigo não é o mais adequado para incluir como ligação interna. Nesses casos, é possível indicar um texto alternativo que será apresentado no artigo, mantendo a ligação o mesmo destino. Isso se faz escrevendo o texto alternativo após o título da ligação interna, separado por uma barra vertical (|).

Exemplo: Gilles Deleuze foi um filósofo [[França|francês]]
Resultado: Giles Deleuze foi um filósofo francês

Tenha em atenção que o nome usado para a ligação interna deve ser suficientemente claro para que o leitor perceba do que trata sem ter que seguir a ligação. Nunca use coisas como "clique aqui" para o texto de uma ligação interna — isto não fornece informação nenhuma. O texto da ligação deve evidenciar ser o assunto tratado no artigo ligado.

Correto: Consulte a lista de desportos olímpicos.
Errado: Para ver mais desportos olímpicos clique aqui.

Um "truque" que pode ser usado para poupar trabalho na escrita de artigos é compor a ligação acrescentando um sufixo, o que é útil para a maioria dos plurais (e não só).

Exemplo: Os índios [[brasil]]eiros estão ameaçados pelo avanço da civilização.
Resultado: Os índios brasileiros estão ameaçados pelo avanço da civilização.

Títulos das seções do artigo

Para dividir um artigo em seções, coloque o título da seção entre dois sinais de igual, como em: ==Esta é a primeira seção==.

Para fazer uma subseção, use ===Texto=== para o segundo nível e ====Texto==== para o terceiro.

Com os títulos formatados desta forma, o índice do artigo é gerado automaticamente. As seções são automaticamente numeradas para os utilizadores com essa definição ativada, e as palavras usadas nos títulos das seções têm maior relevância nas pesquisas (buscas). Os títulos também ajudam os leitores, partindo o texto e delineando o artigo.

Seguem-se algumas normas para a formatação de seções.

  1. À semelhança dos nomes dos artigos, use maiúsculas apenas na primeira letra da primeira palavra ou em nomes próprios.
  2. Evite fazer ligações dentro dos títulos das seções.
Dependendo das definições, alguns utilizadores podem não lê-los claramente. Recomenda-se antes colocar a ligação na primeira frase imediatamente a seguir ao cabeçalho.
  1. O abuso de subtítulos deve ser evitado, pois faz o artigo parecer desordenado.
Parágrafos curtos e frases soltas geralmente não garantem o seu próprio subtítulo.
Apenas nestas circunstâncias, quando não houver texto suficiente para justificar uma seção ou subseção, é preferível usar texto em negrito ou outras marcas dentro de uma seção em vez de subtítulos.

Seção Ver também

No final de subseção

Conforme foi dito acima, quando um artigo é curto e não tem seções, referências a outros artigos que não tenham sido incluídas no texto como ligações internas devem ser apresentadas no fim do artigo, precedidas pela introdução "Ver também:" Esta norma deve ser também usada quando o artigo tiver várias seções e a chamada de atenção se aplica apenas a uma seção específica. Neste caso deve ser colocado no final da seção a que diz respeito.

Exemplo de como digitar:
'''Ver também''': [[processador de texto]], [[folha de cálculo]]
Resultado:

Ver também: processador de texto, folha de cálculo

Como subseção própria

Por outro lado, se os artigos são longos e incluem seções e as referências dizem respeito ao artigo todo e não apenas a uma seção, devem ser listadas no final do artigo numa seção dedicada, intitulada "Ver também".

Esta seção deve aparecer antes da seção "Links externos", caso essa seção exista (se não existir deve, obviamente, ficar no fim do artigo). Não devem ser incluídas na seção "Ver também" ligações que já tenham sido incluídas no texto do artigo.

Exemplo de como digitar:
=={{Ver também}}==
* [[Processador de texto]]
* [[Folha de cálculo]]
O resultado será:

Ver também


Em certas situações pode ser preferível incluir uma referência a uma ligação num ponto específico do artigo, por exemplo em casos em que parte do texto foi movido para um novo artigo, ou quando outro artigo pode ser essencial para a compreensão do assunto. Nestes casos, deve ser incluído um texto, de preferência no início da seção, chamando a atenção para a ligação interna.

Exemplo: {{ver artigo principal|[[História do Brasil]]}}
Resultado: Predefinição:Ver artigo principal

Seção Ligações externas

A Flapédia não é uma coleção de referências para páginas externas. Artigos só com links são muito mal vistos. No entanto, os artigos devem ser complementados, sempre que possível, com links para outras páginas da World Wide Web.

Uma ligação para uma página externa pode ser composta de duas formas:

  1. Para apresentar por extenso o texto da ligação, basta escrever o URL.
    Exemplo: http://wikimediafoundation.org
    Resultado: http://wikimediafoundation.org
  2. Para substituir o URL por um texto mais adequado, escreve-se o URL e o texto que se deseja apresentar, tudo entre colchetes.
    Exemplo: [http://www.Flapédia.com.br a Flapédia em português]
    Resultado: a Flapédia em português

O URL deve começar com http:// ou outro protocolo, como ftp:// ou news://.

Alguns URLs são pouco estéticos e dão pouca informação sobre o seu conteúdo. Nesse caso é preferível que apareça um título com maior significado.

Exemplo: [http://www.esa.int/export/esaCP/index.html site da Agência Espacial Europeia] é mais legível que http://www.esa.int/export/esaCP/index.html
Resultado: site da Agência Espacial Europeia é mais legível que http://www.esa.int/export/esaCP/index.html

E, caso se pretenda que apareça o URL, deve-se apresentá-lo o mais simples possível, de forma a ligar à página pretendida. Nomeadamente remova o index.html<code> no exemplo acima.

A versão para impressão da página apresenta todos os URL por completo, incluindo aqueles a que foi acresentado um título, por isso nenhuma informação se perde.

URLs como notas de pé de página

Sem o texto opcional, uma referência externa aparece como uma nota de pé de página.

Exemplo: <code>Bem-vindo à Flapédia [http://www.Flapédia.com.br]
Resultado: Bem-vindo à Flapédia [1]

Localização dentro do artigo

Este formato pode ser usado para incluir uma referência URL inline dentro do texto quando necessário e deve estar sempre no final do arquivo, depois da seção "Ver também", quando esta existir. E mesmo que você tenha apenas um link para indicar, ainda assim use a chamada da seção no plural: "Ligações externas".

Exemplo de como digitar:
=={{Ligações externas}}==
* [http://www.elpais.es ''El País'']
* [http://pt.Flapédia.com.br Flapédia em português]
O resultado será:

Ligações externas


Exemplo: Um bom exemplo de uma comunidade cooperativa na Internet é a [http://www.Flapédia.com.br Flapédia, uma enciclopédia em código aberto].
Resultado: Um bom exemplo de uma comunidade cooperativa na Internet é a Flapédia, uma enciclopédia em código aberto.

No entanto, na maior parte dos casos é preferivel agrupar todas as ligações externas no fim do artigo sob o título =={{Ligações externas}}==

Websites estrangeiros

É preferível que as páginas externas referenciadas sejam em língua portuguesa. No entanto, quando achar conveniente incluir ligações para páginas em outras línguas, tenha o cuidado de referir após a ligação qual a linguagem em que a página está escrita.

Exemplo: [http://www.elpais.es ''El País''], jornal de Madrid

O resultado será:

El País, jornal de Madrid

Tipos de Arquivos

Se o link não for para um arquivo HTML, mas para um arquivo (por exemplo um *.pdf ou *.jpg), deve colocar-se essa informação para que o utilizador decida se quer abrir ou fazer o download em primeiro lugar.

Tamanho dos Arquivos

Para links com arquivos grandes (por exemplo, um HTML com imagens embutidas), é útil assinalá-lo com uma nota, permitindo desse modo a quem tenha uma conexão lenta a opção de usar ou não.

Imagens

Quanto ao posicionamento e o tamanho das imagens, deve-se seguir o bom senso de estética para deixar o artigo claro e agradável ao leitor. Os critérios para isso ficam a gosto do autor original, apenas mude se o resultado final for relevante e se deixar o artigo evidentemente melhor (não mude para algo equivalente). Algumas recomendações:

  1. Quando possível, isto é, quando o objeto da imagem tem um sentido claro, deixe os objetos voltados para dentro do artigo; por exemplo: se a foto é de alguém olhando para um lado, evite colocar a pessoa olhando para fora. Se a foto é de um carro, evite colocá-lo "saindo" do artigo.
  2. Quando há imagens próximas verticalmente, intercale-as, colocando uma de um lado e outra de outro; isso dá um equilíbrio estético e evita parecer que o artigo está "pendendo" para um lado.
  3. Quando as recomendações acima não forem aplicáveis, prefira utilizar o "thumb" padrão, isto é, sem especificar o lado, assim a configuração padrão de cada usuário se encarregará de colocar a imagem no lugar de preferência (geralmente à direita). Por exemplo: [[Imagem:Bota.jpg|thumb|Uma bota.]] a imagem ficará alinhada automaticamente à direita.
  4. Não exagere nos tamanhos (nem tão grande, nem tão pequeno), prefira utilizar o tamanho padrão do modo thumb, isto é, omitir o tamanho. Use um tamanho menor quando a imagem estiver chamando mais atenção do que deveria e um tamanho maior para alguns casos em que a leitura do texto direta é relevante, por exemplo, em casos de mapas ou diagramas diretamente relacionados ao texto.
  5. Por regra, as fotografias e os gráficos devem ter legendas. No entanto, a legenda pode ser omitida se a própria imagem tiver uma legenda ou se for uma óbvia representação do tema do artigo.

Normas de estilo para escrita

Citações

  • Sempre que incluir citações, escreva o texto entre aspas duplas ("). Convém usar sempre aspas duplas em vez de simples (') por uma razão técnica: qualquer texto colocado entre aspas simples, por exemplo 'qualquer coisa', apenas aparece nas pesquisas efetuadas numa busca se as aspas forem também incluídas na pesquisa. Por outro lado, as aspas duplas ficam normalmente mais visíveis.
  • Ao escrever textos citados, inclua a pontuação dentro ou fora das aspas, conforme o sentido do texto.
Exemplo 1: O jornalista disse que a situação era "extremamente deplorável". (citação de parte da frase)
Exemplo 2: O jornalista disse, "A situação é extremamente deplorável." (citação da frase completa)
  • Em citações, para indicar que um texto foi omitido, utilize reticência entre parênteses, assim: "(...) falou para a dona Maria. (...) quem sabe ninguém percebeu."
  • Para manter a uniformidade dos artigos e evitar complicações, use apenas aspas duplas e simples ( " e ' ). Não use aspas "bonitas" ou invertidas ( ‘ ’ “ e ” ). Se estiver a transpor texto de um processador de texto, lembre-se de desligar a função de inserir aspas "inteligentes".

Pontuação

Na maioria dos casos basta seguir as regras de pontuação de português. Há no entanto alguns casos particulares dignos de nota.

  • Por uma questão de padrão e estética, utilize sempre um espaço em branco após cada pontuação. Por exemplo: "O menino andava, corria e pulava! Coitado; até que caiu." Não coloque espaço antes da pontuação nem mais de um espaço após ou entre uma palavra e outra, assim por exemplo: "O menino andava , corria e pulava! Coitado; até que caiu ."
  • No caso de parênteses e aspas, utilize um espaço antes de abrir e outro após fechar, como por exemplo: "Chamavam-no de 'pato' (o menino feliz)." Não use espaços deste modo: "Joãozinho ( o garoto )".
  • Utilize sempre a primeira letra de uma palavra em maiúscula após cada ponto final ou no início de um parágrafo, como por exemplo: "Andou. Pulou. Caiu."
  • Frases entre aspas inicie com maiúscula quando é um exemplo, uma citação ou a fala de alguém (de forma direta), e minúsculas em qualquer outro caso. Como por exemplo:
    • E disse-lhes Paulo: "O céu é azul".
    • O ladrão era conhecido como "o pequeno malandro".
    • João gosta de dizer que "quem pula de árvore em árvore é macaco".
    • Maria disse: "Eu gosto de andar."
  • Para travessões utilize três hífens (---). Como por exemplo ao escrever um diálogo ou fazer uma observação no meio de uma frase, deste modo: "o delegado --- e ninguém sabia disto --- andava armado." Normalmente se utiliza o travessão para dar ênfase à observação, e vírgula quando essa ênfase não é necessária. --- Utiliza-se também o travessão para separar um parágrafo em duas ou mais partes, sem ter que criar um novo parágrafo. Pode-se usar também &mdash; (—) ou &ndash; (–).
  • Evite o uso exagerado de reticências, como por exemplo: "O menino andou... Pulou... Correu..." Use apenas quando for relevante.
  • Em listas de itens, utilize ponto-e-vírgula (;) em cada item e um ponto final no último item, ou use ponto final em todos os itens, como por exemplo:
    • Item A;
    • Item B;
    • Item C.

ou

    • Item A.
    • Item B.
    • Item C.
  • Evite utilizar conjunto de pontuação como: "!!!", "!!", "?!", "!?", ou ".............." etc.
  • O uso de vírgula antes do "etc." é opcional. Não utilize reticências após o "etc.", como por exemplo:
    • Inadequado: "Eu vou levar água, bolacha etc..."
    • Adequado: "Eu vou levar água, bolacha etc."

Termos em outras línguas

De preferência, em termos de outras línguas que não o português, utilize a formatação itálica. Assim:

"Sempre faça backup."

Referências a palavras

Sempre que uma palavra for usada no texto como referência à própria palavra, deve ser escrita em itálico. O mesmo se aplica no caso de nos referirmos a letras.

Exemplo 1: Metrossexual é um termo originado no final da década de 1990, pela junção das palavras metropolitano e heterossexual.
Exemplo 2: Em física, A é o símbolo de ampère.


Notas gerais

Quando tudo mais falha

Se você se depara com um ponto delicado, por favor use outros recursos, como o Manual de Redação da Folha de São Paulo. Onde esta página difere das outras fontes, deve-se preferir o uso desta página, mas por favor sinta-se à vontade para acrescentar a esta página.

Mais simples ainda é simplesmente olhar para um artigo de que você gosta e abri-lo para editar, para ver como os autores e editores fizeram. Você pode então fechar a janela sem salvar as alterações se quiser, mas observe enquanto estiver lá. Quase todos os artigos podem ser melhorados. Quem sabe você pode acrescentar símbolos para adaptá-lo melhor a este estilo.

Não exagere

Torna-se mais fácil retomar o desenvolvimento de um artigo por si ou por quem lhe suceder se não optar por exagerar nas marcações (ligações — internas ou externas, formatação, etc). Mesmo com as sugestões apresentadas, o editor deve ter em conta que qualquer marcação irá resultar numa determinada aparência quando for visualizada.

É mais fácil visualizar a Flapédia, editar ou adicionar artigos, se não se complicar a marcação, mais do que o estritamente necessário para disponibilizar a informação de uma forma compreensiva e útil. O principal objetivo é conseguir uma enciclopédia de utilidade, embora a facilidade de edição e manutenção dessa enciclopédia sejam os sucessores imediatos.

Entre outras coisas, isto significa que o editor não deve usar a marcação excessivamente, e fazê-lo conscientemente.

Questões de formatação

Questões de formatação tais como tamanho da fonte, espaço em branco e cor são questões para todo o site da Flapédia e não devem ser lidadas em artigos exceto em casos especiais. Se por exemplo você sentir que a fonte do título é grande demais ou que deve haver espaço embaixo dos títulos, essas são questões para a folha de estilos, e não a composição do artigo.


Ligações externas

Ferramentas pessoais
Espaços nominais

Variantes
Ações
Navegação
Ferramentas