Ajuda:Guia de Estilo

De Ooshin
Ir para: navegação, pesquisa

Este guia de estilo (também chamado de livro de estilo) deve ser utilizado como referência para uniformizar os artigos da Wiki Ooshin: é um guia de estilo. As regras propostas não são obrigatórias: há várias boas formas de se fazer algo. Porém, se todos fizerem da mesma forma a Wiki se tornará muito mais fácil de consultar, manter e expandir.

A redação clara, informativa e imparcial é sempre mais importante que 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 wikipedistas 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.

Título do artigo[editar]

A escolha do título de uma página é o primeiro passo para a criação de um novo conteúdo da Wiki Ooshin. Caso a página seja de um artigo, o título deve descrever o assunto a tratar, de modo sintético e sem ambiguidades. Caso a página seja de uma publicação, ou capítulo de uma publicação, o título será o nome em português da publicação ou do capítulo. O uso de maiúsculas e minúsculas em um título deve conformar-se à seguinte norma:

Título das publicações[editar]

Nos títulos em português escrevem-se com maiúscula inicial todas as palavras, com exceção de artigos, preposições, conjunções e advérbios, que se escrevem com minúscula.

Exemplos: A Cor do Meu Destino, Tudo sobre Minha Mãe, A Cidade e as Serras, O Dia depois de amanhã, A Liberdade É Vermelha, O Desespero de Veronika Voss, Antes do Pôr-do-Sol.

Capítulos das publicações[editar]

Nos capítulos das publicações, escrevem-se as palavras com a primeira letra em maiúscula e as demais palavras em minúsculas. Esta regra não se aplica a nomes próprios ou outras palavras que por regra sejam sempre iniciadas por maiúsculas.

Exemplos: A origem das doenças é espiritual, Explicação sobre a luz espiritual, Método de shiatsu ao estilo Okada.

Título das páginas comuns (artigos)[editar]

Nos títulos das páginas que não sejam títulos ou capítulos de livros, escrevem-se as palavras com a primeira letra em maiúscula e as demais palavras em minúsculas. Esta regra não se aplica a nomes próprios ou outras palavras que por regra sejam sempre iniciadas por maiúsculas.

Exemplos: Medicina japonesa, Arte japonesa, República Popular da China.

Parágrafos introdutórios[editar]

Todos os artigos devem possuir um parágrafo introdutório – respeitando o limite máximo de quatro parágrafos – no qual o assunto a ser tratado deve ser brevemente definido e contextualizado. 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.

Títulos das seções do artigo[editar]

Para dividir um artigo em seções, coloque o título da seção entre dois sinais de igual. Assim:

== Esta é uma seção ==

Para criar uma subseção, use três sinais de igual. Assim:

=== Esta é uma subseção ===

Seguindo a mesma linha de raciocínio, o segundo nível de subseção é criado assim:

==== Esta é uma subseção de segundo nível ====

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 facilitam a leitura, já que segmentam e delineiam o artigo.

Eis algumas normas para a formatação de seções:

  1. À semelhança dos títulos dos artigos, intitule as seções usando maiúsculas apenas na primeira letra da primeira palavra e nos nomes próprios que porventura também façam parte do título da seção.
  2. Evite fazer ligações dentro dos títulos das seções. Dependendo das definições utilizadas, alguns utilizadores podem não lê-los claramente. Recomenda-se colocar a ligação na primeira frase imediatamente após o cabeçalho.
  3. O abuso de subtítulos deve ser evitado, pois faz o artigo parecer desordenado e mais extenso do que realmente é. Parágrafos curtos e frases soltas geralmente não fazem jus a um subtítulo próprio: neste caso, é preferível usar texto em negrito ou outras marcas, dentro de uma seção, em vez de criar subtítulos.

Formatação de páginas de publicações[editar]

Como regra geral, adote 40% do espaço da tabela para o japonês e 60% para o português.

Ligações internas[editar]

Os nomes, as palavras e as frases que você considerar que devam ser referidos como informação adicional deverão ser colocados entre dois pares de parênteses retos ou colchetes. Isto fará com que neles seja criada uma ligação interna apontando para o artigo respectivo. Veja o exemplo:

Código: Kandinsky foi professor na [[Bauhaus]] até 1933.
Resultado: Kandinsky foi professor na Bauhaus até 1933.

O uso das ligações internas para outros artigos é encorajado. Use-as em todas as palavras e sequências de palavras em que a consulta do artigo ligado facilite ou aprofunde a compreensão do artigo que está a editar. Por outro lado, o excesso de ligações internas possui efeito antiestético. Portanto, não abuse delas. Nomeadamente, não repita uma ligação em todas as ocorrências de uma palavra: basta ligar a primeira.

As ligações internas devem ser redigidas em conformidade com a convenção de nomenclatura, pois isto padroniza o texto e, consequentemente, aumenta as chances de uma ligação apontar corretamente para um artigo que já existe. Além disto, caso o artigo de destino realmente ainda não exista, o uso da grafia correta induzirá futuros editores a criarem o artigo de destino com um título adequado, que siga a convenção. Portanto, 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 certificar-se de que ele realmente não existe: pode ser que o nome do artigo de destino seja ligeiramente diferente do que o que você digitou.

Muitas vezes, o título do artigo de destino não é o mais adequado para se incluir como ligação interna, no artigo principal. Neste caso, é possível criar uma ligação que possua uma grafia mais adequada e mesmo assim aponte para aquele artigo de destino. Para fazer isto, crie normalmente a ligação interna para o artigo de destino, mas em seguida insira o caractere | (barra vertical) após o texto da ligação interna, e então digite o texto alternativo. Veja o exemplo:

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

É importante que o texto da ligação interna evidencie o assunto tratado no artigo de destino. Por isto, o texto usado para criar uma ligação interna deve ser claro, de modo que o leitor não necessite segui-la para poder perceber do que se trata. Evite usar o texto "clique aqui" (e similares): isto não fornece informação nenhuma.

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

Para poupar trabalho, uma boa estratégia consiste em criar as ligações internas em torno das palavras, mas sem as desinências. Isto é bastante útil, por exemplo, na maioria dos plurais. Veja:

Código: Os [[índio]]s [[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.

Seções padrão[editar]

Quando certas seções padrão são usadas, estas devem ficar no final do artigo, respeitando a terminologia das seções, e uma das duas sequências seguinte:

  1. Notas
  2. Referências
  3. Ver também
  4. Bibliografia
  5. Ligações externas

ou;

  1. Ver também
  2. Notas
  3. Referências
  4. Bibliografia
  5. Ligações externas


Seção Notas[editar]

Por vezes pode ser útil recorrer a anotações ou notas de rodapé, para acrescentar comentários ou esclarecimentos sobre algumas passagens do texto. Essas notas de rodapé são colocadas de forma semelhante às referências.

Seção Referências[editar]

A verificabilidade das informações de um artigo é conseguida através do uso de referências no texto.

Seção Ver também[editar]

No final de subseção[editar]

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.

Como subseção própria[editar]

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 "Ligações externas", 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.

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: {{Artigo principal|História do Brasil}}
Resultado:
Ver artigo principal: História do Brasil

Seção Bibliografia[editar]

É interessante a citação de bibliografia sobre certo assunto, pois possibilita a quem venha a consultar um determinado verbete tenha condições de localizar outras fontes que tratem do tema em questão.

Use uma seção == Bibliografia == para apresentar a bibliografia.

Seção Ligações externas[editar]

A Wikipé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 internet.

Use sempre: == Ligações externas ==

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: https://wikimediafoundation.org
Resultado: https://wikimediafoundation.org
  1. Para substituir o URL por um texto mais adequado, escreve-se o URL e o texto que se deseja apresentar, tudo entre parênteses retos.
Exemplo: [//pt.wikipedia.org a Wikipédia em português]
Resultado: a Wikipédia em português

O URL deve começar com https:// 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 no exemplo acima.

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

URLs como notas de pé de página[editar]

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

Exemplo: Bem-vindo à Wikipedia [//pt.wikipedia.org]
Resultado: Bem-vindo à Wikipédia [1]

Localização dentro do artigo[editar]

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: Um bom exemplo de uma comunidade cooperativa na Internet é a [//www.wikipedia.org Wikipédia, uma enciclopédia em código aberto].
Resultado: Um bom exemplo de uma comunidade cooperativa na Internet é a Wikipédia, uma enciclopédia em código aberto.

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

Websites estrangeiros[editar]

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

Tipos de arquivos/ficheiros[editar]

Se o link não for para um arquivo/ficheiro HTML, mas para um ficheiro (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/ficheiros[editar]

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.

Localização da marcação de esboço[editar]

Para artigos que ainda não estão completos ou apenas iniciados utilize a marcação {{esboço}}, preferencialmente no extremo final do artigo, antes das categorias. Deixe duas linhas em branco precedendo a marcação de esboço.

Imagens[editar]

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[editar]

Nomes completos em vez de abreviaturas[editar]

  • Evite sempre a utilização de abreviaturas, exceto quando o assunto for conhecido exclusivamente pelo seu acrônimo.
Yes check.svg Correto: Produto Interno Bruto, Radar
X mark.svg Incorreto: PIB, Radio detection and ranging

Citações[editar]

  • 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 efectuadas 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, consoante 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 curvas ( ‘ ’ “ e ” ). Se estiver a transpor texto de um processador de texto, lembre-se de desligar a função de inserir aspas "inteligentes".

Pontuação[editar]

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 — (—) ou – (–). 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.
  • 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, como por exemplo:
    • item A;
    • item B;
    • item C.
  • Ou use ponto final em todos os itens, neste caso cada novo item é um nova frase, então deve-se iniciá-los com letras maiusculas, veja o exemplo.
    • 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:
    • X mark.svg Inadequado: "Eu vou levar água, bolacha etc..."
    • Yes check.svg Adequado: "Eu vou levar água, bolacha etc."

Termos em outras línguas[editar]

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

Notas gerais[editar]

Quando tudo mais falha[editar]

Se você se depara com um ponto delicado, por favor use outros recursos. 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 ou para manter uma discussão em Ajuda_Discussão:Guia_de_Estilo.

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[editar]

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 Wiki Ooshin, 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. Entre outras coisas, isto significa que o editor não deve usar a marcação excessivamente, e fazê-lo conscientemente.