6 999
contributi
Aiuto:Prima di iniziare: differenze tra le versioni
nessun oggetto della modifica
S3v (discussione | contributi) mNessun oggetto della modifica |
S3v (discussione | contributi) Nessun oggetto della modifica |
||
| Riga 1: | Riga 1: | ||
{{Stub}} | {{Stub}} | ||
Prima di iniziare a scrivere o modificare una guida | Prima di iniziare a scrivere o modificare una guida è opportuno conoscere poche e semplici convenzioni in modo che il contenuto del Wiki cresca in maniera omogenea e quindi più facile da leggere, per tutti.<br/> | ||
Queste convenzioni riguardano la struttura delle pagine e dell'intero Wiki: se avete dubbi o domande potete utilizzare la pagina di [[Aiuto:Discussioni | discussione]] relativa a ciascuna guida oppure aprire una discussione sul [http://forum.debianizzati.org forum] nella sezione ""Guide@Debianizzati.Org". | Queste convenzioni riguardano la struttura delle pagine e dell'intero Wiki: se avete dubbi o domande potete utilizzare la pagina di [[Aiuto:Discussioni | discussione]] relativa a ciascuna guida oppure aprire una discussione sul [http://forum.debianizzati.org forum] nella sezione ""Guide@Debianizzati.Org". | ||
{{Help}} | {{Help}} | ||
=== Versioni compatibili === | === Versioni compatibili === | ||
Il [[Aiuto:I template|template]] "Versioni compatibili" va inserito all'inizio di ciascuna pagina affinché si capisca immediatamente a quali versioni di Debian fa riferimento la guida | Il [[Aiuto:I template|template]] "Versioni compatibili" va inserito all'inizio di ciascuna pagina affinché si capisca immediatamente a quali versioni di Debian fa riferimento la guida. Consultare [[Template:Versioni compatibili|questa pagina]] per ottenere istruzioni specifiche sul suo utilizzo. | ||
=== Categorie === | === Categorie === | ||
| Riga 10: | Riga 10: | ||
=== Convenzioni sulla sintassi === | === Convenzioni sulla sintassi === | ||
# Tutte le volte che riportate l'output di un comando, un pezzo di un file di configurazione | # Tutte le volte che riportate l'output di un comando, un pezzo di un file di configurazione o in genere dei dati ASCII, racchiudeteli in un riquadro (racchiudendo tra [[Aiuto:Sintassi#Formattazione di codice|<nowiki><pre></nowiki> e <nowiki></pre></nowiki>)]]. | ||
# Se riportate un comando usate come primo carattere '''<code>$</code>''' se il comando deve essere lanciato da utente normale e '''<code>#</code>''' se il comando deve essere lanciato da [[root]]. Lasciate anche uno spazio dopo questo carattere, in modo che il comando non risulti attaccato al <code>$</code> o <code>#</code> e quindi poco leggibile. | # Se riportate un comando usate come primo carattere "'''<code>$</code>'''" se il comando deve essere lanciato da utente normale e "'''<code>#</code>'''" se il comando deve essere lanciato da [[root]]. Lasciate anche uno spazio dopo questo carattere, in modo che il comando non risulti attaccato al <code>$</code> o <code>#</code> e quindi poco leggibile. | ||
# Quando dovete inserire all'interno del corpo del testo i seguenti elementi: | # Quando dovete inserire all'interno del corpo del testo i seguenti elementi: | ||
#* percorsi di file o cartelle; | #* percorsi di file o cartelle; | ||
| Riga 24: | Riga 24: | ||
=== Interconnessione dei contenuti === | === Interconnessione dei contenuti === | ||
Cercate il più possibile di inserire [[Aiuto:Sintassi#Link|link]] ad altre pagine del Wiki | Cercate il più possibile di inserire [[Aiuto:Sintassi#Link|link]] ad altre pagine del Wiki in modo da aumentare le interconnessioni, rendere più facile la ricerca delle informazioni ed evitare inutili ripetizioni in più di una guida.<br/> | ||
Non è necessario che le pagine verso cui si creano i link debbano esistere (in questo caso il link resterà di colore rosso); la loro creazione può essere successiva da parte dello stesso autore o di altri. In entrambi i casi la presenza di link ad altri contenuti del Wiki renderà la guida stessa più completa e | Non è necessario che le pagine verso cui si creano i link debbano esistere (in questo caso il link resterà di colore rosso); la loro creazione può essere successiva da parte dello stesso autore o di altri. In entrambi i casi la presenza di link ad altri contenuti del Wiki renderà la guida stessa più completa, leggibile e facile da aggiornare. | ||
==Evoluzione delle guide== | ==Evoluzione delle guide== | ||
Le guide seguono un percorso ''(idealmente)'' simile a quello seguito dai pacchetti Debian nelle tre distribuzioni. Si distinguono infatti tre fasi per una guida: | Le guide seguono un percorso ''(idealmente)'' simile a quello seguito dai pacchetti Debian nelle tre distribuzioni. Si distinguono infatti tre fasi per una guida: | ||
* '''Stub''': una guida è in questo stato se è ancora incompleta. Queste guide sono caratterizzate dal [[Template:Stub|seguente box]] iniziale. | * '''Stub''': una guida è in questo stato se è ancora incompleta. Queste guide sono caratterizzate dal [[Template:Stub|seguente box]] iniziale il cui inserimento (e rimozione) sarà prevalentemente compito dell'autore della pagina.<br/>Vi preghiamo, come segno di rispetto per coloro che leggeranno la vostra pagina, di non lasciare la guida in stato di "Stub" per troppo tempo. | ||
* '''Guida completa''': la guida | * '''Guida completa''': la guida si ritiene conclusa e gli argomenti di cui tratta possono essere letti senza che vi siano avvertimenti sulla loro completezza. Le guide di questo tipo non hanno nessun segno particolare. Le guide complete sono state terminate dall'autore iniziale e cercano una sorta di [[Template:Autori | verifica]] da parte della comunità. | ||
* '''Guida Debianized''': è il terzo e ultimo livello raggiungibile da una guida sul Wiki. Una guida di questo tipo ha raggiunto la sua piena maturità essendo stata verificata e corretta anche da più di una persona nella community. Nell'indice le guide '''Debianized''' sono facilmente individuabili da una swirl: [[Image:swirl.png|link=]]. Tutte le guide sul Wiki possono diventare [[Debianized]] una volta ricevuto un sufficiente feedback dalla comunità. | * '''Guida Debianized''': è il terzo e ultimo livello raggiungibile da una guida sul Wiki. Una guida di questo tipo ha raggiunto la sua piena maturità essendo stata verificata e corretta anche da più di una persona nella community. Nell'indice le guide '''Debianized''' sono facilmente individuabili da una swirl: [[Image:swirl.png|link=]]. Tutte le guide sul Wiki possono diventare [[Debianized]] una volta ricevuto un sufficiente feedback dalla comunità. | ||
| Riga 41: | Riga 41: | ||
== Pagine protette == | == Pagine protette == | ||
[[Speciale:PagineProtette|Alcune pagine]] del Wiki sono protette, cioè un normale utente non può modificarle anche se registrato. Le pagine protette sono pagine di presentazione del progetto, pagine di licenza o pagine tecniche del Wiki. In nessun caso un articolo di documentazione riguardante Debian GNU/Linux verrà resa protetta. Se trovate una pagina di | [[Speciale:PagineProtette|Alcune pagine]] del Wiki sono protette, cioè un normale utente non può modificarle anche se registrato. Le pagine protette sono pagine di presentazione del progetto, pagine di licenza o pagine tecniche del Wiki. In nessun caso un articolo di documentazione riguardante Debian GNU/Linux verrà resa protetta. Se trovate una pagina protetta che, a vostro avviso, andrebbe resa aperta alla modifiche di tutti, per favore, segnalatelo agli amministratori. | ||
== Consigli grammaticali == | == Consigli grammaticali == | ||
Prima di salvare una guida | Prima di salvare una guida è consigliato controllare la presenza di eventuali errori grammaticali o sintattici. Questo può essere fatto, ad esempio, sfruttando il controllo ortografico presente all'interno di molti editor o del browser che si sta utilizzando oppure utilizzando "aspell": <pre>$ aspell check nomefile</pre> | ||
Di seguito vengono riportati gli errori grammaticali più comuni che possono essere commessi quando si scrive una guida. | Di seguito vengono riportati gli errori grammaticali più comuni che possono essere commessi quando si scrive una guida. | ||