From BlenderWiki

Jump to: navigation, search

Other pages about editing the wiki:

Tarefas para fazer | Processo de Revisão

Guia do Escritor | Notas para tradutores


in progress Inprogress75.jpg 65%
 Faltando revisão

Para manter a consistência ao longo de toda a documentação do Blender, os autores prospectivos, serão gentilmente solicitados a concordar com o seguinte Guia de Estilo.

Pessoas completamente destreinadas da sintaxe MediaWiki podem também procurar no conteúdo oficial MediaWiki Docs

Dica: Para este manual traduzido para o Português do Brasil, as convenções de códigos padrão da Wiki, bem como suas nomenclaturas originais em inglês serão mantidas para que o usuário possa seguir os padrões estabelecidos pela WikiMedia e pelos mantenedores dos manuais Blender.


Guia de Diretrizes Gerais

A documentação do Blender deve ser escrita de uma maneira limpa, concisa, assertiva e correta para o Português. E deve estar adequadamente subdividida em capítulos, seções e subseções.

A subdivisão lógica da raíz da documentação é ditada pelo quadro de documentação. Páginas novas não são aceitas para adição após aprovadas.

A subdivisão lógica de qualquer Tutorial(ais)oferecido como contribuição é deixada a cargo do autor.

Tutoriais devem conter um texto de resumo até 300 palavras descrevendo o tópico, objetivos e conteúdo para navegação rápida.

Cada página deve ter uma base padrão "template" apropriada sendo que a Primeira linha a ser navegada mostre os alvos de navegação e a versão do Blender para a qual a página estará atualizada. Isso é feito via

 {{Page/Header|2.32}}

Onde é claro 2.32 será o número da versão relevante.Isso é mostrado como:


Também há barras de progresso disponíveis para os tradutores, como esta acima:

Além do mais, para páginas longas que apresentam muitas seções, – algumas delas referentes a outras versões do blender – uma diferente base padrão "template" está disponível:


 {{version|2.32}}

Isso deverá ser colocado logo após o título da seção/subseção, como mostrado na seção logo abaixo.

Na base de cada página, deve haver um rodapé de navegação orientada.

 {{Page/Footer|previouspage|followingpage}}

Isso é mostrado como




A página anterior e subsequente deve é claro conter links para páginas válidas !

Bases Padrão ou Templates

Blender 2.32+

Existe um número limitado de Bases padrão ou Templates definidos pelo quadro de documentação, incluindo caixas de nota, Key bases padrão “ templates” e algumas coisas a mais. Você é gentilmente solicitado a usá-los e somente usar estes .

A lista dos templates está aqui: Templates

Somente insistiremos {{Literal|}} naquele que deverá ser usado para ´englobar` todas as referências para os itens da área de trabalho do Blender (GUI).(Como nomes de controle, Itens de Menu, etc …).


Material de Referência

Quando estiver escrevendo um manual de referência como o manual do usuário, por favor use o template Template:RefBox, e a estrutura de cabeçalhos e sub-cabeçalhos associada. Isos ajuda a manter o manual consistente, com informações comuns e locais bem definidos e facilmente reconhecíveis, para que as pessoas batam os olhos nas informações que procuram mais facilmente. Veja o Reference Box Guidelines Para mais informações e um guia de como usar esta estrutura. Um exemplo da Caixa de referência esta aqui:

Mode: Edit Mode (Mesh)

Hotkey: CtrlR

Menu: Mesh → Edges → Loop Subdivide...

Se você usar estas Bases padrão ou templates o máximo possível, vai salvar o seu tempo e dos seus leitores, Não há necessidade de frases longas como “ Para usar esta ferramenta, você pode pressionar a tecla X do seu teclado...” quando existe uma imagem bacana de um atalho no cabeçalho, em um local consistente onde os leitores sabem como encontrar facilmente. “O Manual não é uma novela; mantenha seus textos concisos e no foco !”

Tipografia

Pode ser util adicionar regras de escrita comuns ao Português, e talvez um link para um site de referência sobre a frase... Como fiz nesta página:french version . --Mont29 14:21, 18 February 2009 (UTC)

Guia de Imagens

A utilização de imagens na documentação é essencial. Os formatos PNG e JPG são altamente preferenciais, mas PNG é o Top. Formatos não livres como GIF e outros devem ser evitados. Formatos sem compressão como TGA e BMP também devem ser evitados.

Imagens podem ser transferidas (upload) para a wiki usando a página apropriada . http://mediawiki.blender.org/index.php/Special:Upload link.

Imagens Flutuantes

Imagens flutuantes devem mostrar um texto e ser referenciadas no texto. Por favor, evite usar escrita como “A próxima imagem...” ou “ A imagem que segue...”. Use referências cruzadas, descritas em here.

O uso de imagens não refernciadas deve ser evitado. Se você tem uma imagem que não sabe referenciar, então a imagem é desnecessária ou seu texto não é claro.

A documentação, tanto a principal quanto Tutoriais, precisam manter a consistência. Dimensões devem ser, de no máximo 800x600. O uso de imagens maiores que 800 Pixels é altamente desencorajada por que elas são muito grandes para serem lidas confortavelmente por um navegador de Internet.

A funcionalidade mais proeminente da interface do Blender, é que ela é totalmente escalável e renderizada por OpenGL, Isso é maravilhoso mas algumas vezes resulta em deformidades se alguns usuários resolvem criar muitos quadros internos para mostrar diversos tipos de configurações, como tipos de material peculiar, ou configurações de texturas, etc...

Para que haja tanto clareza e uniformidade, você deve dimensionar a interface de uma maneira que o deslizador vermelho do material tenha 18 pixels de altura na janela. Isso é o que o Blender produz em uma tela de 1024x768 na tela “padrão” de configuração quando se pressiona o botão “home”-- e enquanto na botoeira--para acerto do tamanho padrão de botão.

Se você usa uma resolução maior, por favor reduza para 1024x768 para fazer a captura da tela. Eu espero que ninguém tenha telas menores! :D Um outro meio de capturar telas com resolução de 1024x768 com monitores de resolução mais alta, é iniciar o Blender com uma linha de comando que obriga o Blender a trabalhar em modo emoldurado, como segue:

  ./blender -w -p 0 0 1024 768

Isso vai iniciar o Blender em uma janela com a tela de desenho em exatos 1024x768 pixels. A caixa (moldura) do aplicativo será mais larga por causa dos adendos da área de trabalho. Para capturar a porção do Blender nesta parte do monitor, você pode usar o Gimp com um 'Tamanho fixo' de seleção de região ( de 1024x768) and ele vai automaticamente capturar a porção da aplicação Blender menos a janela de borda produzida pela àrea de trabalho.

Capturas de tela devem ser em formato sem perda, então use PNG.

Se você precisa delinear ou marcar uma parte de uma imagem ( um botão, um valor, ou um grupo de botões e valores ) por favor use o amarelo (R=255,G=255,B=0) para esta marcação com 2 Pixels de tamanho no contorno total. Use o padrão da Interface do Blender. (do User Interface do Blender ou UI )

Imagens Internas (pequenos ícones)

Imagens internas que mostram os ícones do Blender são benvindas e fazem as descrições se tornarem mais claras. E desde que essas são imagens PADRÃO, evite fazer imagens por conta. Use as gentilmente providas pelo Quadro de Documentação ou DocBoard.

Smileys Internos, e etc

Documentação oficial não é lugar para smileys. (Humor é outra coisa, claro que você pode ter senso de Humor ! )

Tabelas

Tabelas sãoi um jeito apropriado de mostrar muitos dados em um jeito limpo e estruturado. Eles podem ser uma maneira alternativa de msotrar esses dados ao invés de usar cópias de telas para mostrar diversas configurações.

Tabelas, bem como imagens flutuantes, devem ter um texto e devem ser refernciadas no texto.


Código

Wiki tem um ambiente propício para pedaços de código Python/C/qualquer uma...

Pedaços de código, bem como figuras flutuantes, devem ter um texto e serem refernciados no texto.

Estilo de documentação na prática.

Este capítulo mostra em detalhes um exemplo do que esperamos que sua página Wiki seja.

Exemplos de Imagens

Aqui está como inserir imagens nas suas páginas, uma vez que tenha transferido (upload) para o servidor:

Imagens Normais

Este é o método mais fácil para colocar imagens no seu texto, e ao mesmo tempo a maneira mais segura desde que não tenha que se preocupar com imagens flutuantes:

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

Isso faz com que a imagem inicie em uma nova linha, com todos os textos limpos:

Demo Image number 1

Imagens flutuantes

Dummy image
Esta aqui é mais manhosa, desde que você leve em conta o fato dela parecer diferente em outras resoluções/tamanhos de janelas/tamanhos de fontes das suas..

Para pegar uma imagem na direita do texto, use esta sintaxe:

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

Coloque este código na primeira linha se quiser que a imagem apareça logo em seguida !
Para limpar o texto no final da imagem, use a seguinte sintaxe:

{{clr}}

Imagens Internas (pequenos ícones)

Imagens Internas como DemoImage2.png são mais fáceis de se obter:

[[Image:DemoImage2.png]]

Imagens em Tabelas

Quando tiver um grupo de pequenas imagens que tenham alguma relação entre si, você pode colocá-las em uma 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.


Mais ajuda com Imagens

Olhe esta página para uma informação mais completa do uso de imagens:Images and other uploaded files

Tabelas

Tabelas podem ser escritas em HTML or usando uma sintaxe mais limpa 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
 |}

creates

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 uma espécie de padrão base ou template 'UM/prettytable' pré-definido para facilitar.

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

yielding

1 2 3
4 5 6


Mais Sintaxe de Tabelas

Olhe esta página para uma informação mais completa sobre o uso de tabelas: Tables

Códigos

Todos os exemplos acima sobre o código da Wiki foram impressos encapsulando-os dentro de um <nowiki></nowiki> par.

Colocando um ou mais espaços em frente de cada linha, linhas são mostradas como:


 isso

Outra maneira de fazer isso ( Para porções mais largas de código, por exemplo), é encapsular elas dentro de um <pre></pre> par.

Alternativamente, se você não precisar ou não quiser uma grande caixa de código, você pode usar

<code></code> cujos resultados são os seguintes: 

Isso é um exemplo

Referencias Cruzadas

Referencias cruzadas são feitas por pessoal esperto com a wiki, onde em documentos anteriores usamos marcações para indicar um objeto. Wiki usa o nome do objeto, portanto o que precisamos é ter um esquema único de nomenclaturas para figuras.


Webografia

Sites Wiki aqui

Nomes de arquivos

Nomes de arquivos são um assunto delicado tanto quanto estes devem ser únicos ao longo de todo o projeto de Documentação do Blender e devem ser auto-explicativos para permitir referências cruzadas de um capítulo para outro, e etc...

Então é altamente aconselhável fixar um esquema estabelecido:

Para a documentação principal:

 Manual/nome-auto-explicativo

Para imagens na documentação Principal, o esquema de nomes é similar. Mas infelizmente, ‘/’ não é aceito pelo sistema, então use ‘-’ ao invés de ‘/’. Por exemplo:

 Manual-nome-auto-explicativo.ext

O nome definido é completamente pela conta do autor, que é responsável por manter a marcação única.

Padronização de Nomes

Note
Esta é uma seção incompleta, por favor veja também: glossary
Internet vs. internet? popup vs. pop-up? 

Veja Também

Custom Blender Tags