Guia de Estilo do OpenSUSE

Origem: openSUSE, a enciclopédia livre.

Please adhere to the following guidelines when creating or editing articles in this Wiki.

Títulos dos Artigos

O nome do artigo é também 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 namespaces. 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=====

• Case seu texto seja muito longo, veja a possibilidade de dividí-lo em diversos subtópicos.
• Use o estilo de título discutido acima para os tópicos.

Mark Up Your Text

Use the MediaWiki formatting and markup features to make your text easier to read. Set filenames and shell commands in a fixed font:

<tt>fixed font</tt>

Exploit MediaWiki's Feature Set

Use HTML formatting sparingly.

Using MediaWiki formatting gives articles a consistent look and feel and makes their source code easier to write, read, and edit. Have a look at the MediaWiki editing help to find out what formatting and markup tools you can use. You may also want to have a look at the source code of a few Wikipedia articles.

Comments

Use the article's discussion page for your comments. Do not clutter the article text.

If you want to communicate with other editors, make comments invisible to the ordinary article reader. To do so, enclose the text that you intend to be read only by editors within tags <!-- -->

Example:

 hello <!--This is a comment.--> world

is displayed as:

hello world

Work in Progress

The openSUSE wiki is work in progress. Comments "Under construction", "not finished" etc. in this context should be used only in seldom occasions when it is important to tell the reader that article doesn't contain complete set of information. For that purpose was created template Expand

Syntax:

        {{Expand}}

Templates

http://en.opensuse.org/Templates

There is little benefit to the reader in seeing headings and tables without content, but sometimes it can be acceptable if it is meant as template for future edits.

No Artificial Bloating

Do not create articles that do not contain at least a minimum of relevant information. The Wiki way to suggest that somebody should write an article is to create a link to it. If there are at least two links to the same nonexistent article, it appears on Wanted Pages.