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.

Recordeu!

Adherint-vos a aquestes directrius tipogràfiques us assegurareu que la documentació podrà ser precisa i fàcilment exportada al propòsit de la seva traducció. Algunes pautes poden no ser aplicables per als idiomes no anglès. Aquests han de tenir en compte les pàgines específiques pel seu idioma, enllaçades des de Treball de traducció. Si no existeix tal pàgina al vostre idioma, si us plau afegiu-ne una i seguiu les directrius.

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í. Tingueu en compte que si l'etiqueta <code> està immediatament precedida per un caràcter de nova línia aquest no es mostrarà adecuadament.

```
<tt> </tt>
```
És útil per mostrar els noms de fitxer i les rutes. Això s'asemblarà a: a/ruta/cap/aquí

Atenció

En la marca del codi el text ha de ser curt! Sembla estrany -i lleig- si una cadena de paraules de codi es divideix entre diverses línies. I recordeu: Encara que es vegi bé al vostre navegador, no tothom utilitza la mateixa mida de pantalla! Encara que el text es vegi bé en totes les mides de pantalla a les traduccions pot patir. Si el codi no és gaire curt el millor és utilitzar la plantilla d'entrada «Input».

Nota

Si us plau, eviteu l'ús d'ordres de l'intèrpret d'ordres, o altres paraules de codi com verbs. Això no es tradueix bé. Tracteu sempre les paraules de codi com noms propis.

Les etiquetes «blockquote»

Les etiquetes <blockquote> i </blockquote> s'han d'utilitzar en citar altres obres o altres pàgines. Això produeix un tipus de lletra cursiva proporcional, amb una mica de farciment.

Heus aquí una mostra del que s'obté mitjançant l'ús de les etiquetes «blockquote».

Text en les capçaleres de secció

Tot i que el criteri anterior es pot complir, no utilitzeu text en negreta en les capçaleres de secció o en els enllaços.

Text en les plantilles Information, Note, Tip o Warning

El text en negreta s'ha d'evitar en el text dins d'aquestes plantilles. El text en cursiva per donar èmfasi encara es pot utilitzar useu-lo amb moderació per a un efecte màxim-.

Llistes

Podeu tenir diversos tipus de llistes en les pàgines; amb vinyetes, numerals o detallades. Trobareu els detalls en la pàgina Caixa d'eines.

Mantenir les coses en conjunt

Després d'escriure el text algunes s'afegeixen algunes marques automàticament pel sistema de traducció. Això significa que cada vegada que veu una línia en blanc, aquest començarà una nova unitat. Quan el text es presenta als traductors, en general veiem una unitat a la vegada, de manera que és important no deixar línies en blanc enmig d'alguna cosa que s'ha de tractar com una unitat. Normalment, tot el paràgraf s'ha de mantenir en una sola unitat, i sota cap circumstància una sentència haurà de restar separada entre les unitats!

Si necessiteu un salt de línia al mig d'una secció, la millor forma d'aconseguir-ho és sense trencar les unitats utilitzant <br /> al final de la línia que volen trencar (no en una línia nova). Si necessiteu més espai entre les línies afegiu <br /><br />.

Claudàtors desequilibrats

El sistema de traducció marca qualsevol unitat traduïble com incompleta si conté qualsevol tipus de claudàtor sense parell. Si necessiteu claudàtors sense parell en el text, si us plau, afegiu un claudàtor parell en una etiqueta de comentari, d'aquesta manera:

<!-- }} -->{{ Una línia 

Una altra línia.}}<!-- {{ -->

Això és valid per a tot tipus de claudàtors, fins i tot entre parèntesis normals. (Per descomptat, normalment és millor evitar les línies en blanc dins d'un marge d'unitat: Vegeu Mantenir les coses en conjunt).

Etiquetes especials

<keycap> i </keycap> denoten (teclat) els noms de les tecles, per exemple Retorn.
<keycap></keycap> també es pot utilitzar al voltant d'un conjunt de tecles que s'utilitzen a la vegada, per exemple, Ctrl + Alt + F1 per posar en marxa una terminal virtual. (Tingueu en compte que «(espai)+(espai)» s'utilitza per vincular tecles que s'han de prémer alhora).
Les seqüències d'opcions del menú utilitzarà <menuchoice> i </menuchoice> per exemple Visualitza -> Llista de missatges -> Agregació -> Llista de correu estàndard.
En general, si l'usuari ha de triar un element, encara que no estiguin en un menú, s'haurà d'utilitzar el marcat <menuchoice></menuchoiсe>.

El caràcter de canonada és problemàtic

En algunes situacions, el símbol de canonada no es pot utilitzar -per exemple quan s'afegeixen els paràmetres en una plantilla-. En aquest cas, utilitzeu {{!}} que es mostrarà com un símbol de canonada. Per exemple, si voleu mostrar una línia d'ordres que conté el caràcter de canonada utilitzeu la plantilla {{Input|...}}, la forma més senzilla de fer-ho és la següent: {{Input|1=cmd1 {{!}} cmd2}} que mostrarà

cmd1 | cmd2

Si acabeu d'escriure {{Input|cmd1 | cmd2}} en lloc de

cmd1

el problema serà, que cmd2 és vist com un segon paràmetre a la plantilla, que en aquest cas no s'utilitza.

En molts casos, també podeu incloure el text que conté el caràcter de canonada entre les etiquetes <nowiki>... </nowiki>, d'aquesta manera {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}, que també mostrarà

cmd1 | cmd2

Contingut traduïble

Tot el que es pot traduir es troba dins les etiquetes <translate> i </translate>. En la majoria dels casos les imatges han d'estar dins de la secció a traduir, ja que de vegades és necessari l'ús de versions localitzades de les imatges per explicar un punt. La regla d'or és «En cas de dubte. Inclou-la!».