From BlenderWiki

Para manter consistência ao longo de toda a Documentação do Blender, pedimos aos autores para seguirem fielmente este Guia de Estilos.

Se não estiver por dentro da sintaxe utilizada no MediaWiki pode também consultar a referência oficial em MediaWiki Docs

[edit] Orientações Gerais

A Documentação do Blender deverá ser escrita em Português claro, conciso e correcto. Deve ser correctamente dividida em capítulos, secções e sub-secções.

A divisão em capítulos da Documentação Central (Core Documentation) é definida pelo Documentation Board. Desta forma, não devem ser criadas novas páginas nesta antes de obter aprovação para o efeito.

A divisão de qualquer artigo/tutorial é deixada ao critério do seu autor.

Os tutoriais devem conter uma introdução (abstract) de até 300 palavras, descrevendo de forma sucinta o assunto, objectivos, e destinatários, para rápida visualização.

Cada página deve conter um template apropriado na Primeira linha, de forma a apresentar ajudas à navegação, e qual a última versão do Blender à qual se aplica. Isto deverá ser feito através de

 {{UM/navigator.pt|2.32|paginaanterior|paginaseguinte}}

sendo, claro, 2.32 a versão apropriada.

Este comando mosta:

Além disto, para páginas mais longas, que contenham diversas secções --e em que nem todas se refiram à mesma versão do Blender-- existe um outro Template disponível

 {{version|2.32}}

Isto deve ser colocado imediatamente depois do título da secção/subsecção, tal como exemplificado na secção que se segue abaixo.

No fundo de cada página deve existir um rodapé de navegação:

 {{UM/foot.pt|paginaanterior|paginaseguinte}}

Que se apresenta da seguinte forma:

Redirects to fix

• Meta/Templates → Meta:Templates

paginaanterior e paginaseguinte devem obviamente conter links para páginas válidas!

[edit] Templates

Existe um número de templates limitados, definidos pelo docboard (conselho para a documentação). Pedimos aos autores para usarem apenas os já definidos.

Uma lista dos templates existentes pode ser obtida em Templates

[edit] Orientações relativas a Imagens

A utilização de imagens na documentação é essencial. Os formatos PNG e JPG são preferidos acima dos outros. GIF e outros formatos não-livres são fortemente desencorajados. Formatos que não recorrem a compactação, tais como TGA, são também desencorajados.

Poderá fazer upload das imagens para esta wiki usando a página especial: http://mediawiki.blender.org/index.php/Special:Upload

[edit] Imagens Flutuantes (Floating Images)

Imagens flutuantes devem conter uma legenda, e ser referenciadas no texto. Por favor, evite utilizar frases como "na próxima figura", ou "a figura seguinte". Ao invés, utilize referencias cruzadas (cross references). As referencias cruzadas são abordadas com mais detalhe na secção 4.4.

A utilização de imagens não referenciadas é desencorada. Se tem uma imagem que não sabe onde referenciar, ou a imagem é desnecessária, ou talvez o seu texto esteja pouco claro.

A Documentação, tanto a Principal (Core) como os Tutoriais, devem manter consistência. As dimensões devem ser, no máximo 800x600. A utilização de imagens maiores deve ser evitada, uma vez que se torna desconfortavel para a leitura no web browser.

Uma das funcionalidades mais proeminentes do Blender, é a sua interface, totalmente renderizada em OpenGL e totalmente ajustável em dimensão e escala. Isto é fantástico, mas resulta em muitas des-uniformidades, se os utilizadores recorrerem a 'screen dumps'/'screen shots' e apresentarem diferentes preferencias de interface...

Para se obter clareza e uniformidade, deverá dimensionar a sua interaface de forma a que o 'RED slider' na janela de materiais tenha 18 pixeis de altura. Isto é o normal no Blender se utilizar uma resolução de ecrãn de 1024x768 e pressionar a tecla 'home' para selecionar o tamanho de botões pre-definido.

Se utiliza uma resolução maior, por favor reduza-a para os 1024x768 para capturar imagens do ecrãn. Espero que ninguém tenha ecrãns menores. Uma maneira possível para capturar imagens em resoluçao de 1024 sem ter que alterar a própria resolução de ecran é utilizar o modo janela na linha de comandos: ./blender -w -p 0 0 1024 768. Isto inicia o Blender numa janela com o tamanho exacto de 1024x768 pixeis. De seguida pode utilizar por exemplo o Guimp com uma ferramenta de selecionar de tamanho fixo, que capturará apenas a porção do blender, menos a porção excedente criada pelo Ambiente de Trabalho (moldura da janela).

Screen captures must be in a LOSSLESS format, so use PNG.

Se necessitar de demonstrar uma dada porção da imagem (um botão, um valor, ou um grupo de botões/valores), use, por favor, uma "moldura" amarela (R=255,G=255,B=0) com 2 pixeis de espessura a toda a volta.

Use Blender's default UI style.

[edit] Inline Images

Inline images, mostrando icons do Blender são bem-vindas e tornam as descrições muito mais claras. Uma vez que estas imagens são STANDARD, evite criar as suas próprias e por favor utilize as fornecidas pelo DocBoard.

[edit] Inline Smileys etc

A Documentação Oficial não é um local adequado para exibir smileys. (Claro que isto não significa que não possa utilizar humor nas suas descrições!)

[edit] Tabelas

As tabelas são a forma mais indicada para apresentar grandes quantidades de informação de uma forma estruturada. Podem ser uma alternativa viável à apresentação de várias imagens mostrando diferentes configurações

As tabelas, tal como as imagens flutuantes, devem ter uma legenda e ser referenciadas no texto.

[edit] Código

Esta Wiki tem o seu próprio ambiente para apresentar pedaços de código de Python/C/QualquerOutraLinguagem

Os pedaços de código, tal como as imagens flutuantes e tabelas, devem ter uma legenda e ser referenciados no texto.

[edit] Estilo da Documentação na prática

Este capítulo explica com mais detalhe como esperamos que sejam as páginas desta Wiki submetidas por si.

[edit] Exemplos de imagens

É assim que se insere imagens nas páginas, depois de fazer upload para o servidor:

[edit] Imagens Comuns

Esta é a forma mais fácil de colocar imagens ao longo do texto, e ao mesmo tempo a simples, uma vez que não tem que se preocupar com a flutuação.

[[Image:DemoImage1.png|none|frame|Demo Image number 1]]

Faz com que a imagem comece numa nova linha, sem qualquer texto:

[edit] Imagens Flutuantes (Floating Images)

Esta é uma forma ligeiramente mais complexa, uma vez que terá que ter em conta a forma como a imagem aparecerá noutras resoluções/tamanhos de janela/tamanhos de letra diferentes do seu.

Para obter uma uma imagem flutuando à direita do texto, utilize a seguinte sintaxe:

[[Image:Dummy.jpg|right|thumb|200px|Dummy image]]

Exprimente colocar este código na primeira linha de texto à direita da qual pretende colocar a imagem!
Para limpar o texto até ao fim da imagem, utilize a seguinte sintaxe:

{{clr}}

[edit] Inline Images

Imagens inline (embebidas no texto) tais como são ainda mais simples de obter:

[[Image:DemoImage2.png]]

[edit] Imagens em Tabelas

Se tiver um conjunto de imagens que têm algum tipo de relação entre si, pode colocalas numa simples tabela:

{|
 |valign=top|[[Image:Manual-Part-III-materialRampsExample04.png|thumb|200px|none|No Ramp Shader.]]
 |valign=top|[[Image:Manual-Part-III-materialRampsExample05.png|thumb|200px|none|Color Ramp.]]
 |valign=top|[[Image:Manual-Part-III-materialRampsExample06.png|thumb|200px|none|Both Color and Specular Ramp.]]
|}

No Ramp Shader.

Color Ramp.

Both Color and Specular Ramp.

[edit] Mais ajuda com Imagens

Consulte a página Images and other uploaded files para informação mais detalhada sobre a utilização de imagens.

[edit] Tabelas

As tabelas podem ser escritas em HTML ou utilizando uma sintaxe muito mais intuitiva da Wiki:

 {| border="1" cellpadding="2"
 |+Multiplication table
 |-
 ! × !! 1 !! 2 !! 3
 |-
 ! 1
 | 1 || 2 || 3
 |-
 ! 2
 | 2 || 4 || 6
 |-
 ! 3
 | 3 || 6 || 9
 |-
 ! 4
 | 4 || 8 || 12
 |-
 ! 5
 | 5 || 10 || 15
 |}
 

origina:

Multiplication table

×	1	2	3
1	1	2	3
2	2	4	6
3	3	6	9
4	4	8	12
5	5	10	15

Para facilitar a formatação, existe um template 'UM/prettytable' já definido. Utilizando:

 {| {{UM/prettytable|50%}}
 |align=center | 1 
 |align=center | 2 
 |align=center | 3 
 |-
 |align=center | 4 
 |align=center | 5 
 |align=center | 6 
 |}
 

Obtemos:

1	2	3
4	5	6

[edit] Mais sintaxe usada em Tabelas

Consulte esta página para informação mais detalhada sobre Tabelas: Tables

[edit] Código

Todos os exemplos de código Wiki nesta página foram obtidos colocando-os entre uma par de: <nowiki></nowiki>.

Colocando um ou mais espaços em branco no inicío de cada linha, elas são apresentadas:

 desta forma!

Outra maneira, para grandes porções de código é coloca-lo entre um par de <pre></pre>.

Alternativamente, se não precisar, ou não pretender uma grande caixa de código, pode utilizar <code></code> que tem o seguinte efeito:

Isto é um exemplo de código

[edit] Referências Cruzadas (Cross References)

 translate/traduzir

Cross references are done wikiwise, where as in previous docs we used labels to indicate an object. Wiki uses the object name; so what we need is a *unique* naming scheme for figures.

[edit] Webography

Wiki sites here

[edit] Nome de Ficheiros

A nomeação de ficheiros é assunto delicado, uma vez que deve ser única para todo o Projecto de Documentação, e uma vez que deve ser auto-explicativa e permitir referencias cruzadas de uns capítulos para os outros.

É portanto, imperativo que utilizem o standard definido:

Para a documentação principal

 Manual.pt/Part##/nome-auto-explicativo

Part## é Part ##, onde ## é um número, em numeração romana, da Parte do manual ao qual o objecto pertence. A própria nomeação das páginas é um bom exemplo disto.

 Explain diferences between user contributed pages and translated pages, where the image should still be the original, and as such, we will be using Manual-PartXX-name, instead Manual.pt-PartXX-name
Explicar diferença entre páginas contribuidas pelo utilizador e páginas traduzidas, onde as imagens utilizadas devem ser as mesmas que na Documentação Principal, e portanto em vez de serem Manual.pt-PartXX-name, são Manual-PartXX-name

Para as imagens na Documentação Principal a nomeação deve ser feita da mesma forma. Mas infelizmente, o caracter '/' não é permitido pelo sistema, por isso utilize por favor '-'. Por exemplo:

 Manual.pt-PartXX-nome-auto-explicativo

A utilização adequada da nomeação é deixada ao critério do autor, que é responsável por fazer uma nomeação de ficheiros sempre distinta. The user that is defined is completely up to the author and who is responsible for keeping the whole label unique.