Linee guida tipografiche

Ci sono pagine a parte che spiegano la struttura della pagina e la sintassi con codici di esempio.

Importante

Aderire a queste linee guida tipografiche ti garantisce che la tua documentazione potrà essere esportata in modo facile ed accurato per scopi di traduzione. Alcune linee guida possono non essere applicabili alle altre lingue (non inglese). Questo dovrebbe essere segnalato nella pagine specifiche delle lingue collegate a Modalità di traduzione. Se non esiste una pagina di questo tipo per la tua lingua, aggiungine una e segna lì le linee guida.

Testo grassetto

Utilizza il testo grassetto per evidenziare

• titoli delle finestre,
• etichette comuni non configurabili dall'utente,
• didascalie delle icone,
• nomi dei programmi.

Per esempio:

• evidenziazione di una selezione di testo che sarà copiato in Klipper.

Testo corsivo

Utilizza testo corsivo per enfatizzare

• parole o frasi come nella normale scrittura,
• titoli quando fanno riferimento ad altri lavori,
• la prima occorrenza di una parola insolita.

Alcuni esempi:

• A questo punto salva il tuo lavoro.
• I dettagli sono disponibili in Samba 3 tramite esempi...
• I manuali KDE sono in formato Docbook.

Suggerimento

I programmi sono avviati dagli utenti, i componenti sono utilizzati dai programmi.

Testo in grassetto e corsivo combinati

Utilizza questa combinazione per testo variabile o sostituibile.

Alcuni esempi:

• per connetterti al tuo server remoto digita ssh nomeutente@dominio.nome in Konsole.
• Nelle distribuzioni basate su rpm il comando rpm -q nomepacchetto darà come risultato pacchetto-versione-rilascio.

Testo a larghezza fissa

Il codice dovrebbe essere presentato utilizzando testo a larghezza fissa, di solito in un riquadro, come mostrato sotto. Il testo inserito verrà visualizzato su uno sfondo giallo pallido. Per il testo del risultato il colore di sfondo sarà grigio.

• Per ottenere un risultato coerente utilizza i modelli sia per le righe di codice singole che multiple.

• Utilizza il modello Input così:

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

  Verrà visualizzato in questo modo:

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

• Output funziona allo stesso modo:

  {{Output|1=<nowiki>anche il risultato nel terminale 
  viene mostrato come codice, 
  ma su sfondo grigio</nowiki>}}

  che viene visualizzato

  anche il risultato nel terminale 
  viene mostrato come codice, 
  ma su sfondo grigio

Nota

Utilizza 1=<nowiki> un po' di testo </nowiki> per evitare situazioni che possono compromettere il formato di visualizzazione.

• L'inserimento di un modello Input o Output in una nuova riga compromette il formato di visualizzazione se è all'interno di elenchi. Semplicemente continua sulla stessa riga se hai bisogno di correggere questo problema.

• Puoi anche combinare le aree input/output con l'evidenziazione della sintassi GeSHi. Un'area input come questa

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

  darà come risultato

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

• Le singole parole di codice possono essere tenute nella riga utilizzando

  <code></code>

  Verrà visualizzato così.

• I percorsi e i nomi dei file dovrebbero utilizzare il modello Path in questo modo: {{Path|1=percorso/del/file}} per ottenere un risultato simile a questo percorso/del/file.

Warning

In-line code markup should be short! It looks strange - and ugly - if a string of code words is split between lines. And remember: even if it looks good in your browser, not everyone uses the same screen size! And even if your text looks good on all screen sizes translations may still suffer. It is best to use the Input template for code unless it is really short.

Note

Please avoid using shell commands or other code words as verbs. This does not translate well. Always treat code words as proper names.

Blocco di citazione

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.

Elenchi

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

Keeping things together

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

Unbalanced brackets

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

Special Tags

Key presses and menu selections

• <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.
• If you are contributing to a manual page, you should always use the markup describes above. For other pages, though, there is a template to enter menu selections: {{Menu|Top|sub|...}}. Fx, {{Menu | View | Message List | Aggregation | Standard Mailing List}} yields View → Message List → Aggregation → Standard Mailing List
• If you want to use the <menuchoice> but use → in stead of ->, you write & rarr; (without a space between '&' and r!) as in <menuchoice> View</menuchoice> & rarr; <menuchoice>Message List</menuchoice> which yields View → Message List. (Note, that the → character has to be outside of the menuchoice tags to be shown properly

Files and file paths

Traditionally, file names and paths have been marked up between <tt>...</tt> tags.

<tt>~/.kde/share</tt>

yields

~/.kde/share

There is now also a template for this, which should be preferred in new content for ordinary UserBase pages (but not for manual pages, please!):

{{Path | ~/.kde/share }}

yields

 ~/.kde/share 

The Problematic Pipe

In some situations the pipe symbol can't be used - for instance when adding parameters into a template. In any such case, please use {{!}} which will display as a pipe symbol. 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|cmd1 | cmd2}} you get instead

cmd1 

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