Guia de estilo do openSUSE

(Redirecionado de OpenSUSE Style Guide)
Ir para: navegação, pesquisa

Por favor siga as orientações seguintes quando criar ou editar artigos nesta Wiki.

Títulos dos Artigos

  • O nome do artigo é também o seu cabeçalho. Seja claro, não use abreviações ambíguas e CamelCase (frases sem espaços e com iniciais maíusculas). Não repita o título no texto como um cabeçalho. Não crie seu próprio container

espaço de nomes. Use capitalização de letras nos títulos.

Tópicos

  • Use a marcação = (Tópico) , não a marcação ''' (negrito) para criar tópicos. Fazendo isso, a tabela de conteúdo é automaticamente gerada a partir dos tópicos e ajudará os leitores irem diretamente para a seção de seu interesse.
  • Inicie com duplo sinal de igual = = não com apenas um sinal de igual =.
Nota: um único sinal de igual produz um texto com o mesmo tamanho do título do artigo, portanto não use para escrever coisas comuns.
Exemplo:
 ==tópico 1==
 ===subtópico 1.1===
 ===subtópico 1.2===
 ==tópico 2==
 ===subtópico 2.2===
 ====subtópico 2.2.1====
 =====subtópico 2.2.1.1=====
  • Caso seu texto seja muito longo, veja a possibilidade de dividi-lo em diversos subtópicos.
  • Use o estilo de título discutido acima para os tópicos.

Aprimore seu Texto

  • Use a formatação MediaWiki e os recursos de marca para tornar o seu texto mais fácil de ler. Coloque os nomes de ficheiros e comandos de terminal numa letra fixa:
<tt>letra fixa</tt>

Explore o Conjunto de Características do MediaWiki

  • Use moderadamente formatação HTML.
  • Usar a formatação MediaWiki deixa os artigos com uma aparência consistente e faz o seu código fonte mais fácil de escrever, ler e editar. Dê uma olhada na ajuda de edição de MediaWiki para descobrir que formatação e ferramentas de marcação você pode usar. Você também pode querer dar uma olhada no código fonte de alguns artigos da Wikipedia.

Comentários

  • Use a página de discussão do artigo para fzaer os seus comentários. Não desorganize o texto do artigo.
  • Se você quiser se comunicar com outros editores, faça comentários invisíveis para aqueles que costumam ler artigos. Para fazer isso, coloque o texto que você peretende que seja lido somente por editores entre tags, "<!-- -->".

Exemplo: 

 Olá <!--isto é um comentário.--> world
  • Será mostrado como:
Olá mundo.

Trabalho em andamento

  • O openSUSE wiki é trabalho em andamento, em construção. Comentários "em construção", "não finalizado", etc., neste contexto, devem ser usados somente em raras ocasiões quando é importante informar ao leitor que o artigo não contém um conjunto de informação completo. Para este propósito foi criado o modelo (predefinição) Ampliar.
Icon-expand.png Este artigo é um esboço!
Este artigo precisa ser ampliado. Você está convidado a ajudar em consonância com as orientações de estilo.

A Predefinição Ampliar dá uniformidade de layout por todo o wiki e lista artigos nesta situação em páginas que precisam de expansão, que é usado por voluntários a procura de algo por fazer.

Sintaxe: 

        {{Ampliar}}

Templates (Modelos, Gabaritos, Formas padronizadas)

  • Há pouco benefício ao leitor em ver títulos e tabelas sem conteúdo, mas às vezes pode ser aceitável se estiver destinado como o padrão para futura edição.

Sem Vaidade

  • Não crie artigos que não contenham pelo menos um mínimo de informações relevantes. A maneira do Wiki sugerir que alguém deva escrever um artigo é criar um link para isto. Entretanto, se existe pelo menos dois links para uma mesma página inexistente, ela aparece em Páginas Procuradas.
Obtida de "https://pt.opensuse.org/index.php?title=Guia_de_estilo_do_openSUSE&oldid=9554"