Wiki do Guia de Estilo do Freespire

Esta página é um guia de estilo para o wiki do Freespire. O propósito deste roteiro é fazer com que o wiki do Freespire seja fácil de ser lido seguindo sólidas regras de formatação. Este guia não é a última palavra para toda e qualquer pequena decisão. Muitas vezes, uma escolha é tão boa quanto qualquer outra. Porém, este guia de estilo ajuda a criar uma base que deixa o wiki mais fácil de ser lido e utilizado. Se você for editar páginas no wiki do Freespire, por favor: tente se ater a estas regras.

Formatação de página

Use os modelos e categorias a seguir em todas as páginas do Manual do Freespire:

• No início da página:
  

  {{manual do usuário header}} 

• No final da página:
  

  [[Category:Portuguese]] 

  [[Category:Manual em português]] 

  {{manual do usuário}} 

Opcionalmente, os modelos {{Esboço}} e {{Em construção}} podem ser usados.

Formatação

Convenções para os nomes:

Por favor, evite o uso de orações ao criar uma página, bem como evite usar caracteres especiais, pois eles tornam difícil a criação de links e acabam por quebrar um Template: Como Dar Nomes

Cabeçalhos (Headers):

Use == (dois sinais de igual) para delimitar cabeçalhos, e não ' ' ' (apóstrofes triplas) usadas para deixar palavras em negrito. Inicie com ==, adicione o título do cabeçalho, então termine com ==.

Deixe as marcações simples

Use a marcação mais simples para exibir informações de uma maneira útil e compreensível, pois elas podem aparecer de forma diferente em diferentes navegadores. Use marcações HTML e CSS raramente, mesmo assim somente se houver uma boa razão para tal. Minimizar o uso de marcações em tópicos facilita a edição.

Uso de cores

Usar a cor apenas para transmitir informação deve ser evitado. Isso se aplica também a planos de fundo, tabelas e outras coisas não incluídas na tabela de estilos do wiki do Freespire. A cor não é percebida por daltônicos e não aparece em artigos em preto-e-branco, nem em velhos monitores com poucas cores, displays LCD monocromáticos (PDAs, celulares) etc. Regra básica: use preto e branco!

Regras de Escrita

Pontuação

Na maioria dos casos, simplesmente siga as regras normais de pontuação em Português.

Acrônimos e abreviaturas

Não deduza que seu leitor está familiarizado com os acrônimos e abreviaturas que você está usando. O padrão é digitar por extenso todas as palavras que comporão o acrônimo ou abreviatura, na primeira vez em que forem referenciados, e em seguida mostrar o acrônimo ou abreviatura correspondente. Isto sinaliza para o leitor que este acrônimo ou abreviatura pode aparecer no texto mais tarde e facilita para ele, caso ele tenha dificuldade em se lembrar de seu significado.

Referências a tempo

Lembre-se que o wiki do Freespire provavelmente continuará a ser lido no futuro. Evite palavras e frases como recentemente, último ano, logo, moderno, novo. Onde quer que a informação possa ficar ultrapassada, tente explicitar a data em que ela era precisa.

Ferramentas do wiki

HTML to Wiki Converter
HTML to Wiki
HTML to Wiki Converter - Wiki Tables
CSV-format converter para o formato WikiMedia
ikiwiki é um compilador wiki. Ele converte páginas wiki para páginas html adequadas para publicação em websites.