Caixa de ferramentas

From KDE TechBase
Revision as of 20:58, 28 April 2012 by Aracele (talk | contribs)
Information
Essa página oferece exemplos de formatação de código para tarefas comuns


Formatar seu texto

Usar cabeçalhos

Cabeçalhos automaticamente fazem parte de sua Tabela de Conteúdos, então precisam ser estruturados. Seus lugares na árvore é regido por vários '=' caracteres no final do cabeçalho. Evite usar um único - que indica um cabeçalho de página e o cabeçalho de página automático deve ser usado. Seus cabeçalhos principais usarão '== texto vai aqui ==', o próximo nível, '=== mais texto ===' e assim por diante.

Usar negrito e itálico

Aspas são usadas para especificar palavras em negrito e itálico.

Use '''bold text''' para especificar texto em negrito e ''italic text'' para especificar texto em itálico.

Para que possamos garantir traduções fáceis e precisas, por favor, respeitem o guia tipográfico.

Adicionar um trecho de código

Nós temos modelos para auxiliar na correta exibição de trechos de código. Exemplos de uso em várias situações estão disponíveis na página do guia tipográfico. Código para os vários modelos de caixa podem ser encontrados nessa página.

Se você tem problemas com exibição de caracteres pipe no seu trecho de código, por favor, veja a explicação e marcação detalhada no Guia Tipográfico

Adicionar recuos

":" é usado para um recuo e foi usado em múltiplos em várias páginas antigas. Isso está obsoleto e causa alguns problemas, por isso os múltiplos serão removidos a medida que forem encontrados. Um simples ":" recua por quatro caracteres.

Formatar datas

Datas em um formato puramente numérico causam confusão, devido às diferenças nas expectativas das zonas geográficas. Por favor, formate as datas como

18 Mar 2011

com o nome completo do mês ou na forma abreviada, e o ano no formato de 4 digitos. O dia pode ser com um único digito ou com dois.

Listas com marcadores

* é o símbolo para usar em listas com marcadores. ** fornece um segundo nível:

* Almonds

* Nuts
** Cashews

* Raisins

produz

  • Almonds
  • Nuts
    • Cashews
  • Raisins

Enumerações

Enumerações são produzidas da mesma forma, usando '#'.

# Sift
# Mix
## Stir thoroughly
# Bake

produz

  1. Sift
  2. Mix
    1. Stir thoroughly
  3. Bake

Combinando listas com marcadores e enumerações

Você pode ter uma sublista enumerada em uma lista com marcadores e vice e versa, como essa:

* Nuts
*# Cashew
*# Crazy
* Other things

produz

  • Nuts
    1. Cashew
    2. Crazy
  • Other things

enquanto

# Nuts
#* Cashew
#* Crazy
# Other things

produz

  1. Nuts
    • Cashew
    • Crazy
  2. Other things
Nota
Enumerações nunca devem ter linhas em branco nelas: isso quebra a sequência e a numeração inicia em um novamente. Da mesma forma, nunca deve haver linhas em branco antes de um item de sublist se enumerador ou com marcadores: isso cria dois níveis de marcas de item (marcadores ou números)


Nota
Por favor, lembre que listas grandes são um problema para tradutores. Com listas com marcadores de nível simples, coloque cada marcador em uma seção própria, por exemplo, colocar uma linha em branco entre os marcadores. Com dois níveis de marcadores os subitens devem ser mantidos na mesma seção como seus marcadores de nível superior; se você usa submarcadores, por favor, mantenha as sublistas curtas! Com enumerações envolvidas, você deve manter tudo em uma unidade. Por favor, tente evitar enumerações e se você encontrar isso você deve usá-las tentando mantê-las curtas.


Itemizações

Itemizações são produzidas usando ; e : alternativamente. Elas são melhores para dar descrições curtas para um grupo de objetos relacionados.


;Animals
: They move around and devour other creatures.

;Plants
: They have roots and feed upon ground water and sun.

produz

Animals
They move around and devour other creatures.
Plants
They have roots and feed upon ground water and sun.
Nota
Como sempre, por favor, mantenha cada item em uma seção própria; isso ajuda muito os tradutores.


Adicionar um link

Há dois tipos de links para aprender, no plano interno, para outra página do TechBase e links externos.

Para um link interno o formato [[Typographical_Guidelines]], onde você deseja mostrar o nome da página, funciona, mas não é o ideal, particularmente para tradução de docbook e para localização. É melhor usar a forma [[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]], porque isso permite aos tradutores linkar corretamente mesmo quando o nome da página está localizado.O resultado é que direciona corretamente a página traduzida, se existir uma. Você muitas vezes vai precisar incluir o link em uma sentença, então nesse caso você usaria

[[Special:myLanguage/Typographical_Guidelines|essa página]]

que mostra

essa página

Links externos são ligeiramente diferentes assim

[http://techbase.kde.org/Schedules nosso roteiro]

mostra

nosso roteiro, que iria levá-lo direto para a página do techbase.

Uma última coisa a notar - quando você visualizar sua página, todos os links estão funcionando. Isto te dá dois benefícios. Você pode verificar (ao passar com o mouse em cima deles) que seus links estão configurados como você esperava, e você pode usar um link vermelho para criar uma nova página.

Ilustrar seu texto

Adicionar uma única imagem, centralizada

[[Image:KMail-kde4.png|250px|center]]

Note que você pode mudar a posição da imagem, mas o padrão é à esquerda. O tamanho da imagem depende das circunstâncias, mas para screenshots recomendo não menos do que 250px e não mais do que 500 pixels.

Criar imagem clicável e adicionar uma legenda

Quando você precisar mostrar mais detalhes, crie uma imagem de tamanho moderado, clicável, para que o tamanho completo possa ser visto. Basta adicionar o parâmetro '|thumb' dentro dos parênteses imagem.

Uma legenda também pode ser adicionada como um parâmetro, mas somente mostrará se '|thumb' está presente.

Use tabelas para localizar precisamente múltiplas imagens

{|class="tablecenter" style="border: 1px solid grey;"
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|-
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]
|}

mostra


Note que todos esses parâmetros para cada imagem estão dentro de [[...]] e as células são separadas por '||'. Para começar uma nova linha, insira '|-' em uma linha vazia, então '|' no começo da próxima.

Adicionar Notas e Avisos

Quando houver uma nota ou aviso relevante dentro do seu texto, use esses exemplos:

{{Info|This is general information}} displays

Information
Essa é a informação geral


{{Note|Some important information at this point}} displays

Note
Alguma informação importante nesse ponto


{{Tip|A helpful piece of advice, something to remember}}displays

Tip
Um conselho útil, alguma coisa para lembrar


{{Warning|Take care - this is a dangerous thing to do}} displays

Warning
Tomar cuidado - isso é uma coisa perigosa para fazer


Onde for necessário um aviso mais reforçado, essa caixa de lembrete pode ser usada, mas, por favor, use moderadamente. {{Remember|1=This is for things that definitely must not be forgotten}}

 
Remember
Isso é para coisas que definitivamente não devem ser esquecidas


Você também pode alterar o cabeçalho:

 
Remember
Você pode usar o parâmetro número 3 para configurar um cabçalho de caixa individual:
{{Remember|3=Não esqueça isso!|1=Você pode usar...}}


Outros modelos úteis

Inserindo ícones GUI

A melhor forma para se referir a ícones GUI é exibi-los no texto. Isso pode ser feito com um modelo como esse: {{Icon|list-add}}. Isso irá exibir o ícone .

Para que isso funcione, a imagem do ícone deve ter sido carregada na wiki. Veja Update an Image para uma explicação sobre como carregar imagens. Os arquivos .png podem geralmente ser encontrados aqui: usr/share/icons/oxygen. Se possível use o ícone 16x16. O nome do arquivo deve ter um prefixo Icon- como em Icon-list-add.png — além do prefixo o nome do arquivo deve corresponder exatamente a um nome comum. Note, que quando usar o modelo você não deve escrever nem o prefixo Icon- e nem o tipo de extensão do arquivo .png.

O ícone também pode ser escrito como {{Plus}} e o ícone como {{Minus}}. Você também pode usar {{Configure}} para obter o ícone e {{Exit}} para obter o ícone .

Fazendo grandes edições em páginas existentes

Se uma página é passível de ser editada há o perigo de conflitos - alguém mais pode editá-la ao mesmo tempo que você e se você salvar sua edição isso cancelará a dele, ou vice versa. O jeito de evitar isso é fazer um registro temporário, diretamente na barra de idioma, usando {{Being_Edited}} que mostrará

 
Currently Being Edited
This page is currently being edited.
If this notice persists for an unreasonable time, please either notify irc.freenode.org #kde-www or report on Annewilson's Talk page.


Não esqueça de removê-la quando você terminar!

Adicionando uma nova página complexa

Se você precisa trabalhar em uma página por um bom tempo, durante vários dias, por exemplo, você pode gostar de usar um modelo de contrução - {{Construction}}, que mostra

 
Under Construction
This is a new page, currently under construction!


Adicionando uma lista de subpáginas

== Subpages of {{FULLPAGENAME}} ==
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}

é muito útil quando você quer listar subpáginas com links ativos, tais como

Subpáginas de Toolbox/pt-br

Isso, no entanto, também lista todas as páginas de "outras línguas", então use com critério