Typographical Guidelines/pt-br

"Existe uma página separada explicando sintaxe geral com um código de exemplo."

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

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

  1 # Initialise common code
  2 $preIP = dirname( __FILE__ );
  3 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.)

Special Tags

• <keycap> and </keycap> denote (keyboard) key names e.g. Enter
• <keycap></keycap> can also be used around groups of keys to be used concurrently, e.g. Ctrl + Alt + F1 to launch a virtual terminal. (Note that "(space)+(space)" is used to link keys to be pressed concurrently).
• Sequences of menu choices should use <menuchoice> and </menuchoice> for example View -> Message List -> Aggregation -> Standard Mailing List
• In general, if the user needs to choose an element, even if it is not in a menu, the <menuchoice></menuchoiсe> markup should be used.

The Problematic Pipe Symbol

In some situations the pipe symbol cannot be used - for instance when giving parameters in a template - as it has a system meaning. In such cases please use {{!}}. For example, if you want to display a command line containing the pipe character using the {{Input|...}} template, the simplest way to do it is this: {{Input|1=cmd1 {{!}} cmd2}} which displays

cmd1 | cmd2

If you just write {{Input|1=cmd1 | cmd2}} you get instead

 cmd2

the problem being, that cmd2 is seen as a second parameter to the template, which in this case is not used.

In many cases, you can also enclose the text containing the pipe character between <nowiki>... </nowiki> tags, like this {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}, which also displays

cmd1 | cmd2

Translatable Content

Everything that is translatable is contained within <translate> and </translate> tags. In most cases any images should be contained within the translatable section, as it is sometimes necessary to use localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!".