Directrius tipogràfiques

Other languages:

Hi ha pàgines a part que ho expliquen Disposició de la pàgina i sintaxi amb codi d'exemple.

Adherint-vos a aquestes directrius tipogràfiques us assegurareu que la documentació pot ser precisa i fàcilment exportada al propòsit de la seva traducció.

Text en negreta

Utilitzeu el text en negreta per a ressaltar:

Els títols de les finestres.
Les etiquetes comunes que no són configurables per l'usuari.
Els títols de les icones.
Els noms dels programes.

Per exemple:

Ressaltar una selecció de text copiada a Klipper.

Text en cursiva

Utilitzeu el text en cursiva per a emfatitzar:

Les paraules o frases en l'escrit.
Els títols quan fan referència a altres treballs.
El primer ús d'una paraula poc familiar.

Alguns exemples:

Deseu el vostre treball en aquest moment.
Els detalls es poden trobar en Samba 3 amb l'exemple...
Els manuals del KDE estan en el format Docbook.

Consell

Els programes són llançats pels usuaris, els components son utilitzats pels programes.

Combinar text en negreta i en cursiva

Utilitzeu aquesta combinació per a text reemplaçable o variable.

Alguns exemples:

Per a connectar al servidor remot, escriviu ssh nomusuari@domini.nom en Konsole.
En distribucions basades en RPM, l'ordre rpm -q nompaquet resultarà en paquet-versió-llançament.

Text monoespai

Codi s'ha de presentar en text mono-espai, en general a una caixa, com es mostra a continuació. El text d'entrada serà sobre un fons groc clar. Pel text de sortida, el color de fons serà de color gris violeta.

Codi, si hi ha línies individuals o blocs, feu servir plantilles per tal de garantir la coherència.

Utilitzeu la plantilla d'entrada d'aquesta manera:

{{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>}}

Això es mostrarà així:

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

La sortida funciona de la mateixa manera:

{{Output|1=<nowiki>El terminal de sortida
també es mostra com a codi, 
però sobre un fons gris.</nowiki>}}

el qual es mostra com

El terminal de sortida
també es mostra com a codi, 
però sobre un fons gris.

Nota

Observeu l'ús de 1=<nowiki> algun text </nowiki> per evitar situacions que trenquen el format de visualització.

En començar una plantilla d'entrada o de sortida en una nova línia es trenca el format de visualització si es troba dins de les llistes. Només cal seguir en la mateixa línia si cal corregir-ho.

També podeu combinar àrees d'entrada/sortida amb Sintaxi de ressaltat GeSHi. Una àrea d'entrada com aquesta

{{Input|<syntaxhighlight lang="php" line>
# Codi comú inicial
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );
</syntaxhighlight>}}

donarà com a resultat

# Codi comú inicial
$preIP = dirname( __FILE__ );
require_once( "$preIP/includes/WebStart.php" );

Les paraules només de codi es poden mantenir en la línia utilitzant
```
<code></code>
```
El qual es mostrarà així.

```
<tt> </tt>
```
is useful for displaying filenames and paths. This looks like this: a/path/to/here

Block Quotes

The tags <blockquote> and </blockquote> should be used when quoting other works or other pages. This produces a proportional italic font, with some padding.

Here is an example of the display that you get by using the blockquote tags.

Text in Section Headers

Even though the criteria above may be met, do not use Bold text in section headers or in links.

Text in Information, Note, Tip or Warning Templates

Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect.

Llistes

You can have various kinds of lists in your pages — bulleted, numbered or itemized. Find details on the Toolbox page.

Mantenir les coses en conjunt

After your text is written some markup is automatically added by the translation system. This means that whenever it sees a blank line, it starts a new unit. When your text is presented to translators, they typically see it one unit at a time, so it is important not to leave a blank lines in the middle of something that should be treated as a unit. Normally an entire paragraph should be kept in a single unit; and under no circumstance should a sentence be split between units!

If you need a linebreak in the middle of a section, the preferred way to achieve this is without breaking units is to use <br /> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <br /><br />.

Claudàtors desequilibrats

The translation system marks any translated unit as incompletely translated if it contains any kind of unbalanced brackets. If you need to have unbalanced brackets in your text, please add a balancing bracket in a comment tag, like this:

<!-- }} -->{{ A line 

Another line}}<!-- {{ -->

This goes for all kinds of brackets, even ordinary parentheses. (Of course it is normally better to avoid blank lines within a mark up unit - see Keeping things together.)

Etiquetes especials

<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.

Contingut traduïble

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!".