Difference between revisions of "Help:Style (Italiano)"

From ArchWiki
Jump to: navigation, search
(Oggetto: translate)
(Testo da linea di comando: align to English version)
(35 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:ArchWiki Help (Italiano)]]
+
[[Category:Help (Italiano)]]
[[Category:ArchWiki Tools (Italiano)]]
+
[[en:Help:Style]]
{{i18n|Help:Style}}
+
[[es:Help:Style]]
{{Translateme}}
+
[[ru:Help:Style]]
 +
[[zh-CN:Help:Style]]
 
{{Article summary start}}
 
{{Article summary start}}
{{Article summary text|Questa pagina fornisce una raccolta di linee guida per la standardizzazione dello stile negli articoli di ArchWiki.}}
+
{{Article summary text|Questa pagina fornisce delle linee guida per la standardizzazione dello stile negli articoli di ArchWiki.}}
 
{{Article summary heading|Correlati}}
 
{{Article summary heading|Correlati}}
 
{{Article summary wiki|Help:Editing (Italiano)}}
 
{{Article summary wiki|Help:Editing (Italiano)}}
Line 10: Line 11:
 
{{Article summary end}}
 
{{Article summary end}}
  
Uno dei migliori modi per far sì che un'opera di documentazione sia chiara e facilmente comprensibile dai suoi utenti è l'adesione del suo contenuto ad una serie di regole di stile convenzionali. [[ArchWiki:About (Italiano)|ArchWiki]] non fa eccezione a quest'idea: non solo il testo di un articolo dev'essere coerente, il più esaustivo possibile e scritto in linguaggio formale, ma deve anche apparire ordinato ed organizzato, visivamente coerente con gli altri articoli. Tutti i collaboratori di ArchWiki sono incoraggiati a seguire queste linee guida nel modificare gli articoli.
+
Le seguenti convenzioni di stile sono volte a rendere gli articoli ordinati, ben organizzati e visivamente coerenti tra loro. Tutti i collaboratori di ArchWiki sono incoraggiati a seguirle nel modificare le pagine.
  
 
==Articoli==
 
==Articoli==
 
===Titolo===
 
===Titolo===
*Se l'argomento dell'articolo è comunemente conosciuto sia con il nome completo che con un acronimo, si preferisca usare il nome completo nel titolo dell'articolo. <br> Evitare di includere nel titolo sia il nome completo che l'acronimo (ad esempio tra parentesi): se si pensa che entrambi siano usati comunemente, si crei un redirect per l'acronimo che reindirizzi alla pagina titolata con il nome completo.
+
*Se l'argomento dell'articolo è comunemente conosciuto sia con il nome completo che con un acronimo, si preferisca usare il nome completo nel titolo dell'articolo. Evitare di includere nel titolo sia il nome completo che l'acronimo (ad esempio tra parentesi), ma piuttosto si crei un [[Help:Editing (Italiano)#Redirects|redirect]] per l'acronimo che reindirizzi alla pagina titolata con il nome completo.
 
*Si veda anche [[Article Naming Guidelines]].
 
*Si veda anche [[Article Naming Guidelines]].
  
 
===Struttura===
 
===Struttura===
*I vari elementi di un articolo devono essere inclusi nel seguente ordine:
+
*Ordinare i vari elementi di un articolo come segue:
 
#[[#Categorie|Categorie]]
 
#[[#Categorie|Categorie]]
#[[#Template i18n|Template i18n]]
+
#[[#Interlink|Interlink]]
#[[#Interlink|Interlink]] (opzionali)
+
 
#[[#Template di stato dell'articolo|Template di stato dell'articolo]] (opzionali)
 
#[[#Template di stato dell'articolo|Template di stato dell'articolo]] (opzionali)
 
#[[#Sommario|Sommario]] (opzionale)
 
#[[#Sommario|Sommario]] (opzionale)
Line 32: Line 32:
 
*Un articolo può appartenere a più di una categoria, ammesso che nessuna di esse sia contenuta, direttamente o indirettamente, in una delle altre categorie presenti.
 
*Un articolo può appartenere a più di una categoria, ammesso che nessuna di esse sia contenuta, direttamente o indirettamente, in una delle altre categorie presenti.
 
*Le categorie devono essere specificate all'inizio del codice di ogni articolo. {{Nota|Questo metodo differisce da altri progetti MediaWiki come Wikipedia, i quali includono le categorie in fondo agli articoli.}}
 
*Le categorie devono essere specificate all'inizio del codice di ogni articolo. {{Nota|Questo metodo differisce da altri progetti MediaWiki come Wikipedia, i quali includono le categorie in fondo agli articoli.}}
*Non devono esserci righe vuote tra le categorie e la barra i18n, dato che introdurrebbero dello spazio bianco all'inizio dell'articolo.
+
*Non devono esserci righe vuote tra le categorie e la prima linea di testo (o gli interlink, se presenti), dato che introdurrebbero dello spazio bianco all'inizio dell'articolo.
 
*Vedere anche [[Recategorizing Pages]].
 
*Vedere anche [[Recategorizing Pages]].
 
===Template i18n===
 
*[[Template:i18n]] deve essere incluso in ogni articolo, subito sotto alle categorie.
 
*Vedere anche [[Help:i18n]].
 
  
 
===Interlink===
 
===Interlink===
*Se l'articolo ha corrispondenza con un altro di una delle wiki esterne di Arch Linux in altre lingue, si possono includere i relativi interlink subito sotto il template i18n. <br> Notare che effettivamente appariranno nell'apposita colonna alla sinistra della pagina.
+
*Se l'articolo ha delle traduzioni nella wiki locale o in wiki di Arch Linux esterne, bisogna includere i relativi interlink subito sotto le categorie e sopra la prima linea di testo. <br> Notare che effettivamente appariranno nell'apposita colonna alla sinistra della pagina.
*Quando si aggiungono o modificano interlink, bisogna fare attenzione a ripetere tale azione per tutte le traduzioni dell'articolo accessibili nella barra i18n.
+
*Non devono esserci righe vuote tra gli interlink e la prima linea di testo, dato che introdurrebbero dello spazio bianco all'inizio dell'articolo.
*Vedere anche [[Wikipedia:it:Aiuto:Interlink|Aiuto:Interlink]].
+
*Quando si aggiungono o modificano interlink, bisogna fare attenzione a ripetere tale azione per tutte le traduzioni dell'articolo già esistenti.
 +
*Non aggiungere più di un interlink per ciascuna lingua in un articolo.
 +
*Non aggiungere interlink per la medesima lingua dell'articolo.
 +
*Gli interlink devono essere ordinati alfabeticamente secondo l'abbreviazione della lingua, non il nome locale, per cui ad esempio {{ic|<nowiki>[[fi:Title]]</nowiki>}} viene prima di {{ic|<nowiki>[[fr:Title]]</nowiki>}} nonostante "Suomi" verrebbe dopo "Français".  
 +
*Vedere anche [[Help:i18n]] e [[Wikipedia:it:Aiuto:Interlink|Aiuto:Interlink]].
  
 
===Template di stato dell'articolo===
 
===Template di stato dell'articolo===
*I [[:Category:Template#Article_status_templates|template di stato dell'articolo]] possono essere inclusi subito sotto [[Template:i18n]] e subito sopra il Sommario.
+
*I [[:Category:Template#Article_status_templates|template di stato dell'articolo]] possono essere inclusi subito sotto le categorie (o gli interlink, se presenti) e subito sopra il Sommario.
 
*I template di stato dell'articolo possono anche essere usati all'interno delle sezioni, ove appropriato.
 
*I template di stato dell'articolo possono anche essere usati all'interno delle sezioni, ove appropriato.
 +
*I template di stato dell'articolo devono essere sempre accompagnati da qualche parola di spiegazione nella pagina di discussione.
  
 
===Sommario===
 
===Sommario===
 
*Descrive la struttura e l'ambito dell'articolo.
 
*Descrive la struttura e l'ambito dell'articolo.
*Opzionalmente incluso subito sotto [[Template:i18n]] o i template di stato dell'articolo, se presenti.
+
*Opzionalmente incluso subito sotto le categorie (o gli interlink, o i template di stato dell'articolo, se presenti).
 
*Si veda anche [[Writing Article Overviews]].
 
*Si veda anche [[Writing Article Overviews]].
  
Line 63: Line 64:
 
*Evitare di saltare livelli quando si creano sottosezioni, perciò una sottosezione di un livello 2 avrà un titolo di livello 3 e così via.
 
*Evitare di saltare livelli quando si creano sottosezioni, perciò una sottosezione di un livello 2 avrà un titolo di livello 3 e così via.
 
*I titoli di sezione usano le maiuscole come le normali frasi: ''Una nuova sezione'' e non ''Una Nuova Sezione''.
 
*I titoli di sezione usano le maiuscole come le normali frasi: ''Una nuova sezione'' e non ''Una Nuova Sezione''.
*Evitare di usare link nei titoli, dato che creano una discontinuità di stile ed inoltre non sono facilmente individuabili. In genere il testo del link si può trovare anche nel contenuto della sezione, altrimenti è possibile usare semplici frasi del tipo ''Si veda anche [[My New Page]]''. <br> Per lo stesso motivo, si eviti anche di usare qualunque altro tipo di markup o markdown, inclusi i [[#Template di formattazione del codice|template di formattazione del codice]].
+
*Evitare di usare link nei titoli, dato che creano una discontinuità di stile ed inoltre non sono facilmente individuabili. In genere il testo del link si può trovare anche nel contenuto della sezione, altrimenti è possibile usare semplici frasi del tipo ''Si veda anche [[My New Page]]''. <br> Per lo stesso motivo, si eviti anche di usare qualunque altro tipo di markup (html o wiki), inclusi i [[#Template di formattazione del codice|template di formattazione del codice]].
 
*Vedere anche [[Effective Use of Headers]].
 
*Vedere anche [[Effective Use of Headers]].
  
Line 88: Line 89:
 
# Demo
 
# Demo
 
echo "Hello World"}}
 
echo "Hello World"}}
*Per corte linee di codice è anche ammesso iniziarle con uno spazio invece di usare {{ic|<nowiki>{{bc|code}}</nowiki>}} (vedere [[Help:Editing (Italiano)]]), ma si noti che il blocco di codice risultante non avrà la barra di scorrimento orizzontale nel caso in cui il codice vada oltre il limite dello schermo: tenere a mente che alcuni lettori potrebbero usare schermi più stretti del proprio, o semplicemente visualizzare il browser in una finestra non massimizzata, perciò potrebbero vedere il codice raggiungere il bordo dello schermo anche se all'autore dell'articolo non accade.
+
:Per corte linee di codice è anche ammesso iniziarle con uno spazio invece di usare {{ic|<nowiki>{{bc|code}}</nowiki>}} (vedere [[Help:Editing (Italiano)]]).
 
*Usare {{ic|<nowiki>{{hc|input|output}}</nowiki>}} quando si ha bisogno di rappresentare sia l'input che l'output della linea di comando, ad esempio:
 
*Usare {{ic|<nowiki>{{hc|input|output}}</nowiki>}} quando si ha bisogno di rappresentare sia l'input che l'output della linea di comando, ad esempio:
 
{{hc|# iwconfig|<nowiki>lo no wireless extensions.
 
{{hc|# iwconfig|<nowiki>lo no wireless extensions.
Line 107: Line 108:
 
echo "Hello World"</nowiki>}}
 
echo "Hello World"</nowiki>}}
 
*Per le linee guida riguardo a [[Template:Keypress]], leggere [[#Tasti della tastiera]].
 
*Per le linee guida riguardo a [[Template:Keypress]], leggere [[#Tasti della tastiera]].
 +
*Cosnultare anche [[Help:Template]] per maggiori informazioni e per risolvere i problemi legati ad alcuni caratteri nei template, come {{ic|1==}} o {{ic|<nowiki>|</nowiki>}}.
  
 
===Testo da linea di comando===
 
===Testo da linea di comando===
Line 113: Line 115:
 
*Preferire l'uso di {{Ic|# command}} invece di scrivere {{Ic|$ sudo command}} a meno che non sia strettamente necessario.
 
*Preferire l'uso di {{Ic|# command}} invece di scrivere {{Ic|$ sudo command}} a meno che non sia strettamente necessario.
 
*Non presupporre che l'utente usi {{ic|[[sudo (Italiano)|sudo]]}} o un'altra applicazione per ottenere i permessi di root (ad esempio {{ic|gksu}}, {{ic|kdesu}}).
 
*Non presupporre che l'utente usi {{ic|[[sudo (Italiano)|sudo]]}} o un'altra applicazione per ottenere i permessi di root (ad esempio {{ic|gksu}}, {{ic|kdesu}}).
*{{Ic|# sudo command}} è sempre un errore.
+
*{{Ic|# sudo command}} è ridondante e dev'essere evitato. L'unica eccezione si ha quando {{Ic|sudo}} è invocato con l'opzione {{Ic|-u}}: in questo caso si può usare il prompt delle altre linee nello stesso blocco di comandi, o ricadere su {{Ic|$}}.
 
*Non aggiungere commenti nella stessa cornice di un comando (ad esempio {{Ic|# pacman -S foo  #Installa il pacchetto foo}})
 
*Non aggiungere commenti nella stessa cornice di un comando (ad esempio {{Ic|# pacman -S foo  #Installa il pacchetto foo}})
 
*Evitare di scrivere linee di codice eccessivamente lunghe: usare dei metodi per spezzare le linee quando possibile.
 
*Evitare di scrivere linee di codice eccessivamente lunghe: usare dei metodi per spezzare le linee quando possibile.
Line 143: Line 145:
 
===Istruzioni per la gestione dei pacchetti===
 
===Istruzioni per la gestione dei pacchetti===
 
====Pacchetti ufficiali====
 
====Pacchetti ufficiali====
*La maniera corretta per richiedere l'installazione di un pacchetto ufficiale prevede l'uso di una frase simile alla seguente: <br> <span style="margin:0 1em;"></span>[[pacman (Italiano)|Installare]] {{Pkg|package}}, disponibile nei [[Official Repositories (Italiano)|Repository Ufficiali]]. <br> il cui testo sorgente è {{Ic|<nowiki>[[pacman (Italiano)|Installare]] {{Pkg|package}}, disponibile nei [[Official Repositories (Italiano)|Repository Ufficiali]].</nowiki>}} <br> Le istruzioni per l'installazione di una lista di pacchetti potrebbero apparire come: <br> <span style="margin:0 1em;"></span>[[pacman (Italiano)|Installare]] {{Pkg|package1}}, {{Pkg|package2}} e {{Pkg|package3}}, disponibili nei [[Official Repositories (Italiano)|Repository Ufficiali]]. <br> Ulteriori esempi di formulazioni potrebbero essere: <br> <span style="margin:0 1em;"></span>''MyApplication'' può essere [[pacman (Italiano)|installato]] con il pacchetto {{Pkg|my-appplication}}, disponibile nei [[Official Repositories (Italiano)|Repository Ufficiali]]. <br> <span style="margin:0 1em;"></span>È possibile [[pacman (Italiano)|installare]] ''MyApplication'' con il pacchetto {{Pkg|my-appplication}}, disponibile nei [[Official Repositories (Italiano)|Repository Ufficiali]]. <br> È ovviamente consentito adattare la formulazione alle specifiche necessità di ciascun articolo.
+
*Si prega di evitare di usare esempi di comandi di pacman per dare istruzioni per l'installazione di pacchetti ufficiali: questo è stato stabilito sia per semplicità (ogni utente di Arch dovrebbe conoscere l'articolo su [[pacman]] a memoria) sia per evitare errori come {{Ic|pacman -Sy package}} o eventuali discussioni senza fine come la scelta tra {{Ic|pacman -S package}} e {{Ic|pacman -Syu package}}. A maggior ragione non si deve suggerire l'uso di frontend o wrapper per pacman per installare pacchetti ufficiali. <br> Si usi invece una frase simile alla seguente: <br> <span style="margin:0 1em;"></span>[[pacman (Italiano)|Installare]] {{Pkg|package}}, disponibile nei [[Official Repositories (Italiano)|repository ufficiali]]. <br> Oppure, se il nome dell'applicazione è diverso da quello del pacchetto: <br> <span style="margin:0 1em;"></span>''MyApplication'' può essere [[pacman (Italiano)|installato]] con il pacchetto {{Pkg|my-app-pkg}}, disponibile nei [[Official Repositories (Italiano)|repository ufficiali]]. <br> Le istruzioni per l'installazione di una lista di pacchetti potrebbero apparire come: <br> <span style="margin:0 1em;"></span>[[pacman (Italiano)|Installare]] {{Pkg|package1}}, {{Pkg|package2}} e {{Pkg|package3}}, disponibili nei [[Official Repositories (Italiano)|repository ufficiali]]. <br> È ovviamente consentito adattare la formulazione alle specifiche necessità di ciascun articolo.
*Se il pacchetto è ospitato in [core], [extra] o [community], fare riferimento al nome del repository è da evitare, dato che non è infrequente che un pacchetto sia spostato in un repository differente, e questo renderebbe più difficile la manutenzione dell'articolo. Se però il pacchetto è ospitato in un repository ufficiale che non è abilitato di default (ad esempio [multilib]), è preferibile menzionarlo.
+
*I link ai pacchetti menzionati sono obbligatori e dovrebbero essere creati usando [[Template:Pkg]], ad esempio {{Ic|<nowiki>{{Pkg|package}}</nowiki>}}. <br> Gli esempi riportati sopra fanno inoltre uso di un link implicito all'articolo di [[pacman (Italiano)]] (ad esempio {{ic|<nowiki>[[pacman (Italiano)|Installare]]</nowiki> ...}}) ed uno a [[Official Repositories (Italiano)]] ({{ic|<nowiki>[[Official Repositories (Italiano)|repository ufficiali]]</nowiki>}}): il loro uso è raccomandato almeno per la prima occorrenza di una richiesta di installazione, specialmente negli articoli che hanno maggiore probabilità di essere consultati da principianti di Arch.
*Fare un esempio del comando di pacman necessario per eseguire l'installazione è un metodo deprecato, sia per semplicità (ogni utente di Arch dovrebbe conoscere l'articolo su [[pacman]] a memoria) sia per evitare errori come {{Ic|pacman -Sy package}} o eventuali discussioni senza fine come la scelta tra {{Ic|pacman -S package}} e {{Ic|pacman -Syu package}}. <br> A maggior ragione non si deve suggerire l'uso di frontend o wrapper per pacman per installare pacchetti ufficiali.
+
*Esempi di comandi di pacman sono comunque accettati ed anzi incoraggiati nella [[Beginners' Guide (Italiano)|Beginners' Guide]] e le sue sotto-pagine.
 +
*Se il pacchetto è ospitato in [core], [extra] o [community], si eviti di fare riferimento al nome del repository, facilitando così la manutenzione dato che non è infrequente che un pacchetto sia spostato in un repository differente. Se però il pacchetto è ospitato in un repository ufficiale che non è abilitato di default ([multilib], [testing] ecc.), è preferibile menzionarlo, usando una frase simile alla seguente: <br> <span style="margin:0 1em;"></span>[[pacman (Italiano)|Installare]] {{Pkg|package}}, disponibile nel repository ufficiale [[multilib|&#91;multilib&#93;]].
  
 
====Pacchetti dell'AUR====
 
====Pacchetti dell'AUR====
*La maniera corretta per richiedere l'installazione di un pacchetto dell'AUR prevede l'uso di una frase simile alla seguente: <br> <span style="margin:0 1em;"></span> Installare {{AUR|package}}, disponibile nell'[[Arch User Repository (Italiano)|Arch User Repository]]. <br> il cui testo sorgente è {{Ic|<nowiki>Installare {{AUR|package}}, disponibile nell'[[Arch User Repository (Italiano)|Arch User Repository]].</nowiki>}} <br> È ovviamente consentito adattare la formulazione alle specifiche necessità di ciascun articolo, sebbene sia sempre necessario specificare che il pacchetto non è ufficiale.
+
*Per richiedere l'installazione di un pacchetto dell'AUR usare una frase simile alla seguente: <br> <span style="margin:0 1em;"></span> Installare {{AUR|package}}, disponibile nell'[[Arch User Repository (Italiano)|Arch User Repository]]. <br> Il codice wiki corrispondente è {{Ic|<nowiki>Installare {{AUR|package}}, disponibile nell'[[Arch User Repository (Italiano)|Arch User Repository]].</nowiki>}} <br> È ovviamente consentito adattare la formulazione alle specifiche necessità di ciascun articolo, sebbene sia sempre necessario specificare che il pacchetto non è ufficiale.
 
*Non fare esempi di come installare pacchetti dell'AUR, né con il metodo ufficiale né menzionando l'uso di un AUR helper: ogni utente che installa pacchetti non ufficiali deve aver letto l'articolo [[Arch User Repository (Italiano)]] ed essere cosciente di tutte le possibili conseguenze sul proprio sistema.
 
*Non fare esempi di come installare pacchetti dell'AUR, né con il metodo ufficiale né menzionando l'uso di un AUR helper: ogni utente che installa pacchetti non ufficiali deve aver letto l'articolo [[Arch User Repository (Italiano)]] ed essere cosciente di tutte le possibili conseguenze sul proprio sistema.
  
Line 154: Line 157:
 
*Fornire esempi su come aggiungere moduli all'array {{Ic|MODULES}} in {{ic|/etc/rc.conf}} è una pratica deprecata: la formulazione standard prevede una semplice lista dei moduli da aggiungere, eventualmente facendo notare dipendenze o conflitti con altri moduli, ed un link a [[Kernel modules (Italiano)]].
 
*Fornire esempi su come aggiungere moduli all'array {{Ic|MODULES}} in {{ic|/etc/rc.conf}} è una pratica deprecata: la formulazione standard prevede una semplice lista dei moduli da aggiungere, eventualmente facendo notare dipendenze o conflitti con altri moduli, ed un link a [[Kernel modules (Italiano)]].
 
*Fornire esempi su come caricare, rimuovere, mettere in blacklist o eseguire una qualunque altra operazione di base con i moduli è una pratica deprecata: la formulazione standard prevede una descrizione delle azioni che devono essere eseguite e un link a [[Kernel modules (Italiano)]].
 
*Fornire esempi su come caricare, rimuovere, mettere in blacklist o eseguire una qualunque altra operazione di base con i moduli è una pratica deprecata: la formulazione standard prevede una descrizione delle azioni che devono essere eseguite e un link a [[Kernel modules (Italiano)]].
 +
*La [[Beginners' Guide (Italiano)|Beginners' Guide]] e le sue sotto-pagine sono le uniche eccezioni alle regole di cui sopra.
  
 
===Operazioni con i demoni===
 
===Operazioni con i demoni===
 
*Fornire esempi su come aggiungere demoni all'array {{Ic|DAEMONS}} in {{ic|/etc/rc.conf}} è una pratica deprecata: la formulazione standard prevede una semplice lista dei demoni da aggiungere, eventualmente facendo notare dipendenze o conflitti con altri demoni, ed un link a [[Daemon (Italiano)]].
 
*Fornire esempi su come aggiungere demoni all'array {{Ic|DAEMONS}} in {{ic|/etc/rc.conf}} è una pratica deprecata: la formulazione standard prevede una semplice lista dei demoni da aggiungere, eventualmente facendo notare dipendenze o conflitti con altri demoni, ed un link a [[Daemon (Italiano)]].
 
*Fornire esempi su come avviare (''start''), riavviare (''restart'') o stoppare (''stop'') demoni è una pratica deprecata: la formulazione standard prevede una descrizione delle azioni che devono essere eseguite e un link a [[Daemon (Italiano)]]. <br> Ciononostante, se l'azione richiesta non è una di esse, fornire un esempio è accettabile, e si dovrebbe far uso del comando {{ic|rc.d}} invece di usare l'intero percorso {{ic|/etc/rc.d/demone}}.
 
*Fornire esempi su come avviare (''start''), riavviare (''restart'') o stoppare (''stop'') demoni è una pratica deprecata: la formulazione standard prevede una descrizione delle azioni che devono essere eseguite e un link a [[Daemon (Italiano)]]. <br> Ciononostante, se l'azione richiesta non è una di esse, fornire un esempio è accettabile, e si dovrebbe far uso del comando {{ic|rc.d}} invece di usare l'intero percorso {{ic|/etc/rc.d/demone}}.
 +
*La [[Beginners' Guide (Italiano)|Beginners' Guide]] e le sue sotto-pagine sono le uniche eccezioni alle regole di cui sopra.
  
 
===Template Nota, Attenzione, Suggerimento===
 
===Template Nota, Attenzione, Suggerimento===
Line 179: Line 184:
 
*Prima di scrivere una procedura specifica in un articolo, o descrivere qualcosa in particolare, controllare sempre che non esista già una pagina che tratta quella parte in dettaglio: in quel caso, creare un collegamento a quell'articolo invece di duplicare il suo contenuto.
 
*Prima di scrivere una procedura specifica in un articolo, o descrivere qualcosa in particolare, controllare sempre che non esista già una pagina che tratta quella parte in dettaglio: in quel caso, creare un collegamento a quell'articolo invece di duplicare il suo contenuto.
 
*Se la documentazione ufficiale per l'argomento del proprio articolo è ben scritta e aggiornata, preferire scrivere solamente adattamenti specifici per Arch, e linkare alla documentazione ufficiale per le informazioni generiche.
 
*Se la documentazione ufficiale per l'argomento del proprio articolo è ben scritta e aggiornata, preferire scrivere solamente adattamenti specifici per Arch, e linkare alla documentazione ufficiale per le informazioni generiche.
 +
*Non usare link interwiki per collegamenti alle pagine locali nella stessa lingua dell'articolo editato, infatti non sarebbero mostrati nelle pagine [[Special:WhatLinksHere]]. Ad esempio usare {{ic|<nowiki>[[:it:Main Page]]</nowiki>}} in un articolo in Italiano è sbagliato, mentre {{ic|<nowiki>[[Main Page (Italiano)]]</nowiki>}} è corretto. <br> Usare questo tipo di link tra lingue differenti è invece accettabile, dato che renderebbe più facile spostare gli articoli su una wiki esterna nel caso questa sia creata. <br> Infine, notare la differenza di questo tipo di link con gli [[#Interlink]], i quali non hanno i {{ic|:}} all'inizio.
  
 
===Sezioni "Trucchi e consigli"===
 
===Sezioni "Trucchi e consigli"===
Line 204: Line 210:
 
===Contenuti non ammessi===
 
===Contenuti non ammessi===
 
*Si prega di non aggiungere la propria firma agli articoli, né di ringraziare o citare gli autori di un articolo: l'ArchWiki è un'opera di tutta la comunità, e la cronologia di ogni articolo è sufficiente per riconoscere i meriti di coloro che vi hanno contribuito. <br> Ciononostante, è buona norma riportare le fonti usate per scrivere un articolo: a questo scopo è possibile usare la sezione "Altre risorse".
 
*Si prega di non aggiungere la propria firma agli articoli, né di ringraziare o citare gli autori di un articolo: l'ArchWiki è un'opera di tutta la comunità, e la cronologia di ogni articolo è sufficiente per riconoscere i meriti di coloro che vi hanno contribuito. <br> Ciononostante, è buona norma riportare le fonti usate per scrivere un articolo: a questo scopo è possibile usare la sezione "Altre risorse".
*Il caricamento dei file è disabilitato per gli utenti normali, e non è ammesso includere negli articoli le immagini esistenti. In alternativa è possibile includere collegamenti a immagini o gallery esterne, e se c'è bisogno di disegnare semplici schemi è possibile usare un editor ASCII come [http://www.asciiflow.com/ Asciiflow].
+
*Il caricamento dei file è disabilitato per gli utenti normali, e non è ammesso includere negli articoli le immagini esistenti. In alternativa è possibile includere collegamenti a immagini o gallery esterne, e se c'è bisogno di disegnare semplici schemi è possibile usare un editor ASCII come [http://www.asciiflow.com/ Asciiflow]. Giustificazione:
 +
**Manutenzione: Arch è rolling release, e le immagini renderebbero molto più complicato l'aggiornamento degli articoli.
 +
**Necessità: Arch non sviluppa né mantiene alcuna applicazione con interfaccia grafica, per cui non è necessario mostrare alcuno screenshot.
 +
**Moderazione: il caricamento libero di immagini richiederebbe di spendere del tempo per rimuovere immagini sovradimensionate o inappropriate.
 +
**Accessibilità: supporto per connessioni lente, browser testuali, screen reader e simili.
 +
**Efficienza: le immagini sprecano banda della connessione dei server e spazio su disco.
 +
**Semplicità: gli articoli senza immagini appaiono più semplici e ordinati.
  
 
===Registro linguistico===
 
===Registro linguistico===
*Gli articoli devono essere scritti mantenendo un linguaggio formale.
+
*Gli articoli devono essere scritti mantenendo un linguaggio formale, professionale e conciso.
 +
*Ricordarsi di non dare risposta solo al ''come'', ma anche al ''perché''. Le spiegazioni devono sempre cercare di insegnare qualcosa invece di fornire solamente istruzioni.
 
*Evitare di rivolgersi al lettore in seconda persona ("installa/installate questo programma", "apri/aprite il tuo/vostro file manager" etc.). In alternativa è consigliato usare forme infinite ("installare questo programma", "aprire il proprio file manager"), impersonali ("si installi questo programma", "si apra il proprio file manager") o passive ("dev'essere installato questo programma", "dev'essere aperto il proprio file manager").
 
*Evitare di rivolgersi al lettore in seconda persona ("installa/installate questo programma", "apri/aprite il tuo/vostro file manager" etc.). In alternativa è consigliato usare forme infinite ("installare questo programma", "aprire il proprio file manager"), impersonali ("si installi questo programma", "si apra il proprio file manager") o passive ("dev'essere installato questo programma", "dev'essere aperto il proprio file manager").
 
*Evitare [[Wikipedia:it:Abbreviazione|abbreviazioni]] non necessarie: ad esempio invece di "repo," "distro," e "config," preferire "repository," "distribuzione," e "configurazione."
 
*Evitare [[Wikipedia:it:Abbreviazione|abbreviazioni]] non necessarie: ad esempio invece di "repo," "distro," e "config," preferire "repository," "distribuzione," e "configurazione."
*Non includere commenti personali negli articoli; usare le pagine di discussione per tale scopo. In generale, non scrivere in prima persona.
+
*Scrivere obiettivamente: non includere commenti personali negli articoli, usare le pagine di discussione per tale scopo. In generale, non scrivere in prima persona.
 
{{Suggerimento|Gli utenti impegnati nella traduzione di articoli in Italiano potrebbero essere interessati a leggere anche [[ArchWiki Translation Team (Italiano)#Linee Guida]].}}
 
{{Suggerimento|Gli utenti impegnati nella traduzione di articoli in Italiano potrebbero essere interessati a leggere anche [[ArchWiki Translation Team (Italiano)#Linee Guida]].}}
  
Line 216: Line 229:
 
*Aggiungere le nuove discussioni in fondo alle pagine di discussione, con un titolo di sezione appropriato. A questo scopo è anche possibile usare la targhetta {{ic|+}} sul bordo superiore di ogni pagina di discussione.
 
*Aggiungere le nuove discussioni in fondo alle pagine di discussione, con un titolo di sezione appropriato. A questo scopo è anche possibile usare la targhetta {{ic|+}} sul bordo superiore di ogni pagina di discussione.
 
*Indentare le proprie risposte utilizzando sequenze di {{ic|:}} all'inizio di ogni linea di testo.
 
*Indentare le proprie risposte utilizzando sequenze di {{ic|:}} all'inizio di ogni linea di testo.
 +
*Non editare i propri post se qualcuno ha già replicato, altrimenti si farà perdere il filo della discussione rendendo più difficile per gli altri dare ulteriori risposte. È solamente consentito marcare con una linea parole o frasi (usando i tag {{Ic|<nowiki><s></nowiki>}}), ma la relativa spiegazione dev'essere fornita con un normale post.
 
*Terminare sempre i propri interventi con la firma dell'utente ({{ic|<nowiki>~~~~</nowiki>}}).
 
*Terminare sempre i propri interventi con la firma dell'utente ({{ic|<nowiki>~~~~</nowiki>}}).
 
*Le pagine di discussione non possono essere categorizzate.
 
*Le pagine di discussione non possono essere categorizzate.
Line 222: Line 236:
  
 
==Pagine delle categorie==
 
==Pagine delle categorie==
*Ogni categoria dev'essere a sua volta categorizzata sotto almeno una categoria-madre, escluse le categorie di base. <br> Le categorie di base sono le categorie delle lingue, come [[:Category:Italiano]], e qualche altra categoria speciale: [[:Category:DeveloperWiki]], [[:Category:Sandbox]] e [[:Category:Template]].
+
*Ogni categoria dev'essere a sua volta adeguatamente categorizzata sotto almeno una categoria-madre, escluse le categorie di base. <br> Le categorie di base sono [[:Category:DeveloperWiki]], [[:Category:Languages]], [[:Category:Sandbox]] e [[:Category:Template]].
 
*Una categoria può essere categorizzata sotto più di una categoria-madre, ammesso che nessuna di queste sia a sua volta categoria-madre (o in generale "antenato") di una delle altre.
 
*Una categoria può essere categorizzata sotto più di una categoria-madre, ammesso che nessuna di queste sia a sua volta categoria-madre (o in generale "antenato") di una delle altre.
 
*Evitare relazioni circolari: due categorie non possono essere "antenati" reciproci.
 
*Evitare relazioni circolari: due categorie non possono essere "antenati" reciproci.
 +
*Non categorizzare una categoria sotto sé stessa (categoria auto-categorizzata).
 
*Le categorie devono essere incluse in cima al testo sorgente di ogni pagina di categoria.
 
*Le categorie devono essere incluse in cima al testo sorgente di ogni pagina di categoria.
 
*Le categorie non possono fare redirezioni.
 
*Le categorie non possono fare redirezioni.
Line 230: Line 245:
 
==Pagine di redirezione==
 
==Pagine di redirezione==
 
*Le pagine di redirezione devono contenere solamente il codice per la redirezione, niente di più.
 
*Le pagine di redirezione devono contenere solamente il codice per la redirezione, niente di più.
 +
*Redirigere solamente agli articoli interni; non usare redirezioni con link interwiki.
  
 
==Pagine dei template==
 
==Pagine dei template==
*Leggere [[Template:Template]].
+
*Leggere [[Help:Template]].
  
 
==Pagine degli utenti==
 
==Pagine degli utenti==
*Le pagine degli utenti non possono essere categorizzate (questa regola può essere violata in rari casi approvati dagli amministratori).
+
*Le pagine degli utenti non possono essere categorizzate.
  
 
==Regole generali==
 
==Regole generali==
 
===Oggetto===
 
===Oggetto===
*Le modifiche fatte ogni giorno agli articoli sono coraggiosamente controllate da pochi appassionati volontari, che è necessario aiutare ricordandosi di riempire sempre il campo dell'"Oggetto" con una spiegazione per ogni edit.
+
*Le modifiche fatte ogni giorno agli articoli sono coraggiosamente controllate da pochi appassionati [[ArchWiki:Maintenance Team|volontari]], che è necessario aiutare ricordandosi di riempire sempre il campo dell'"Oggetto" con una spiegazione per ogni edit.
 
**Se la modifica è [[Wikipedia:it:Aiuto:Modifica minore|minore]], ad esempio correzioni ortografiche o grammaticali o la semplice riformulazione di una frase, una breve descrizione della propria modifica è perfettamente sufficiente.
 
**Se la modifica è [[Wikipedia:it:Aiuto:Modifica minore|minore]], ad esempio correzioni ortografiche o grammaticali o la semplice riformulazione di una frase, una breve descrizione della propria modifica è perfettamente sufficiente.
 
**Se si sta effettuando una modifica rilevante, ad esempio l'aggiunta, spostamento, modifica o rimozione di contenuti, oltre a fare un riassunto della modifica è necessario spiegare il ''motivo'' per cui è stata fatta, magari fornendo un link alla relativa discussione sulla wiki o ad un thread sul forum, se esistente.
 
**Se si sta effettuando una modifica rilevante, ad esempio l'aggiunta, spostamento, modifica o rimozione di contenuti, oltre a fare un riassunto della modifica è necessario spiegare il ''motivo'' per cui è stata fatta, magari fornendo un link alla relativa discussione sulla wiki o ad un thread sul forum, se esistente.
 
**Non è necessario fornire spiegazioni per le modifiche alle pagine di discussione, infatti il ''motivo'' dovrebbe essere comunque evidente. <br> Quando però si rimuovono discussioni che erano già state chiuse, una piccola giustificazione è richiesta (ad esempio "discussione chiusa", "risolto" ecc.) ed includere anche il titolo della discussione medesima potrebbe aiutare a ritrovarla nella cronologia nel caso ci sia bisogno di riaprirla in futuro.
 
**Non è necessario fornire spiegazioni per le modifiche alle pagine di discussione, infatti il ''motivo'' dovrebbe essere comunque evidente. <br> Quando però si rimuovono discussioni che erano già state chiuse, una piccola giustificazione è richiesta (ad esempio "discussione chiusa", "risolto" ecc.) ed includere anche il titolo della discussione medesima potrebbe aiutare a ritrovarla nella cronologia nel caso ci sia bisogno di riaprirla in futuro.
:{{Tip|Take a look at the edit summaries in the [[Special:RecentChanges|Recent Changes]] to get an idea of what you should write in your summary, but be warned that unfortunately not all users respect these guidelines.}}
+
:{{Suggerimento|Dare un'occhiata agli oggetti nelle [[Special:RecentChanges|Ultime modifiche]] per farsi un'idea di cosa scrivere nell'oggetto della propria modifica, pur tenendo conto del fatto che purtroppo non tutti gli utenti rispettano queste linee guida.}}
*When performing major changes to articles, you should better try to split your work in multiple edits, based on the logical steps needed to complete the change.
+
*Nell'effettuare modifiche rilevanti ad uno o più articoli, è bene cercare di dividere il proprio lavoro in più modifiche separate, basandosi sui vari passi logici necessari per completare l'operazione. <br> Specialmente quando si spostano intere sezioni (sia nello stesso articolo che tra articoli differenti), è bene evitare di modificarne il contenuto nel medesimo edit, altrimenti si renderà più difficile controllarne il conseguente diff.
  
===HTML tags===
+
===Tag HTML===
*Usage of HTML tags is generally discouraged: always prefer using wiki markdown or templates when possible, see [[Help:Editing]] and related.
+
*L'uso di tag HTML è generalmente da evitare: meglio preferire l'uso del markup della wiki o i template quando possibile: a tal proposito leggere [[Help:Editing (Italiano)]] e gli articoli correlati.
*When tempted to use {{ic|<nowiki><pre>code</pre></nowiki>}}, always resort to {{ic|<nowiki>{{bc|code}}</nowiki>}}. When tempted to use {{ic|<nowiki><tt>text</tt></nowiki>}} or {{ic|<nowiki><code>text</code></nowiki>}}, always resort to {{ic|<nowiki>{{ic|text}}</nowiki>}}.
+
*Quando si è tentati di usare {{ic|<nowiki><pre>codice</pre></nowiki>}}, usare sempre {{ic|<nowiki>{{bc|codice}}</nowiki>}} al suo posto. Invece di usare {{ic|<nowiki><tt>codice</tt></nowiki>}} o {{ic|<nowiki><code>codice</code></nowiki>}}, usare sempre {{ic|<nowiki>{{ic|codice}}</nowiki>}}.
*Especially avoid HTML comments ({{ic|<nowiki><!-- comment --></nowiki>}}): it is likely that a note added in a HTML comment can be explicitly shown in the article's discussion page. <br> You can add an appropriate [[:Category:Template#Article_status_templates|Article status template]] in place of the comment.
+
*Evitare in particolare i commenti HTML ({{ic|<nowiki><!-- commento --></nowiki>}}): è molto probabile che una nota aggiunta in un commento HTML possa essere mostrata esplicitamente nella pagina di discussione dell'articolo. <br> Valutare se aggiungere un [[:Category:Template#Article_status_templates|template di stato dell'articolo]] appropriato al posto del commento.
*Use {{ic|<nowiki><br></nowiki>}} only when necessary: to start a new paragraph or break a line, put a blank line below it. <br> Common exceptions to this rule are when it is necessary to break a line in a list item and you cannot use a sub-item, or inside a template and you cannot use a list.
+
*Usare {{ic|<nowiki><br></nowiki>}} solo quando necessario: per cominciare un nuovo paragrafo o spezzare una linea basta inserire una linea vuota subito sotto. <br> Le più comuni eccezioni a questa regola si hanno quando è necessario spezzare una linea in una voce di una lista, e non è possibile usare una sotto-voce, oppure dentro un template, e non è possibile usare una lista.

Revision as of 12:52, 13 November 2012

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary end

Le seguenti convenzioni di stile sono volte a rendere gli articoli ordinati, ben organizzati e visivamente coerenti tra loro. Tutti i collaboratori di ArchWiki sono incoraggiati a seguirle nel modificare le pagine.

Articoli

Titolo

  • Se l'argomento dell'articolo è comunemente conosciuto sia con il nome completo che con un acronimo, si preferisca usare il nome completo nel titolo dell'articolo. Evitare di includere nel titolo sia il nome completo che l'acronimo (ad esempio tra parentesi), ma piuttosto si crei un redirect per l'acronimo che reindirizzi alla pagina titolata con il nome completo.
  • Si veda anche Article Naming Guidelines.

Struttura

  • Ordinare i vari elementi di un articolo come segue:
  1. Categorie
  2. Interlink
  3. Template di stato dell'articolo (opzionali)
  4. Sommario (opzionale)
  5. Prefazione o introduzione
  6. Tabella dei contenuti (automatica)
  7. Sezioni specifiche dell'articolo

Categorie

  • Ogni articolo dev'essere categorizzato in almeno una categoria tra quelle esistenti.
  • Un articolo può appartenere a più di una categoria, ammesso che nessuna di esse sia contenuta, direttamente o indirettamente, in una delle altre categorie presenti.
  • Le categorie devono essere specificate all'inizio del codice di ogni articolo.
    Nota: Questo metodo differisce da altri progetti MediaWiki come Wikipedia, i quali includono le categorie in fondo agli articoli.
  • Non devono esserci righe vuote tra le categorie e la prima linea di testo (o gli interlink, se presenti), dato che introdurrebbero dello spazio bianco all'inizio dell'articolo.
  • Vedere anche Recategorizing Pages.

Interlink

  • Se l'articolo ha delle traduzioni nella wiki locale o in wiki di Arch Linux esterne, bisogna includere i relativi interlink subito sotto le categorie e sopra la prima linea di testo.
    Notare che effettivamente appariranno nell'apposita colonna alla sinistra della pagina.
  • Non devono esserci righe vuote tra gli interlink e la prima linea di testo, dato che introdurrebbero dello spazio bianco all'inizio dell'articolo.
  • Quando si aggiungono o modificano interlink, bisogna fare attenzione a ripetere tale azione per tutte le traduzioni dell'articolo già esistenti.
  • Non aggiungere più di un interlink per ciascuna lingua in un articolo.
  • Non aggiungere interlink per la medesima lingua dell'articolo.
  • Gli interlink devono essere ordinati alfabeticamente secondo l'abbreviazione della lingua, non il nome locale, per cui ad esempio [[fi:Title]] viene prima di [[fr:Title]] nonostante "Suomi" verrebbe dopo "Français".
  • Vedere anche Help:i18n e Aiuto:Interlink.

Template di stato dell'articolo

  • I template di stato dell'articolo possono essere inclusi subito sotto le categorie (o gli interlink, se presenti) e subito sopra il Sommario.
  • I template di stato dell'articolo possono anche essere usati all'interno delle sezioni, ove appropriato.
  • I template di stato dell'articolo devono essere sempre accompagnati da qualche parola di spiegazione nella pagina di discussione.

Sommario

  • Descrive la struttura e l'ambito dell'articolo.
  • Opzionalmente incluso subito sotto le categorie (o gli interlink, o i template di stato dell'articolo, se presenti).
  • Si veda anche Writing Article Overviews.

Prefazione o introduzione

  • Descrive l'argomento dell'articolo.
    Piuttosto che parafrasare o scrivere la propria (magari troppo soggettiva) descrizione di un particolare software, si può usare la descrizione dell'autore originale, che di solito può essere trovata sulla pagina home o about del sito ufficiale del progetto, se esistente. Un esempio è MediaTomb.
  • Inclusa subito sotto il Sommario.
  • Non creare esplicitamente una sezione ==Introduzione== o ==Prefazione==: lasciare invece che appaia sopra il primo titolo di sezione. Quando c'è un numero sufficiente di sezioni nell'articolo, tra la prefazione e la prima sezione viene mostrata automaticamente la tabella dei contenuti.
  • Vedere anche Writing Article Introductions.

Titoli di sezione

  • I livelli dei titoli di sezione devono cominciare dal secondo (==), infatti il primo livello è riservato per i titoli degli articoli.
  • Evitare di saltare livelli quando si creano sottosezioni, perciò una sottosezione di un livello 2 avrà un titolo di livello 3 e così via.
  • I titoli di sezione usano le maiuscole come le normali frasi: Una nuova sezione e non Una Nuova Sezione.
  • Evitare di usare link nei titoli, dato che creano una discontinuità di stile ed inoltre non sono facilmente individuabili. In genere il testo del link si può trovare anche nel contenuto della sezione, altrimenti è possibile usare semplici frasi del tipo Si veda anche My New Page.
    Per lo stesso motivo, si eviti anche di usare qualunque altro tipo di markup (html o wiki), inclusi i template di formattazione del codice.
  • Vedere anche Effective Use of Headers.

Linee vuote

  • Evitare di inserire più linee vuote consecutive per aumentare lo spazio bianco tra paragrafi o sezioni.
  • Si veda Help:Editing#Line breaks per maggiori informazioni.

Template di formattazione del codice

  • Usare {{ic|codice}} per rappresentare, nelle righe del testo, corte linee di codice, nomi di file, nomi di comandi, nomi di variabili e simili, ad esempio:
    pippo codice pluto.
  • Usare {{bc|codice}} per rappresentare in un blocco separato singole o multiple linee di codice (input o output della linea di comando e contenuto dei file), ad esempio:
# iwconfig
lo no wireless extensions.
eth0 no wireless extensions.
wlan0    unassociated  ESSID:""
         Mode:Managed  Channel=0  Access Point: Not-Associated
         Bit Rate:0 kb/s   Tx-Power=20 dBm   Sensitivity=8/0
         Retry limit:7   RTS thr:off   Fragment thr:off
         Power Management:off
         Link Quality:0  Signal level:0  Noise level:0
         Rx invalid nwid:0  Rx invalid crypt:0  Rx invalid frag:0
         Tx excessive retries:0  Invalid misc:0   Missed beacon:0
#!/bin/sh

# Demo
echo "Hello World"
Per corte linee di codice è anche ammesso iniziarle con uno spazio invece di usare {{bc|code}} (vedere Help:Editing (Italiano)).
  • Usare {{hc|input|output}} quando si ha bisogno di rappresentare sia l'input che l'output della linea di comando, ad esempio:
# iwconfig
lo no wireless extensions.
eth0 no wireless extensions.
wlan0    unassociated  ESSID:""
         Mode:Managed  Channel=0  Access Point: Not-Associated
         Bit Rate:0 kb/s   Tx-Power=20 dBm   Sensitivity=8/0
         Retry limit:7   RTS thr:off   Fragment thr:off
         Power Management:off
         Link Quality:0  Signal level:0  Noise level:0
         Rx invalid nwid:0  Rx invalid crypt:0  Rx invalid frag:0
         Tx excessive retries:0  Invalid misc:0   Missed beacon:0
  • Quando si ha bisogno di rappresentare il contenuto di un file e si teme che possa essere difficile per i lettori capire a quale file si riferisca tale codice, è anche possibile usare {{hc|nomefile|contenuto}} per mostrare il nome del file nell'intestazione, ad esempio:
~/hello_world.sh
#!/bin/sh

# Demo
echo "Hello World"

Testo da linea di comando

  • Usare $ come prompt per comandi da utente normale; usare # come prompt per comandi da root.
    Nota: Dato che # è usato anche per indicare i commenti nei file di testo, bisognerebbe sempre cercare di evitare equivoci, magari scrivendo esplicitamente di eseguire il comando o editare un file di testo.
  • La frase introduttiva per un comando dovrebbe in genere terminare con i :.
  • Preferire l'uso di # command invece di scrivere $ sudo command a meno che non sia strettamente necessario.
  • Non presupporre che l'utente usi sudo o un'altra applicazione per ottenere i permessi di root (ad esempio gksu, kdesu).
  • # sudo command è ridondante e dev'essere evitato. L'unica eccezione si ha quando sudo è invocato con l'opzione -u: in questo caso si può usare il prompt delle altre linee nello stesso blocco di comandi, o ricadere su $.
  • Non aggiungere commenti nella stessa cornice di un comando (ad esempio # pacman -S foo #Installa il pacchetto foo)
  • Evitare di scrivere linee di codice eccessivamente lunghe: usare dei metodi per spezzare le linee quando possibile.

Richieste di modifica di file

  • Non presupporre l'uso di specifici editor di testo (nano, vim, emacs, ...) nel richiedere modifiche a file di testo, a parte quando necessario.
  • Non usare comandi impliciti per richiedere modifiche a file di testo, a meno che sia strettamente necessario. Ad esempio al posto di $ echo -e "clear\nreset" >> ~/.bash_logout sarebbe meglio scrivere:
Aggiungere le seguenti linee a ~/.bash_logout:
clear
reset

Tasti della tastiera

Istruzioni per la gestione dei pacchetti

Pacchetti ufficiali

  • Si prega di evitare di usare esempi di comandi di pacman per dare istruzioni per l'installazione di pacchetti ufficiali: questo è stato stabilito sia per semplicità (ogni utente di Arch dovrebbe conoscere l'articolo su pacman a memoria) sia per evitare errori come pacman -Sy package o eventuali discussioni senza fine come la scelta tra pacman -S package e pacman -Syu package. A maggior ragione non si deve suggerire l'uso di frontend o wrapper per pacman per installare pacchetti ufficiali.
    Si usi invece una frase simile alla seguente:
    Installare package, disponibile nei repository ufficiali.
    Oppure, se il nome dell'applicazione è diverso da quello del pacchetto:
    MyApplication può essere installato con il pacchetto my-app-pkg, disponibile nei repository ufficiali.
    Le istruzioni per l'installazione di una lista di pacchetti potrebbero apparire come:
    Installare package1, package2 e package3, disponibili nei repository ufficiali.
    È ovviamente consentito adattare la formulazione alle specifiche necessità di ciascun articolo.
  • I link ai pacchetti menzionati sono obbligatori e dovrebbero essere creati usando Template:Pkg, ad esempio {{Pkg|package}}.
    Gli esempi riportati sopra fanno inoltre uso di un link implicito all'articolo di pacman (Italiano) (ad esempio [[pacman (Italiano)|Installare]] ...) ed uno a Official Repositories (Italiano) ([[Official Repositories (Italiano)|repository ufficiali]]): il loro uso è raccomandato almeno per la prima occorrenza di una richiesta di installazione, specialmente negli articoli che hanno maggiore probabilità di essere consultati da principianti di Arch.
  • Esempi di comandi di pacman sono comunque accettati ed anzi incoraggiati nella Beginners' Guide e le sue sotto-pagine.
  • Se il pacchetto è ospitato in [core], [extra] o [community], si eviti di fare riferimento al nome del repository, facilitando così la manutenzione dato che non è infrequente che un pacchetto sia spostato in un repository differente. Se però il pacchetto è ospitato in un repository ufficiale che non è abilitato di default ([multilib], [testing] ecc.), è preferibile menzionarlo, usando una frase simile alla seguente:
    Installare package, disponibile nel repository ufficiale [multilib].

Pacchetti dell'AUR

  • Per richiedere l'installazione di un pacchetto dell'AUR usare una frase simile alla seguente:
    Installare packageAUR, disponibile nell'Arch User Repository.
    Il codice wiki corrispondente è Installare {{AUR|package}}, disponibile nell'[[Arch User Repository (Italiano)|Arch User Repository]].
    È ovviamente consentito adattare la formulazione alle specifiche necessità di ciascun articolo, sebbene sia sempre necessario specificare che il pacchetto non è ufficiale.
  • Non fare esempi di come installare pacchetti dell'AUR, né con il metodo ufficiale né menzionando l'uso di un AUR helper: ogni utente che installa pacchetti non ufficiali deve aver letto l'articolo Arch User Repository (Italiano) ed essere cosciente di tutte le possibili conseguenze sul proprio sistema.

Operazioni con i moduli del kernel

  • Fornire esempi su come aggiungere moduli all'array MODULES in /etc/rc.conf è una pratica deprecata: la formulazione standard prevede una semplice lista dei moduli da aggiungere, eventualmente facendo notare dipendenze o conflitti con altri moduli, ed un link a Kernel modules (Italiano).
  • Fornire esempi su come caricare, rimuovere, mettere in blacklist o eseguire una qualunque altra operazione di base con i moduli è una pratica deprecata: la formulazione standard prevede una descrizione delle azioni che devono essere eseguite e un link a Kernel modules (Italiano).
  • La Beginners' Guide e le sue sotto-pagine sono le uniche eccezioni alle regole di cui sopra.

Operazioni con i demoni

  • Fornire esempi su come aggiungere demoni all'array DAEMONS in /etc/rc.conf è una pratica deprecata: la formulazione standard prevede una semplice lista dei demoni da aggiungere, eventualmente facendo notare dipendenze o conflitti con altri demoni, ed un link a Daemon (Italiano).
  • Fornire esempi su come avviare (start), riavviare (restart) o stoppare (stop) demoni è una pratica deprecata: la formulazione standard prevede una descrizione delle azioni che devono essere eseguite e un link a Daemon (Italiano).
    Ciononostante, se l'azione richiesta non è una di esse, fornire un esempio è accettabile, e si dovrebbe far uso del comando rc.d invece di usare l'intero percorso /etc/rc.d/demone.
  • La Beginners' Guide e le sue sotto-pagine sono le uniche eccezioni alle regole di cui sopra.

Template Nota, Attenzione, Suggerimento

  • Template:Nota dovrebbe essere usato per informazioni che in qualche modo divergono da ciò che il lettore si aspetterebbe più naturalmente di trovare in una parte di un articolo. Questa definizione include anche note che danno informazioni più dettagliate su un particolare e che altrimenti sarebbero considerate un po' estranee all'articolo. Un altro esempio si ha quando è necessario esporre un annuncio temporaneo come per esempio il cambio di nome di un pacchetto.
    Una Nota può anche essere usata per sottolineare importanti informazioni che potrebbero essere facilmente trascurate da lettori non molto competenti sull'argomento.
  • Template:Attenzione dovrebbe essere usato per descrivere procedure che potrebbero avere conseguenze negative come essere particolarmente difficili ad essere annullate o addirittura danneggiare il sistema. I template Attenzione dovrebbero generalmente indicare sia le varie possibili conseguenze negative, sia le condizioni a causa delle quali esse potrebbero verificarsi o al contrario essere evitate.
  • Template:Suggerimento dovrebbe indicare un metodo o una procedura che potrebbe essere utile e portare beneficio per alcuni lettori, benché assolutamente non necessaria per completare l'operazione in esame, e pertanto tranquillamente trascurabile.
  • Quando due o più template Nota, Attenzione o Suggerimento devono apparire uno dopo l'altro in un certo punto di un articolo, è preferibile raggruppare i loro contenuti in una lista dentro un unico template, evitando di mettere i template uno sopra l'altro, a meno che essi non siano per niente correlati uno con l'altro. Ad esempio:
Suggerimento:
  • Esempio di suggerimento #1.
  • Esempio di suggerimento #2.

Shell

  • Non presupporre che l'utente stia usando una shell in particolare (ad esempio bash), tranne quando effettivamente necessario: cercare di essere il più possibile neutrale riguardo alle shell nello scrivere o editare gli articoli.

Metafora dell'ipertesto

  • Cercare di creare link reciproci tra il proprio articolo e quanti più altri possibile, utilizzando le varie parole-chiave nel testo.
  • Per i termini tecnici come chiamata di sistema che non sono trattati in nessun articolo dell'ArchWiki, creare un link alla relativa pagina di Wikipedia.
  • Nel creare link ad altri articoli della wiki, non usare gli URL completi, ma sfruttare la speciale sintassi per i link interni: [[Articolo della wiki]]. Questo metodo permetterà inoltre al software wiki di tenere traccia dei link interni, facilitando così la manutenzione.
    Leggere Help:Editing (Italiano)#Collegamenti per informazioni più dettagliate e usi più avanzati della sintassi dei link interni.
  • Eccetto in rari casi, non si dovrebbe lasciare un articolo senza che questo fornisca link a qualche altro, né si dovrebbero creare pagine orfane, cioè articoli che non sono linkati da nessun'altra pagina.
  • Prima di scrivere una procedura specifica in un articolo, o descrivere qualcosa in particolare, controllare sempre che non esista già una pagina che tratta quella parte in dettaglio: in quel caso, creare un collegamento a quell'articolo invece di duplicare il suo contenuto.
  • Se la documentazione ufficiale per l'argomento del proprio articolo è ben scritta e aggiornata, preferire scrivere solamente adattamenti specifici per Arch, e linkare alla documentazione ufficiale per le informazioni generiche.
  • Non usare link interwiki per collegamenti alle pagine locali nella stessa lingua dell'articolo editato, infatti non sarebbero mostrati nelle pagine Special:WhatLinksHere. Ad esempio usare [[:it:Main Page]] in un articolo in Italiano è sbagliato, mentre [[Main Page (Italiano)]] è corretto.
    Usare questo tipo di link tra lingue differenti è invece accettabile, dato che renderebbe più facile spostare gli articoli su una wiki esterna nel caso questa sia creata.
    Infine, notare la differenza di questo tipo di link con gli #Interlink, i quali non hanno i : all'inizio.

Sezioni "Trucchi e consigli"

  • Suggerimenti avanzati o esempi dell'utilizzo del software.
  • Il titolo standard è Trucchi e consigli.
  • I vari trucchi e consigli devono essere organizzati in sottosezioni.

Sezioni "Risoluzione di problemi"

  • Domande frequenti riguardo al software, o soluzioni a problemi comuni (confrontare con #Sezioni "Problemi noti").
  • Il titolo standard è Risoluzione di problemi; usare l'Inglese Troubleshooting non è considerato conforme a queste linee-guida.
  • È anche possibile riportare soluzioni temporanee per bug conosciuti, ma in tal caso è fortemente preferibile fornire un link al bug report, e nel caso questo non esista ancora si consiglia di crearlo, in maniera da aumentare le possibilità che il bug venga corretto in maniera appropriata.
    Linkare a un bug report porta grandi benefici sia ai lettori che a coloro che mantengono l'articolo:
    • Per i lettori, la Wiki non è un vicolo cieco: viene invece data loro la possibilità di trovare maggiori informazioni, più vicine alla fonte, che magari potrebbero non aver trovato con i propri metodi di ricerca.
    • Per i redattori della Wiki, viene resa più facile la manutenzione riducendo gli sforzi necessari per controllare se il bug riportato è stato risolto nel frattempo; questo può anche dare modo ad un lettore di aggiornare autonomamente l'articolo nel caso trovi informazioni più recenti nel bug report.

Sezioni "Problemi noti"

  • Elencano bug conosciuti o problemi di utilizzo per cui ancora non esiste una soluzione (confrontare con #Sezioni "Risoluzione di problemi").
  • Il titolo standard è Problemi noti.
  • Se esiste un bug report per il problema, è fortemente preferibile includere un link ad esso; nel caso non esista, bisognerebbe provvedere a riportarlo, in maniera da aumentare le probabilità che il bug venga corretto.

Sezioni "Altre risorse"

  • Una lista di link a pagine di riferimento e fonti per informazioni addizionali.
  • Dovrebbe essere una lista in cui ogni voce comincia con *.
  • Il titolo standard è Altre rirorse, è meglio evitare altri titoli simili come Link esterni, Vedere anche ecc.

Contenuti non ammessi

  • Si prega di non aggiungere la propria firma agli articoli, né di ringraziare o citare gli autori di un articolo: l'ArchWiki è un'opera di tutta la comunità, e la cronologia di ogni articolo è sufficiente per riconoscere i meriti di coloro che vi hanno contribuito.
    Ciononostante, è buona norma riportare le fonti usate per scrivere un articolo: a questo scopo è possibile usare la sezione "Altre risorse".
  • Il caricamento dei file è disabilitato per gli utenti normali, e non è ammesso includere negli articoli le immagini esistenti. In alternativa è possibile includere collegamenti a immagini o gallery esterne, e se c'è bisogno di disegnare semplici schemi è possibile usare un editor ASCII come Asciiflow. Giustificazione:
    • Manutenzione: Arch è rolling release, e le immagini renderebbero molto più complicato l'aggiornamento degli articoli.
    • Necessità: Arch non sviluppa né mantiene alcuna applicazione con interfaccia grafica, per cui non è necessario mostrare alcuno screenshot.
    • Moderazione: il caricamento libero di immagini richiederebbe di spendere del tempo per rimuovere immagini sovradimensionate o inappropriate.
    • Accessibilità: supporto per connessioni lente, browser testuali, screen reader e simili.
    • Efficienza: le immagini sprecano banda della connessione dei server e spazio su disco.
    • Semplicità: gli articoli senza immagini appaiono più semplici e ordinati.

Registro linguistico

  • Gli articoli devono essere scritti mantenendo un linguaggio formale, professionale e conciso.
  • Ricordarsi di non dare risposta solo al come, ma anche al perché. Le spiegazioni devono sempre cercare di insegnare qualcosa invece di fornire solamente istruzioni.
  • Evitare di rivolgersi al lettore in seconda persona ("installa/installate questo programma", "apri/aprite il tuo/vostro file manager" etc.). In alternativa è consigliato usare forme infinite ("installare questo programma", "aprire il proprio file manager"), impersonali ("si installi questo programma", "si apra il proprio file manager") o passive ("dev'essere installato questo programma", "dev'essere aperto il proprio file manager").
  • Evitare abbreviazioni non necessarie: ad esempio invece di "repo," "distro," e "config," preferire "repository," "distribuzione," e "configurazione."
  • Scrivere obiettivamente: non includere commenti personali negli articoli, usare le pagine di discussione per tale scopo. In generale, non scrivere in prima persona.
Suggerimento: Gli utenti impegnati nella traduzione di articoli in Italiano potrebbero essere interessati a leggere anche ArchWiki Translation Team (Italiano)#Linee Guida.

Pagine di discussione

  • Aggiungere le nuove discussioni in fondo alle pagine di discussione, con un titolo di sezione appropriato. A questo scopo è anche possibile usare la targhetta + sul bordo superiore di ogni pagina di discussione.
  • Indentare le proprie risposte utilizzando sequenze di : all'inizio di ogni linea di testo.
  • Non editare i propri post se qualcuno ha già replicato, altrimenti si farà perdere il filo della discussione rendendo più difficile per gli altri dare ulteriori risposte. È solamente consentito marcare con una linea parole o frasi (usando i tag <s>), ma la relativa spiegazione dev'essere fornita con un normale post.
  • Terminare sempre i propri interventi con la firma dell'utente (~~~~).
  • Le pagine di discussione non possono essere categorizzate.
  • Bisognerebbe ricordarsi di marcare con una linea i titoli delle discussioni terminate, usando i tag <s>.
    Le discussioni terminate saranno cancellate qualche tempo dopo essere state marcate.
  • Leggere anche Help:Editing (Italiano)#Pagine di discussione.

Pagine delle categorie

  • Ogni categoria dev'essere a sua volta adeguatamente categorizzata sotto almeno una categoria-madre, escluse le categorie di base.
    Le categorie di base sono Category:DeveloperWiki, Category:Languages, Category:Sandbox e Category:Template.
  • Una categoria può essere categorizzata sotto più di una categoria-madre, ammesso che nessuna di queste sia a sua volta categoria-madre (o in generale "antenato") di una delle altre.
  • Evitare relazioni circolari: due categorie non possono essere "antenati" reciproci.
  • Non categorizzare una categoria sotto sé stessa (categoria auto-categorizzata).
  • Le categorie devono essere incluse in cima al testo sorgente di ogni pagina di categoria.
  • Le categorie non possono fare redirezioni.

Pagine di redirezione

  • Le pagine di redirezione devono contenere solamente il codice per la redirezione, niente di più.
  • Redirigere solamente agli articoli interni; non usare redirezioni con link interwiki.

Pagine dei template

Pagine degli utenti

  • Le pagine degli utenti non possono essere categorizzate.

Regole generali

Oggetto

  • Le modifiche fatte ogni giorno agli articoli sono coraggiosamente controllate da pochi appassionati volontari, che è necessario aiutare ricordandosi di riempire sempre il campo dell'"Oggetto" con una spiegazione per ogni edit.
    • Se la modifica è minore, ad esempio correzioni ortografiche o grammaticali o la semplice riformulazione di una frase, una breve descrizione della propria modifica è perfettamente sufficiente.
    • Se si sta effettuando una modifica rilevante, ad esempio l'aggiunta, spostamento, modifica o rimozione di contenuti, oltre a fare un riassunto della modifica è necessario spiegare il motivo per cui è stata fatta, magari fornendo un link alla relativa discussione sulla wiki o ad un thread sul forum, se esistente.
    • Non è necessario fornire spiegazioni per le modifiche alle pagine di discussione, infatti il motivo dovrebbe essere comunque evidente.
      Quando però si rimuovono discussioni che erano già state chiuse, una piccola giustificazione è richiesta (ad esempio "discussione chiusa", "risolto" ecc.) ed includere anche il titolo della discussione medesima potrebbe aiutare a ritrovarla nella cronologia nel caso ci sia bisogno di riaprirla in futuro.
Suggerimento: Dare un'occhiata agli oggetti nelle Ultime modifiche per farsi un'idea di cosa scrivere nell'oggetto della propria modifica, pur tenendo conto del fatto che purtroppo non tutti gli utenti rispettano queste linee guida.
  • Nell'effettuare modifiche rilevanti ad uno o più articoli, è bene cercare di dividere il proprio lavoro in più modifiche separate, basandosi sui vari passi logici necessari per completare l'operazione.
    Specialmente quando si spostano intere sezioni (sia nello stesso articolo che tra articoli differenti), è bene evitare di modificarne il contenuto nel medesimo edit, altrimenti si renderà più difficile controllarne il conseguente diff.

Tag HTML

  • L'uso di tag HTML è generalmente da evitare: meglio preferire l'uso del markup della wiki o i template quando possibile: a tal proposito leggere Help:Editing (Italiano) e gli articoli correlati.
  • Quando si è tentati di usare <pre>codice</pre>, usare sempre {{bc|codice}} al suo posto. Invece di usare <tt>codice</tt> o <code>codice</code>, usare sempre {{ic|codice}}.
  • Evitare in particolare i commenti HTML (<!-- commento -->): è molto probabile che una nota aggiunta in un commento HTML possa essere mostrata esplicitamente nella pagina di discussione dell'articolo.
    Valutare se aggiungere un template di stato dell'articolo appropriato al posto del commento.
  • Usare <br> solo quando necessario: per cominciare un nuovo paragrafo o spezzare una linea basta inserire una linea vuota subito sotto.
    Le più comuni eccezioni a questa regola si hanno quando è necessario spezzare una linea in una voce di una lista, e non è possibile usare una sotto-voce, oppure dentro un template, e non è possibile usare una lista.