Cassetta degli attrezzi

From KDE Wiki Sandbox
Revision as of 10:32, 7 June 2011 by Caig (talk | contribs) (Importing a new version from external source)
{{{4}}}
Questa pagina offre esempi di formattazione per compiti comuni
Informazione


Aggiungere una schermata introduttiva e una descrizione

Quando possibile incominciamo la pagina di primo livello di un'applicazione in questo modo. Il codice necessario è

{|class="tablecenter vertical-centered"
|[[Image:schermata.png|250px|thumb]]
|Testo descrittivo
|}

Formattare il testo

Utilizzare i titoli delle sezioni

I titoli delle sezioni fanno automaticamente parte dell'Indice, devono quindi essere strutturati. La loro posizione nella struttura ad albero è regolata dai caratteri '=' alla fine di ogni titolo. Evita di utilizzarne uno da solo perché indica il titolo di una pagina che dovrebbe essere semmai indicato tramite il titolo automatico della pagina. I titoli delle sezioni principali utilizzeranno '==qui il testo==', il livello successivo '===altro testo===' e così via.

Utilizzare il grassetto e il corsivo

Le virgolette singole sono utilizzate per specificare le parole in grassetto e in corsivo.

Utilizza '''grassetto''' per specificare il testo in grassetto e ''corsivo'' per specificare il testo corsivo.

Per arrivare ad ottenere traduzioni semplici ed accurate, segui le linee Linee guida tipografiche.

Aggiungere un frammento di codice

Abbiamo dei modelli per aiutare nella corretta visualizzazione dei frammenti di codice. Esempi d'uso nelle varie situazioni sono disponibili nella pagina Linee guida tipografiche.

Se hai problemi a visualizzare i caratteri pipe nel tuo frammento di codice, consulta la spiegazione e il marcatore in dettaglio su Linee guida tipografiche.

Aggiungere rientri

":" è utilizzato per ottenere un rientro. È stato utilizzato ripetuto più volte in alcune vecchie pagine. È una pratica deprecata che causa alcuni problemi, di conseguenza i rientri multipli verranno rimossi non appena trovati. Un singolo ":" inserisce un rientro di quattro caratteri.

Formato delle date

Le date in un formato puramente numerico causano confusione a causa delle differenti interpretazioni a seconda della zona geografica. Formatta le date così

18 Mar 2011

con il mese completo o in forma abbreviata e l'anno nel formato a 4 cifre. Il giorno può essere a singola o doppia cifra.

Elenchi puntati

* è il simbolo da utilizzare per gli elenchi puntati. ** crea un secondo livello:

* Mandorle
</span>

* Noci
** Anacardi

<span class="mw-translate-fuzzy">
* Uvetta

produce

  • Mandorle
  • Noci
    • Anacardi
  • Uvetta

Elenchi numerati

Gli elenchi numerati sono create nello stesso modo, ma utilizzando '#'.

# Setacciare
# Mescolare
## Mescolare accuratamente
# Infornare

produce

  1. Setacciare
  2. Mescolare
    1. Mescolare accuratamente
  3. Infornare

Combinare elenchi puntati e numerati

Puoi avere un sotto-elenco numerato in un elenco puntato e viceversa, come questo:

* Noci
*# Anacardi
*# Matti
* Altre cose

produce

  • Noci
    1. Anacardi
    2. Matti
  • Altre cose

mentre

# Noci
#* Anacardi
#* Matti
# Altre cose

produce

  1. Noci
    • Anacardi
    • Matti
  2. Altre cose
Nota
Gli elenchi numerati non dovrebbero mai contenere righe vuote: spezzano la sequenza e la numerazione riparte da uno. Allo stesso modo non dovrebbero mai esserci righe vuote prima di un elemento di un sotto-elenco numerato o puntato: si creano due livelli di marcature di elementi (puntati o numerati).


Nota
Ricordati che i lunghi elenchi sono un problema per i traduttori. Con elenchi puntati a singolo livello posiziona ogni punto in una sezione a sé, cioè inserisci una riga vuota tra i punti. Con elenchi puntati a due livelli, i sotto-elementi devono essere tenuti nella stessa sezione del loro punto di primo livello di riferimento; se devi utilizzare i sotto-punti, per favore fai in modo che i sotto-elenchi siano corti! Per quanto riguarda gli elenchi numerati devi tenere tutto in una sola unità. Per favore cerca di evitare gli elenchi numerati e se proprio devi utilizzarli cerca di farli brevi.


Suddivisione in punti

Le suddivisioni in punti sono create utilizzando ; e : alternativamente. Sono perfetti per descrivere brevemente un gruppo di oggetti correlati.

;Animali
: Si spostano in giro e divorano altre creature.
</span>

<span class="mw-translate-fuzzy">
;Piante
: Hanno radici e si nutrono di acqua dal terreno e di sole.

produce

Animali
Si spostano in giro e divorano altre creature.
Piante
Hanno radici e si nutrono di acqua dal terreno e di sole.
Nota
Come sempre tieni ogni elemento in una propria sezione, aiuta molto i traduttori.


Aggiungere un collegamento

Ci sono due tipi di collegamenti da conoscere: quelli interni per altre pagine di userbase e quelli a URL esterni.

Per un collegamento interno il formato [[Struttura della pagina]], nel punto in cui vuoi visualizzare il nome della pagina, funziona, ma non è l'ideale, in particolare per traduzioni in docbook e per la localizzazione. È meglio utilizzare la forma [[Special:myLanguage/PageLayout|Struttura della pagina]] perché questa permette ai traduttori di collegare correttamente le pagine anche se i nomi sono tradotti. Il risultato è che l'utente verrà portato nella pagina correttamente tradotta, se ne esiste una. Spesso avrai bisogno di includere il collegamento in una frase, in questo caso utilizza

[[Special:myLanguage/PageLayout|questa pagina]]

che visualizza

questa pagina

I collegamenti esterni sono abbastanza differenti

[http://techbase.kde.org/Schedules il nostro piano di lavoro]

visualizza

il nostro piano di lavoro che ti porta direttamente nella pagina di techbase.

Un'ultima cosa da notare: quando visualizzi in anteprima la tua pagina, tutti i collegamenti sono attivi. Questo ti offre due vantaggi: puoi controllare (passandoci sopra con il mouse) che tutti i collegamenti siano impostati correttamente e puoi utilizzare un collegamento rosso per creare una nuova pagina.

Illustrare il testo

Aggiungere una singola immagine centrata

[[Image:KMail-kde4.png|250px|center]]

Nota che puoi modificare la posizione dell'immagine, ma quella predefinita è a sinistra. La dimensione dell'immagine dipende dalle circostanze, ma per le schermate ti raccomando non meno di 250px e non più di 500px.

Fare in modo che si possa fare clic sull'immagine e aggiungere una didascalia

Quando hai bisogno di mostrare più dettagli, crea un'immagine un'immagine non troppo grande su cui si possa fare clic per visualizzare quella a dimensioni complete. Aggiungi semplicemente il parametro '|thumb' all'interno delle parentesi dell'immagine.

Anche una didascalia può essere aggiunta come parametro, ma verrà mostrata solo se è presente '|thumb'.

Utilizzare le tabelle per posizionare precisamente più immagini

{|class="tablecenter" style="border: 1px solid grey;"
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|-
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]
|}

visualizza


Nota che tutti i parametri per un'immagine sono contenuti all'interno di [[...]] e che le celle sono separate da '||'. Per iniziare una nuova riga inserisci '|-' in una riga altrimenti vuota e poi '|' all'inizio della successiva.

Aggiungere note ed avvertimenti

Quando serve inserire una nota o un avvertimento nel testo, utilizza questi modelli:

{{Info|Questa è un'informazione generale}} visualizza

Information
Questa è un'informazione generale


{{Note|Alcune informazioni importanti a questo punto}} visualizza

Note
Alcune informazioni importanti a questo punto


{{Tip|Un consiglio utile, qualcosa da ricordare}}visualizza

Tip
Un consiglio utile, qualcosa da ricordare


{{Warning|Stai attento, è una cosa pericolosa da fare}} visualizza

Warning
Stai attento, è una cosa pericolosa da fare


Quando è necessario un avvertimento particolarmente forte si può utilizzare il riquadro Remember, ma utilizzalo con parsimonia. {{Remember|1=Per cose che non devono assolutamente essere dimenticate}}

Remember
Per cose che non devono assolutamente essere dimenticate


You can also change the heading:

Remember
You can use parameter number 3 to set an individual box heading:
{{Remember|3=Don't Forget This!|1=You can use...}}


KDE3 and KDE SC 4 Versions of Applications

By default, KDE SC 4 is assumed. If the KDE SC 4 version is not yet ready for release, or where only a KDE 3 version exists, it may be necessary to document the KDE3 version. In this case you should add an icon {{KDE3}} which displays Should you be writing about a KDE3 version and KDE SC 4 version on the same page, use icons for both - {{KDE4}} which displays

Other Useful Templates

Inserting GUI Icons

The best way to refer to icons in the GUI is to display it in the text. This can be done with a template like this: {{Icon|list-add}}. This will display the icon.


The icon can also be wirtten as {{Plus}}, and the icon as {{Minus}}.

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

si tradurrà in

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

Molte persone scelgono di fare una bozza di una pagina nella propria pagina di Discussione, poi spostano il risultato nella posizione desiderata. A volta c'è una buona ragione per preferire la creazione nella posizione finale. Se è questo il caso, considera l'utilizzo di {{Construction}} prima del tuo testo, verrà mostrato così

Under Construction
This is a new page, currently under construction!


Cerca di evitare di creare una struttura di più di tre livelli di profondità. Per la maggior parte degli scopi sarà sufficiente la seguente guida:

Quando possibile iniziamo la prima pagina di un'applicazione in questo modo. Il codice necessario è

Making Major Edits to Existing Pages

Le virgolette singole sono usate per specificare le parole in grassetto e in corsivo.

* è il simbolo utilizzato per gli elenchi puntati. ** crea un secondo livello: * Un asterisco ===Aggiungi una singola immagine centrata=== {{Input|1=?UNIQ5914baee6fb2a13e|7728}} ?UNIQe0a763648bc208e|7730 visualizza {{Info|Questa è un'informazione generale}} <nowiki>{{Note|Alcune informazioni importanti in questo punto}} visualizza

Note
Alcune informazioni importanti in questo punto


{{Tip|Un utile consiglio, qualcosa da ricordare}}visualizza

Tip
Un utile consiglio, qualcosa da ricordare


{{Warning|Attenzione: questa è una cosa pericolosa da fare}} visualizza

Warning
Attenzione: questa è una cosa pericolosa da fare


Applicazioni comunitarie

Adding a List of Sub-Pages

{{Input|1=== Subpages of {{FULLPAGENAME}} == {{Special:PrefixIndex/{{FULLPAGENAME}}/}}

is very useful when you want to list subpages with active links, such as

It does, however, also list all "other-language" pages, so use with discretion.