Guias Tipográficos

Redirecionar para:

• userbase:Special:myLanguage/Typographical Guidelines

Warning

This page is a duplicate of https://userbase.kde.org/Typographical_Guidelines and its contents will be progressively merged to userbase. Please do no longer update here.

There is a separate pages explaining general syntax with example code.

Aderindo a esses guias tipográficos garantirá que sua documentação pode ser precisa e facilmente exportada para fins de tradução.

Texto em negrito

Use texto em negrito para destacar

• Títulos de janela
• Rótulos comuns que não são configuráveis ​​pelo usuário
• Legendas dos ícones
• Nomes de programa

Por exemplo:

• Destacando uma seleção de texto irá copiá-lo para Klipper.

Texto em Itálico

Use texto em itálico para enfatizar

• Palavras ou frases como na escrita geral.
• Títulos que fazem referência a outros trabalhos.
• O primeiro uso de uma palavra desconhecida.

Alguns exemplos:

• Salve seu trabalho neste momento.
• Os detalhes podem ser encontrados em Samba 3 by Example....
• Os manuais do KDE estão no formato Docbook.

Dica

Programas são lançados pelos usuários, componentes são usados pelos programas

Texto com negrito e itálico combinados

Use esta combinação para texto substituível ou variável.

Alguns exemplos:

• Para se conectar ao seu servidor remoto, digite ssh [email protected] no Konsole.
• Nas distribuições baseadas em rpm, o comando rpm -q packagename irá resultar em package-version-release.

Texto Monoespaçado

Código deve ser apresentado em texto monoespaçado, geralmente em caixa, como mostrado abaixo. O texto de entrada estará sobre um fundo pálido amarelo. Para o texto de saída, a cor de fundo será violeta-cinza.

• Código, se linhas simples ou blocos, use modelos para garantir consistência

• Use o modelo de Entrada como esse:

  {{Input|1=<nowiki>
  qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
  rm -r ~/.kde/share/apps/nepomuk
  rm -r ~/.kde4/share/apps/nepomuk
  nepomukserver</nowiki>}}

  Isso se mostrará assim:

  qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit
  rm -r ~/.kde/share/apps/nepomuk
  rm -r ~/.kde4/share/apps/nepomuk
  nepomukserver

• A saída funciona da mesma forma:

  {{Output|1=<nowiki> o terminal de saída 
  é também mostrado como código, 
  mas sobre um fundo cinza</nowiki>}}

  que mostra como

  o terminal de saída 
  é também mostrado como código, 
  mas sobre um fundo cinza

noframe

Note o uso de 1=<nowiki> algum texto </nowiki> para evitar situações que quebram o formato de exibição

Nota

• Iniciar um modelo de Entrada ou Saída em uma nova linha quebrará o formato de exibição se estiver dentro de listas. Apenas continue na mesma linha se você precisa corrigir isso.

• Você também pode combinar áreas de entrada/saída com GeSHi syntaxhiglighting. Uma área de entrada como essa

  {{Input|<syntaxhighlight lang="php" line>
  # Initialise common code
  $preIP = dirname( __FILE__ );
  require_once( "$preIP/includes/WebStart.php" );
  </syntaxhighlight>}}

  irá resultar em

  # Initialise common code
  $preIP = dirname( __FILE__ );
  require_once( "$preIP/includes/WebStart.php" );
  

• Palavras de código simples podem ser mantidas em linha usando

  <code></code>

  Isso irá mostrar assim.

• <tt> </tt>

  é útil para exibir nomes de arquivos e caminhos. Isto se parece com isso: a/path/to/here

Bloco de Citações

As tags <blockquote> e </blockquote> devem ser usadas quando citam outros trabalhos ou outras páginas. Isso produz uma fonte em itálico proporcional com algum preenchimento.

Aqui está um exemplo de exibição que você tem usando a tag blockquote.

Texto nos Cabeçalhos de Seção

Embora os critérios acima possam ser cumpridos, não use texto em Negrito nos cabeçalhos de seção ou nos links.

Texto nos modelos de informação, nota, dica ou aviso

O texto em negrito deve ser evitado no texto dentro desses modelos. O texto em itálico para dar ênfase ainda pode ser usado - use com moderação para efeito máximo.

Listas

Você pode ter vários tipos de listas nas suas páginas — marcadores, numeradas ou detalhadas. Encontre os detalhes na página Toolbox

Mantendo as coisas juntas

Depois que seu texto é escrito alguma marcação é adicionada automaticamente pelo sistema de tradução. Isto significa que sempre que vê uma linha em branco ele adiciona uma nova unidade. Quando seu texto é apresentado aos tradutores, eles normalmente vêem uma unidade de cada vez, por isso é importante não deixar algumas linhas em branco no meio de algo que deve ser tratado como uma unidade. Normalmente, um parágrafo inteiro deve ser mantido em uma única unidade; e sob nenhuma circunstância uma sentença deve ser dividida entre as unidades!

Se você precisar de uma quebra de linha no meio de uma seção, a melhor maneira de fazer isso sem quebra de unidade é usar <br /> no final da linha onde você deseja que a quebra ocorra (não em uma nova linha). Se você precisar de espaço entre as linhas adicione <br /><br />.

Parênteses desequilibrados

O sistema de tradução marca qualquer unidade de tradução como traduzida incompletamente se ela contiver qualquer tipo de parênteses desequilibrados. Se você precisa ter parênteses desequilibrados no seu texto, por favor, adicione um parêntese de equilibrio em uma tag de comentário, como essa:

<!-- }} -->{{ Uma linha 

Outra linha}}<!-- {{ -->

Isso vale para todos os tipos de parênteses, até mesmo parênteses comuns.(Claro que isso é normalmente melhor para evitar linhas em branco dentro de um marcador da unidade - veja Mantendo as coisas juntas.)

Tags Especiais

• <keycap> e </keycap> indicam (keyboard) nomes de teclas, por exemplo Enter
• <keycap></keycap> também pode ser usado nos grupos de teclas para ser utilizadas simultaneamente, por exemplo Ctrl + Alt + F1 para lançar um terminal virtual. (Note que "(space)+(space)" é usado para linkar teclas a serem pressionadas simultaneamente).
• Sequências de opções de menu devem usar <menuchoice> e </menuchoice> por exemplo View -> Message List -> Aggregation -> Standard Mailing List
• Em geral, se o usuário precisa escolher um elemento, mesmo se ele não está em um menu, a marcação <menuchoice></menuchoiсe> deve ser usada.

O Problemático Símbolo Pipe

Em algumas situações o símbolo pipe não pode ser usado - por exemplo ao atribuir parâmetros em um modelo - quando ele tem um significado do sistema. Em tais casos por favor use {{!}}. Por exemplo, se você deseja exibir uma linha de comando que contém o pipe caractere usando o modelo {{Input|...}}, o jeito mais simples para fazer isso é esse: {{Input|1=cmd1 {{!}} cmd2}} que mostra

cmd1 | cmd2

Se você apenas escreve {{Input|1=cmd1 | cmd2}} você tem ao invés disso

 cmd2

sendo que o problema é que cmd2 é visto como um segundo parâmetro para o modelo, que neste caso não é usado.

Em muitos casos, você pode também incluir o texto que contém o pipe caractere entre tags <nowiki>... </nowiki>, como essa {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}, que também mostra

cmd1 | cmd2

Conteúdo traduzível

Tudo o que é traduzível está contido dentro <translate> e </translate> tags. Na maioria dos casos, quaisquer imagens devem estar contidos dentro da secção traduzível, como é por vezes necessário utilizar versões localizadas das imagens para explicar um ponto. A regra de ouro é "Em caso de dúvida, inclua!".