Guia de Estilo

From Second Life Wiki
Jump to navigation Jump to search

KBtip2.png Dica: Você não é obrigado a seguir este Guia de Estilo para montar as páginas da wiki, mas o guia pode ajudá-lo a se tornar um editor mais eficiente, pois vai se relacionar melhor com os artigos já existentes. Fique a vontade para adotar essas práticas!

Tem interesse em contribuir para a Extensão da Base de Conhecimento? Por favor leia este guia e obtenha uma melhor compreensão da formatação que estamos aqui utilizando, para elaborar documentos bem estruturados, que não são apenas bem escritos, mas fáceis de ler.

Nosso guia de estilo é inspirado pelo sucesso da adoção de simples convenções, tal como acontece na Wikipédia, com o seu livro de estilo que ajuda a padronizar os verbetes. Mas aqui inserimos detalhes da experiência do Second Life®. Este guia está aberto à mudanças ao longo do tempo, mas procura dar a você, uma base de consulta em caso de dúvida.

Por favor, note que as diretrizes do guia de estilo são destinadas a ser mais rigorosamente aplicadas para os artigos que fazem parte da Base de Conhecimento do Second Life, mas você não precisa segui-las em outros locais da wiki. Mas este guia sempre vai ajudar na melhor comunicação e na clareza dos textos.

Leia as diretrizes gerais da wiki antes de editar artigos da Base de Conhecimento. Estar bem preparado vai ajudar você a começar bem. Você também deve ter uma compreensão básica dos códigos da wiki. Uma combinação do seu texto e um padrão de formatação, vai produzir um resultado surpreendente.

Além disso, fique à vontade para editar qualquer artigo da Base de Conhecimento. Uma vez que um artigo está na wiki, você pode clicar na guia editar junto ao topo da tela. Mas você precisará estar logado na wiki para poder editar.

Não utilize outros guias de estilos como The Chicago Manual of Style ou o The Elements of Style. Quando contribuindo em documentos e comunicados escritos pela Linden Lab, é uma boa ideia que leia as recomendações de estilo da wiki, para ter certeza que a sua colaboração se encaixa nos padrões desta wiki.

Fazendo traduções de textos em inglês, veja estas notas para tradução inglês-português a serem seguidas.

Artigos da Base de Conhecimento

Esta seção discute a estrutura dos artigos e a sua disposição dentro da Base de Conhecimento, a sua ordenação como um todo.

Estrutura dos Artigos da Base de Conhecimento

Existem basicamente dois tipos de artigo da Base de Conhecimento:

  1. Os que respondem a uma pergunta específica ("Como salvar as texturas no disco rígido")
  2. Os que dão alguma informação geral sobre um tópico ("Guia de Empregos no Second Life")

Em ambos os casos, o primeiro parágrafo do artigo deve responder a uma pergunta não formulada:

  1. Depois que eu li isso, o que devo ser capaz de fazer? (Bastante autoevidente.)
  2. Depois que eu li isso, o que devo entender melhor?

Isto pode ser tão simples, como fazer o primeiro parágrafo dizer algo como: "Este artigo discute ___."

Se todos os artigos na Base de Conhecimento começarem desta forma, os leitores se acostumaram a descobrir muito rapidamente se as informações em um artigo específico lhe será útil, sem ter que ler todo o artigo.

Cabeçalhos

Os artigos devem ser divididos em cabeçalhos, cada um representando um tema distinto. Por exemplo, em um artigo que trata de diferentes tipos de objetos com script, cada um deve ter sua própria seção, com seu cabeçalho, para uma melhor organização da página.

Cabeçalhos de nível superior são o equivalente a um comando "h2" utilizado nos softwares de blogs e em outros sistemas de gerenciamento de conteúdo: 

== Cabeçalho ==

Além disso, o conteúdo deve começar na linha seguinte, com cada parágrafo separados por duas quebras de linha (se você usar uma quebra de linha única, o texto continua na mesma linha).

Particularmente em um artigo extenso, deve-se fazer o uso de subcabeçalhos: 

== Cabeçalho ==
O texto vai aqui...

=== Subcabeçalho ===
Mais texto aqui...

==== Subcabeçalho ====
Mais observações aqui...

Manter com prioridade, o fluxo principal do artigo. A tabela de conteúdo aparece automaticamente em um artigo que tenha quatro ou mais cabeçalhos, mas se sentir que o artigo seja muito extenso para percorrer, você poderá criar seções separadas em suas próprias páginas, e vinculá-las a página principal.

Ou seja coloque na página principal um pequeno resumo do assunto ou uma chamada e insira um link para a outra página, onde o assunto será mais desenvolvido.

Se você não quiser que um artigo não apresente uma tabela de conteúdo, insira no topo o seguinte código: 

__NOTOC__


Se você não quiser que um artigo tenha nos cabeçalhos e subcabeçalhos o link de editar, insira no topo o seguinte código: 

__NOEDITSECTION__

Para economizar espaço e alinhar a tabela de conteúdo a direita, use o seguinte gabarito: 

{{TOCright}}

Note que este gabarito não fica bem se você também usar um gabarito de navegação que flutua para a direita.

Escopo sobre a Base de Conhecimento

Um problema básico que sempre acontece nas wikis é a proliferação de páginas que contêm assuntos semelhantes ou até mesmo duplicados, porém sem interligação (links) entre elas. Este fato ocorre naturalmente com o crescimento da wiki. Isso acontece devido a falta de existência de um planejamento centralizado, capaz de localizar estas páginas e organizá-las.

Quando se trata de documentação do Second Life devemos lembrar, por exemplo, que um FAQ sobre o pagamento de uma propriedade deve estar integrado - ou no mínimo, intimamente ligado - ao artigo principal sobre o pagamento de uma propriedade.

Quando se estabelece uma ligação entre as páginas que tratam de um mesmo assunto, isso vai fornecer aos leitores um melhor caminho para conseguir ajuda, e editores mais experientes podem auxiliar a manter as páginas, ligadas entre si.

Informações duplicadas em várias páginas aumentam as chances de que essas páginas não sejam atualizadas, à medida que ocorrerem atualizações das informações. Esta duplicidade reduz drasticamente a utilidade da Base de Conhecimento como um todo. Sempre que possível, tente modularizar os artigos para que as que informações sobre um determinado assunto fique apenas em um só lugar, e que fiquem ligados a outros artigos correlacionados. Dessa forma, você só tem que atualizá-lo apenas uma única vez.

Uso do tempo presente

Quando você disser as pessoas o que acontece, quando elas fazerem algo, sempre faça o uso do tempo presente. Por exemplo:

  • Clique em IM. Abre a janela do IM.

Evite usar:

  • Clique em IM. A janela do IM será aberta.

(IM = Instant Messaging é equivalente ao MI = Mensagem Instantânea)

Terminologia

KBcaution.png Importante: A instância mais próxima de um "glossário oficial" é o menu ajuda do Visualizador 2 que tem embutido um glossário, que usa o conteúdo de Viewerhelp:Glossary.

Termos específicos utilizados no Second Life

  • "inworld" (costumava-se ser escrito como "in-world," mas seguiu o mesmo caminho usado para "e-mail" sendo mais utilizado a forma e-mail).
  • "rez" ou "rezzed" (não ressed/rezed/res). Não use aqui as maiúsculas.
  • Sempre inicie as palavras com maiúsculas para "Second Life."
  • Escreva "plugin" sem o hífen.
  • Use "SLurl" em vez de "SLURL", quando se referir a uma URL do Second Life (http://www.SLurl.com). É uma marca registrada da Linden Lab.
  • Capitalizar uma palavra é iniciar a palavra com letra maiúscula.

Quando se referindo reflexivamente a Linden Lab, opte por usar a expressão "nós recomendamos" em vez de usar "a Linden Lab recomenda", exceto em situações onde uma linguagem formal seja exigida, como um documento legal ou algo assemelhado.

  • Provavelmente em 99% do tempo, você escreverá algo simplesmente como: "Faça x para obter y."
  • Você poderá também dizer coisas como: "Nosso testes indicaram que quando x acontece, y também ocorre".

Se você estiver se referindo a um programa ou serviço específico da Linden, sempre use o nome do programa.

Elementos da interface do usuário

Seria interessante fazer o uso de alguns termos padrões para aplicá-los em toda a Base de Conhecimento para se referir a elementos da interface do usuário, muitas vezes denominado de UI ("user interface" em inglês).

Interface de Usuário são as diversas estruturas pertencentes ao Visualizador, onde o usuário interage.

  • Aquela estrutura é um "diálogo" ou de uma "janela"?
  • São essas "formas" ou são "guias" ou o quê?

Manter a consistência dos termos torna mais fácil para os leitores entenderem o que estamos falando.

De uma maneira geral, devemos capitalizar e escrever exatamente os elementos que estão na interface de usuário (UI). Se há alguma capitalização inconsistente na interface do usuário (UI), seria anotar e solicitar a correção no rastreamento de erros. Se existir um erro ortográfico ou um erro de digitação na interface do usuário, provavelmente é um bug e deverá ser corrigido pela equipe de desenvolvimento.

  • Menus - Nós todos sabemos o que são os menus. Eles aparecem no topo da janela do Second Life.
    • As vezes eles também aparecem no topo de uma janela, dentro da janela do Second Life, como por exemplo: a janela do Inventário. Nestes casos, é provavelmente mais útil informar qual janela interna estamos nos referindo. Por exemplo:
      • Na janela do Inventário, selecione Arquivo > Abrir.
    • Caso contrário corremos o risco de confundir as pessoas, uma vez que existem dois menus "Arquivo" disponíveis, se você tem a janela do inventário aberto.
    • O item separador para menus deve ser a marca > . Por exemplo:
      • Selecione Tirar > Desanexar > Mão Direita para largar o objeto que você está segurando.
  • O menu em forma de pizza (do visualizador antigo) - Ele é uma roda de seleções que sempre aparece quando você usar botão direito do mouse sobre algo no mundo virtual. No novo visualizador, o menu é retangular.
    • É mais fácil escrever alguma coisa mencionado pelo nome. Por exemplo, basta escrever "botão direito do mouse sobre seu avatar e selecione Tirar > Sapatos".
  • Janelas - Faça o uso deste termo para janelas que aparecem internamente no visualizador, tais como a janela do Inventário ou a janela do botão Busca.
    • Nota: Uma janela é qualquer coisa que satisfaça a maioria das seguintes condições:
      • Que exista o botão X no alto a direita da janela.
      • Ela tem um título no canto superior esquerdo.
      • Ela pode ser movida ao seu redor ou ter a sua tela redimensionada.

Um exemplo de algo que não é uma janela é a estrutura que aparece na parte inferior do Visualizador de quando você clica no botão Bate-papo local (botão Comunicar-se no visualizador antigo). Devemos padronizar o local do chat chamando de Bate-papo local (Chat bar em inglês), uma vez que basicamente não satisfaz, a nenhuma das condições acima indicada.

  • Diálogos que podem ser os quadros Conversas ou Avisos - Use este termo para os retângulos que aparecerem no canto inferior direito e que quando clicados, exibem uma mensagem (ou o quadro azul de mensagens suspenso no alto a direita, no Visualizador antigo) quando alguma coisa acontecer no Second Life, como quando alguém lhe enviar um item para o seu inventário ou quando alguém lhe envia um teleporte ou quando você tenta se sentar em um local onde isso não seja possível.

É importante ressaltar que existem vários tipos de diálogos, como a notificação do grupo ou do status de um amigo, que aparecem embaixo a direita por alguns segundos como por exemplo: "uma caixa de notificação aparece no canto inferior direito, informando que um de seus amigos está on-line ".

KBnote.png Observação: No novo Visualizador, nós consideramos simplesmente chamar de notificação, porque apenas notificam ao Residente que alguma coisa aconteceu e que não apresenta o botão Sim/Não, na qual a maioria dos diálogos aparecem.
  • Abas ("Tabs" em inglês) - Dentro das janelas no Second Life, você vai encontrar no alto, algumas abas. Por exemplo:

Clique no seu perfil. No novo Visualizador, é o segundo botão de cima para baixo.
Verá uma aba denominada: Meu perfil e outra aba denominada: Meus destaques.

  • Botões - Use este termo para os botões que aparecem na interface do usuário (UI).
    • Clique no botão Salvar.
    • Ou clique em Salvar.
  • Campos - Qualquer coisa que você faça para dar entrada a um dado no Second Life. Abaixo alguns tipos de campos:
    • Use o termo caixa de seleção ("checkbox" em inglês). As caixas de seleção são quadradinhos onde se pode ativar ou desativar uma determinada funcionalidade.

Por exemplo: No novo Visualizador, clique no alto a esquerda em Eu e depois em Preferências. Clique na aba Geral. Poderá selecionar o item Realçar amigos. Isso vai realçar o texto de seu amigo nas conversas ou no bate-papo local.

Use o termo "selecionar" para marcar ou desmarcar uma caixa de seleção.

    • Use o termo "menu suspenso" ("dropdown" em inglês), para menus que aparecem quando se clica com o botão direito do mouse sobre um objeto ou sobre um avatar.
  • "Botão rádio" é o nome dado a um botão que têm círculos ao redor dele e que apresenta um grupo de campos a escolher.
  • Existe um campo órfão que não tem um botão ao lado dele, que é o campo do filtro na janela do Inventário. Esse é o tipo de situação em que você pode escrever algo como: "Digite algo no campo do filtro, situado no topo da janela do Inventário."
  • Qualquer item da Interface do Usuário (UI), como um campo de texto ou os campos de números que aparecem na edição de um prim, podem ser escritos como: "o campo ___."
  • Uma procedimento geral: Se você edita um artigo longo, você provavelmente pode em optar em não ser muito detalhado sobre o conteúdo de um campo. Poderá escrever: "fornecer uma descrição" em vez de: "fornecer um valor para o campo descrição".

Termos obsoletos

Como o Second Life tem amadurecido, alguns termos utilizados por Lindens, no passado, se tornaram obsoletos. Devemos ter o cuidado de apenas fazer o uso de termos atuais para os conceitos e itens que são descritos, tanto para evitar a confusão, bem como para evitar possíveis problemas legais, como o exemplo de escrever "dinheiro" em vez de "Dólares Linden" ("Linden Dollars" em inglês). Dólares Linden não são dinheiro!

Por exemplo: o termo "Private Islands" ("Ilhas Privativas" em português) é obsoleto e deve ser usado a expressão "Estates" ou "Private Region" ("Região privativa" em português), quando existem um grupo de ilhas privativas juntas.

Duas ilhas juntas, mas isoladas do resto do SL, podem ser chamadas de uma só ilha, em vez de duas ilhas. Tenha em mente que são estas orientações gerais; o contexto é tudo!

Termos que nós usamos::

  • "Região" em vez de "sim" ou "simulador" quando se referindo a uma simples Região.
  • "Sim host" em vez de "sim" ou "simulador" quando se referindo a um servidor de hospedagem de Regiões.
  • "Residente" em vez de "usuário", "assinante", "cliente", "avatar", etc.
    • Existem situações onde o termo "avatar" seja mais apropriado para se usar -- por exemplo: quando se discute a representação no mundo virtual, de um residente que pode ser clicado ou editado. Nesse caso, use sem dúvidas, o termo "avatar"!
  • "Estates" ou "Private Regions" em vez de "ilhas", "ilhas privativas", etc (um Estate é um grupo de Regiões Privativas).
  • "Linden Dollars" em vez de "dinheiro", "money", "dollars", "cash", "lindens", etc.
  • "L$" em vez de "$", quando denotando Linden Dollars.
  • "US$" em vez de "$" quando denotando US dollars (dólares americano)
  • "SLurl" em vez de "SLURL", quando se referindo a URLs do Second Life (http://www.SLurl.com).

Termos inapropriado podem ser de uso comum para alguns residentes, mas aqui devemos fazer o uso dos termos corretos, acima indicados.

Quando se trata de pesquisa com palavras-chave, é importante lembrar que nós temos que levar em conta o uso mais comum. Assim, palavras-chaves para termos comuns, devem ser colocadas nas páginas apropriadas.

Quando capitalizar

Siga as regras padrões para capitalizar, então capitalize, ou seja, inicie com maiúsculas:

  • Nomes próprios.
  • A primeira letra da primeira palavra em listas numeradas ou com marcadores.

Também capitalize:

  • "Second Life Viewer", "Viewer" e "Visualizador", quando se referindo ou seu software cliente.
  • Second Life
  • Linden Lab
  • Internet
  • Linden Dollar ou Dólar Linden
  • Residente ou Residentes, quando se referindo a membros da comunidade do Second Life.
  • Região (quando se referindo a uma Região do Second Life), Private Region, Homestead Region, Openspace Region.
  • Nomes de regiões do Second Life, por exemplo:
    • Copacabana
    • Help Island
    • Brasil Rio
  • A primeira letra de cada termo que identifica o nome da tecla do teclado:
    • Ctrl-A
    • Tecla Escape
    • A tecla M
    • Ctrl-Shift-Q
  • A primeira letra de cada termo que identifica um botão ou um menu dentro do Visualizador.
    • Inventário
    • Voar
    • Botão IM ou botão MI (mensagem instantânea)
    • Menu Edição
  • Acrônimos:
    • SL
    • HTML
    • WWW

Em geral se deve capitalizar qualquer elemento pertencente a interface, (nome dos campos, botões, menus, etc) exatamente como aparecem no Visualizador do Second Life.

Não capitalize as seguintes palavras/frases:

  • Web/website (A menos que seja no contexto de: "World Wide Web")

Formatação

Esta seção aborda o atual estilo de formatação dos textos. Devemos ser ousados ? Vamos colocar em itálico, os nomes das seções ? Já que estamos abordando o uso do HTML na wiki, vamos mostrar algumas simples regras a serem seguidas.

Regras gerais

  • Negrito - Use o texto em negrito ao se referir a qualquer coisa relacionada a Interface do Usuário (UI em inglês), onde você necessitará clicar para interagir. Isso inclui o seguinte:
    • Nomes das abas
    • Nomes dos campos
      • Seleções que você deverá realizar para os campos
    • Nomes dos botões
    • Nomes dos links
    • Menus e selecionar itens do menu
    • Exemplos:
      • Na janela Ferramentas, clicar no botão Mais.
      • Na janela Ferramentas, clicar na aba Objeto.
      • No menu suspenso Tipo de bloco à construir, selecione Cubo.
      • Selecione Mundo > Sol > Pôr-do-sol para ambientar imediatamente o pôr-do-sol. (pôr-do-sol ou pôr do Sol)
  • Não use negrito - Não faça o uso do negrito para os nomes das janelas.
  • Itálico - Use o itálico com parcimônia, em situações de EXTREMA ÊNFASE (na qual deverão ser raros de acontecer). E mesmo em raras situações, em textos que acompanham as imagens.
  • Aspas - Quando você necessitar especificar algo que o usuário precisa dar a entrada, o coloque entre as aspas. Isso geralmente é aplicável apenas a textos a serem escritos nos campos, e é provavelmente uma rara situação se necessitar especificar uma sequência exata, do que deve ser digitado.
  • Pontuação - Evite fazer o uso da pontuação no sentido de abreviar uma palavra. Por exemplo:
    • Use isto é em vez de: i.e.
    • Use exemplo em vez de: exem.
  • Sobrescrito - Use este código <sup> </sup> para elevar corretamente um índice conforme a necessidade. Um exemplo comum é a exibição adequada da abreviatura para "metros quadrados".
    • ERRADO: m2
    • CORRETO: m2
    • Dado por: m<sup>2</sup>
  • Outro recurso tipográfico - Faça o uso apenas do traço para indicar quebra de pesamento, ou seja do: "—", não do "--" ou do "-".
    • Se você não os tem em seu teclado, apenas copie e cole &mdash; este código html.

Títulos e subtítulos

Sempre capitalize o início de uma sentença. Ou seja, deverá sempre capitalizar a primeira letra de uma palavra, desde que seja um nome próprio ou outra palavra indicada na seção acima, ou um termo de relevância. Não capitalize palavras comuns que normalmente não são capitalizadas. Por exemplo:

  • INCORRETO: Uma Visão Geral da Segurança Second Life
  • CORRETO: Uma visão geral da segurança no Second Life
  • INCORRETO: Como Eu Faço Para Anexar Um Objeto Ao Meu Avatar ?
  • CORRETO: Como eu faço para anexar um objeto ao meu avatar ?

Listas ou listagens

O que se segue são algumas diretrizes na montagem de listagens.

Listas numeradas

Use listas numeradas para enunciar uma série de etapas que devem ser seguidas, em certa ordem. 

# Clique no botão '''Log in'''.
# Leia as mensagens do dia.
# Divirta-se!

Resulta em:

  1. Clique no botão Log in.
  2. Leia as mensagens do dia.
  3. Divirta-se!

Em geral, cada item ou instrução em uma lista numerada deve ser uma frase completa e deve ser pontuada de acordo - ou seja, com um ponto, um ponto de exclamação ou (em casos raros) um ponto de interrogação.

Listas não ordenadas

Use os asteriscos para a série de breves citações. Eles são frequentemente encontrados na forma de uma pequena observação, de "dicas rápidas" ou de "recursos relacionados", no final de um artigo: 

* Considere isso!
* Considere isto!
** Ou use dois asteriscos, mas não exagere

Se você está iniciando um longo parágrafo com um asterisco, considere fazer o uso de uma listagem, para que o texto fique melhor formatado.

Arquivos, endereços, URLs, códigos e outros dados de entrada

Utilize o código <code> para exibir uma cor de fundo, com uma fonte fixa, para nomes de arquivos, caminhos de diretórios, URLs (ou partes deles), ou ainda, para trechos de dados de entrada para ser digitado pelo usuário. Por exemplo:

  • Olhe em C:\Program Files\Second Life\app_settings\.
  • Edite o arquivo: settings.xml.
  • Recupere o valor do item capacidade de: https://cap.secondlife.com/get_reg_capabilities
  • Use o parâmetro max_results para limitar o máximo valor a ser aceito no campo.
  • Use o parâmetro AgentLimit para automaticamente limitar o número de objetos existentes em uma Região.
  • Na caixa situada no alto, digite: 512.
  • No campo Região, digite: Sandbox Newcomb.

Coloque URLs longas em linhas separadas, fazendo o uso do código <pre>.

Para exemplos de códigos que ocupem muitas linhas, faça o uso de como destacar uma sintaxe. 

 # Olá Mundo! em Python

 def main():
     print "Olá Mundo!"
 
 if __name__ == '__main__':
     main()

Tabelas

Nós usamos o gabarito KBtable, para obter tabelas com estilo consistente. O modelo KBtablehead é utilizado para tabelas com uma só linha de cabeçalho. A ênfase geral é a legibilidade, sendo minimamente elegante e sem o uso abusivo de "encaixotamento". Este estilo está sujeito a revisão futura, para um melhor desenho.

Por exemplo, isto: 

{| {{KBtable}}
|- {{KBtablehead}}
!  
! Coluna A
! Coluna B
! Coluna C

|- 
| '''Linha A'''
| complete
| estes
| campos e

|- 
| '''Linha B'''
| ganhe 
| um 
| prêmio

|}

torna-se isto:

Coluna A Coluna B Coluna C
Linha A complete estes campos e
Linha B ganhe um prêmio

Para usuários mais experientes, acesse ao link do MediaWiki, para outras modalidades de tabelas.

Avisos, notas, dicas e outros gabaritos

Se há algo que você acha que mereça algum destaque em um artigo da Base de Conhecimento, colocar um aviso, ou uma nota ou ainda uma dica, use a tabela abaixo indicada. A tabela apresenta os principais quadros de avisos que fazem parte do grande grupo de gabaritos da Base de Conhecimento.

Gabarito Código wiki Descrição O visual do quadro de aviso
Template:KBwarning {{KBwarning|Texto}} Uma forte advertência do que NÃO fazer, e se for o caso, indicar as consequências, incluindo algo que pode causar ferimentos ou danos.
KBwarning.png Aviso: Texto
Template:KBcaution {{KBcaution|Texto}} Um importante aviso do que precisa ou deve ser feito - basicamente, é o o oposto do gabarito KBwarning.
KBcaution.png Importante: Texto
Template:KBtip {{KBtip|Texto}} Uma dica útil para tornar um processo mais fácil de ser executado.
KBtip2.png Dica: Texto
Template:KBnote {{KBnote|Texto}} Considerações adicionais e coisas que sejam interessantes de saber.
KBnote.png Observação: Texto
Template:KBtrivia {{KBtrivia|Texto}} Informação opcional, um bônus. Estes é um gabarito para avisos menos relevantes e que não seja algo trivial.
KBtrivia.png Trívia: Texto

Por exemplo, aqui um item que se encaixa no uso do gabarito KBCaution:

KBcaution.png Importante: Certifique-se em clicar no botão Salvar ou o seu trabalho será perdido !

Solução de problemas

Se você tiver problemas em incluir determinados estilos ou links em um gabarito, como uma "?" ou um outro caractere que possa interferir, use o seguinte formato:

"{{Nomedogabarito|1=texto}}" colocando o código "1=". Por exemplo: 

{{KBcaution|1=[http://forums-archive.secondlife.com/327/85/252954/1.html Não clique aqui !]}}

O procedimento CORRETO será a sintaxe:

KBwarning.png Aviso: Não clique aqui !

O procedimento ERRADO será a sintaxe:

KBwarning.png Aviso: http://forums-archive.secondlife.com/327/85/252954/1.html Não clique aqui !

Ligações internas ou externas

Liberdade para lincar (sobre links no MediaWiki) tornar mais fácil obter maiores informações sobre um determinado tema, e economiza o uso do botão pesquisa da wiki. Se ficar em dúvida se deva ou não colocar uma ligação, sempre opte em colocá-la.

Insira uma ligação (link) quando a página apontada, contiver informações relevantes, cujo conteúdo não será desenvolvido na atual página.

Por exemplo: um artigo sobre uma dica de desempenho da renderização de um avatar:

Se você estiver em uma área muito movimentada, com diversos avatares, certifique-se de permitir o Avatar Impostors.

Esta ação permite obter quatro benefícios:

  1. Economiza espaço, porque você não vai necessitar explicar um avançado conceito no atual artigo.
  2. O conteúdo de uma ligação interna pode ser melhor desenvolvido em uma página a parte, facilitando a sua atualização.
  3. Torna mais fácil a navegação entre os tópicos relacionados.
  4. Uma ligação externa pode conter informações que sejam úteis a wiki e ao leitor.

Sentenças imperativas

Faça o uso de sentenças imperativas, contanto que elas não sejam muito extensas, pois encoraja uma rápida ação, ao informar ao leitor o que vai acontecer se ele clicar neste link:

Linque com objetividade, relacionando as palavras que apontam para o site externo.

Além disso, citando artigos onde pode haver ambiguidade, se eles estão na Base de Conhecimento ou em outro lugar da net, deve ser feito o seguinte esquema:

    • O link deve colorir o título do artigo, mas considere se isso vier a ser impresso, que não será tão evidente.
    • Então coloque entre as aspas o título. Desta forma fica mais evidente que é uma ligação externa.
  • ERRADO - Leia este artigo para maiores informações sobre verificação da idade.
  • O link nas palavras "este arquivo" não permite ao leitor saber para onde irá a ligação. Para a wiki ou para o exterior.

Imagens

As imagens mostram o Second Life como ele é. Você pode enviar imagens a wiki usando o formulário: "Enviar arquivos". Todas as imagens utilizadas na wiki, devem ser aqui hospedadas. Não lincamos imagens em sites externos.

Geralmente se envia uma imagem como PNG e desde que não ocorram perdas, a wiki deve ajustá-la de forma dinâmica.

Não use acentuação, cedilha ou til ao nomear uma imagem. Esta wiki não vai inserir a imagem na página desejada. Uma futura atualização do software da wiki deverá eliminar esta restrição.

As imagens devem ser inseridas nos artigos com o tamanho de 640 pixels (640px) ou menos, se as dimensões da imagem original forem legíveis para tamanho menores. O exemplo abaixo tende a ser um bom equilíbrio entre visibilidade e conteúdo:

O código: 

[[Image:Flying-car.jpg|640px]]

Resulta em:

Flying-car.jpg

Que é a imagem original do carro voador, com 1024px de largura.

As miniaturas podem ser usados ​​com moderação, se há a necessidade de incluir várias imagens: 

[[Image:Flying-car.jpg|none|thumb|''Vejam!!! Um carro voador!'']]

Resulta em:

Vejam!!! Um carro voador!

Estilos

  • Não há necessidade de alinhar as imagens no centro da página. Em alguns casos, pode ser feito, por questões estéticas. Está tudo bem se deixar a imagem com o seu tamanho padrão, ou alinhada à esquerda. Opte em usar imagens de menor tamanho. O usuário pode clicar na imagem, para obter ela, em maior resolução.
  • Para fazer vídeos que usam de detalhes semelhantes aos vídeos oficiais, use o software SnagIt da Camtasia, utilizado por nós.
  • Apenas coloque imagens que realmente sejam necessárias, se você está falando sobre a janela de Ferramentas, você não deve capturar toda a janela do Second Life.
  • Se você estiver fazendo um desenho para chamar a atenção a um detalhe de uma imagem, como por exemplo, circundando um botão ou uma opção de menu, use a cor rosa, e certifique-se que a a linha seja grossa o suficiente, para se destacar sem obscurecer qualquer outra coisa em excesso.
  • Utilize o formato PNG, em vez de GIF, a menos que você esteja pegando uma imagem do mundo virtual, neste caso opte em usar JPEG.

Sempre coloque legendas nas imagens! Se você colocar uma frase ao lado de uma imagem, deve incluir algumas informações para detalhes que não sejam facilmente perceptíveis na imagem propriamente dita.

  • A legenda deve se situar sempre embaixo da imagem, sem um espaço em branco entre os dois.
  • Use uma frase completa, e pontuá-la como se fosse uma sentença.
  • Escreva a frase em itálico.
  • Não rotule as imagens como "Figura 1", "Figura 2", etc. A legenda deve explicar o conteúdo da imagem.
  • Use o requadro padrão para manter a consistência com as imagens já existentes.

Revisões

As imagens podem ser automaticamente substituídas por outras de mesmo nome. Isso é útil se houver uma nova versão do programa do Second Life com mudanças na Interface do Usuário (UI), então se utiliza a imagem mais recente. Basta enviar o arquivo (fazer o upload), em seguida, confirme que você deseja substituir a versão antiga. Este processo vai substituir todas as imagens vinculadas na wiki. Se você cometer um erro, você pode reverter.

Vídeos

Você pode inserir vídeos e multimídia para tornar os artigos mais úteis e divertidos. Os vídeos permitem tornar mais fácil de entender, a cinética e os conceitos 3D. Por exemplo: o código "{{KBvideo|3578377}}" torna-se:


<videoflash type="vimeo">3578377|640|480</videoflash>


Assim como as imagens, deve inserir vídeos com largura de 640px. Utilize o seguinte gabarito Template: KBvideo para inserir vídeos na wiki, onde constam maiores informações sobre o assunto. Também sempre que for apropriado, incluir o vídeo em sua própria seção com o cabeçalho de: "Vídeo tutorial", e um texto resumindo o assunto que o vídeo trata.

Nós padronizados os vídeos, como nos tutoriais do Torley no site Viemo para que você possa pesquisar.

Temos também uma opção alternativa dada pela extensão Widgets, mas ela entra em conflito com FlaggedRevs, assim não é possível fazer o seu uso em vídeos em artigos da Base de Conhecimento.

Veja aqui vídeos tutoriais do Second Life. Necessário se logar no site da Linden lab.


Nota: Para vídeos situados no Youtube, use o gabarito: {{KBvideo|xxxxx|425|344|type=youtube}} , onde xxxxx é uma string obtida da URL do vídeo. Os valores 425 e 344 definem o tamanho do vídeo. Para maiores detalhe veja em Template:KBvideo.

Gabaritos de navegação

KBcaution.png Importante: Esta especificação está sendo desenvolvida. Opte em reutilizar os gabaritos de navegação já existentes da versão em inglês, traduzindo para o português. Caso contrário entre em contato com a equipe de documentação, para o uso de novos tipos de gabaritos

Você poderá usar o conjunto de gabaritos existentes em: navigation templates que fornecem ligações fáceis entre artigos relacionados, como por exemplo, o gabarito Template:Navbox/Wiki/pt acima a direita, realiza.

Os gabaritos podem ser inseridos em qualquer artigo que desejar, bastando que os códigos dos gabaritos sejam colocado no alto das páginas

Para facilidade de manutenção, deve criar os gabaritos de navegação, no namespace ou domínio Predefinição.

As melhores práticas

Gabaritos de navegação oferecem uma boa navegação se:

  • Escolha os artigos a interrelacionar com cuidado. Será que com o uso de um gabarito de navegação, vai ajudar o leitor a se mover de forma eficaz entre os artigos? Escolha dois artigos de seu gabarito de navegação. Veja se um leitor realmente vai querer ir do artigo A para o artigo B? Um gabarito de navegação com muitas ligações cria desordem e perde a sua eficácia.
  • O gabarito de navegação deve ser relativamente pequeno. Se você achar que tem muitos artigos em um único gabarito, considere separar alguns deles em mais de um gabarito, ou remover alguns da sua lista, deixando apenas os artigos mais diretamente relacionados e relevantes.
  • O gabarito de navegação não deve ser muito pequeno. Um gabarito de navegação com apenas dois links pode ser melhor representado por um link normal, no corpo de cada artigo.

Gabaritos de navegação devem fornecer navegação entre artigos existentes:

  • Gabaritos de navegação não devem conter "links vermelhos". Se um artigo ainda não existe, por favor, escreva primeiro!
  • Evite colocar no gabarito de navegação, texto sem link.
  • A não ser que considerado essencial, evite o uso de ligações externas em modelos de navegação. Em vez disso, inclua quaisquer links externos, no artigo principal.

Gramática e linguagem

Esta seção contém dicas úteis sobre gramática e linguagem.

Reflexões sobre o estilo de escrever

"A melhor maneira de ser um chato é não deixar nada de fora" -Voltaire (tradução livre)

Edite os artigos de forma consistente com suas características originais, conforme estabelecido por funcionários da Linden Lab. Alguns tópicos terão obviamente um texto mais liberal do que de outros. A língua deve ser concisa o suficiente para comunicar de forma sucinta, mas não tão seco que é aborrecido. Em exemplo, o humor é útil para exibir certo ponto de vista, mas não deve desviar a atenção para o entendimento do artigo.

No geral, uma vez que este é material de referência, o tom da Base de Conhecimento é mais formal do que nos blogs oficiais do Second Life. Em caso de dúvida, consulte artigos já existentes, criados pela equipe de documentação.

Erros comuns de gramática

O ponto e vírgula são usados ​​para separar duas seções de uma sentença composta, indicando uma estreita relação entre as duas seções de um período. Podemos pensar neles como em algum lugar, entre uma vírgula e um período.

Tente evitar o uso de uma vírgula, onde um ponto e vírgula seria mais apropriado. Se não tiver certeza, pergunte a alguém.

Nota: Sempre faça o uso de frases curtas e concisas, em vez de longas frases.

Misturando menus e janelas

Usamos o sinal ">" para indicar uma hierarquia, e é geralmente desnecessário informar que devemos percorrer o menu, a menos que exista alguma possível confusão ou o artigo é destinados a recém-chegados na wiki.

  • CORRETO - Mundo > Foto
  • ERRADO - Mundo -> Foto

O mesmo se aplica para o menu em forma de pizza, do visualizador antigo, onde ">" é explicitamente mostrado, para os níveis mais profundos do menu.

Quando os elementos da interface do usuário estão misturados, descreva o caminho.

  • CORRETO - Abra a janela Preferências selecionando: Eu > Preferências, clique na aba Configurações, em seguida, desmarque a opção Personalizar porta.
  • ERRADO - Eu > Preferências> Configurações, desmarque Personalizar porta.

Combinação de teclas

Estamos cientes que em alguns sistemas operacionais preferem fazer o uso do sinal de "+" em vez do de "-", mas vamos aqui dispensá-los completamente. Como este é o Guia de Estilo sobre o Second Life; as combinações de teclas serão representados como mostrados nos menus do Visualizador (Viewer).

  • CORRETO - Ctrl-Shift-W
  • ERRADO - Ctrl + Shift + W

Para visualmente embelezar as combinação de teclas e faze-as se destacar, usaremos os gabaritos disponíveis em: Template:K. Por exemplo:

  • "tecla{{K|T}}" torna-se: tecla T
  • "{{K|Ctrl|Shift|W}}" torna-se: Ctrl+Shift ⇧+W
  • "{{K|Up}} {{K|Left}} {{K|Down}} {{K|Right}}" torna-se: ↑ ← ↓
    • Isso é bom para símbolos como as setas, em vez de escrever "seta para cima".

Uma listagem completa de teclas especiais está em: Template:K/core.

Marca registrada

Em primeira instância os artigos do Second Life devem ter o símbolo da marca registrada junto ao nome. Nossa marca registrada sempre deve ser respeitada e aqui poderá saber mais sobre o assunto.

Edições avançadas na wiki

A Wiki do Second Life continua crescendo e nós louvamos a participação dos Residentes a ajudar a evoluir os estilos. Deve estar ciente que alguns estilos são muito úteis para outras Wikis, mas elas ainda não se aplicam a nós. Várias questões sobre este assunto estão registrados em User:Torley/Code.

Por favor, não faça qualquer grande alteração de estilo sem consultar em primeiro lugar, a Equipe de Documentação. Estamos aqui para ajudar e ficaríamos feliz em dar uma olhada.

Retrieved from "https://wiki.secondlife.com/w/index.php?title=Guia_de_Estilo&oldid=1205911"