Aiuto:Contents
Da Guide@Debianizzati.Org.
Intro
Questo sito è un wiki, ciò vuol dire che puoi editare ogni pagina semplicemente iscrivendoti e cliccando sul tasto modifica presente (in alto) su ogni pagina. Il motore usato per questo wiki si chiama MediaWiki, ed è lo stesso usato da Wikipedia.
Quelle di seguito sono delle semplici linee guida che abbiamo scritto per sfruttare al meglio le potenzialità di MediaWiki e per rendere più facilmente gestibile il wiki in maniera collettiva.
Modificare una pagina
Cliccando sul tasto modifica di una pagina (provate su questa pagina di prova: Sandbox) vederete un box con del testo. Modificando quel testo modificherete la pagina, cliccando sul tasto salva.
Sintassi
La sintassi usata è molto semplice e per certi versi è simile al testo semplice non formattato. Puoi trovare uno specchietto con i principali elementi di formattazione qui:
Altre Regole
Alcune regole che rendono più facile la gestione del wiki:
- Quando modificate una pagina scrivete sempre un sommario prima di salvare. Basta inserire una piccola descrizione delle modifiche nella casella "Oggetto" (in basso sotto il riquadro che contiene l'articolo). L'oggetto della modifica apparirà nella history e renderà più facile seguire come è stata modificata la pagina nel corso del tempo. Per banali correzioni ortografiche o di battitura spuntare la casella Questa è una modifica minore. Nella history della pagina le modifiche minori possono essere nascoste.
- Usate sempre il tasto Anteprima prima di salvare le modifiche in modo da vedere il risultato ed effettuare eventuali correzioni subito. In tal modo si evita anche di allungare inutilmente la history della pagina.
- Scegliete accuratamente il titolo, in modo che si capisca subito di cosa tratta la guida, ma evitate titoli troppo lunghi e verificate attentamente che non contenga errori grammaticali.
Creare una pagina
Il modo più comodo per creare una pagina è quello di inserire sulla barra del browser il seguente indirizzo e poi premere [Invio]:
http://guide.debianizzati.org/index.php/Nome della pagina da creare
Dove "Nome della pagina da creare" va sostituito col titolo da assegnare alla guida.
Nella successiva pagina visualizzata a video, basta cliccare su "Modificare la pagina ora. " per poter iniziare a scrivere la guida.
Altro metodo è quello di inserire un link (che sarebbe il titolo racchiuso tra [[ ]]) alla pagina che si vuole creare. Potete usare a questo scopo la vostra pagina personale o la Sandbox. Ad esempio se scriviamo:
[[Condivisioni di stampanti in reti miste Linux - Windows]]
comparirà un link ad una pagina inesistente:
Condivisioni di stampanti in reti miste Linux - Windows
(i link a pagine inesistenti hanno colore rosso), cliccando su questo link non comparirà una pagina vuota bensì una pagina in cui potrete inserire il testo dell'articolo.
Per approfondimenti su come creare link:
Modificare il titolo di una guida
In linea di massima il titolo di una guida non andrebbe mai modificato se non per motivi importanti. Si consiglia, pertanto, di sceglierlo con cura e ponderazione, come spiegato qui.
Se avete dato un titolo errato, potete rinominare la pagina cliccando dal menù a cascata in alto sulla voce "Sposta", ma ricordatevi di aggiornare anche tutti i link alla pagina stessa (guardate l'apposito link nella sidebar a sinistra: "Puntano qui"). Quando una pagina viene rinominata, la vecchia pagina conterrà un redirect alla nuova pagina. Tuttavia la nuova pagina non conterrà la storia delle modifiche precedenti allo spostamento e questo rende molto più difficile controllare le modifiche.
Per qualunque domanda o problema inerente a quest'aspetto, utilizzare la pagina di discussione corrispondente alla pagina che si vuol rinominare.
Cancellare una pagina
Una pagina può essere cancellata solo dagli amministratori del Wiki. Benché sia comunque possibile cancellarne l'intero contenuto, la pagina resta comunque raggiungibile con tutte le sue discussioni e la cronologia.
Se si vuol cancellare una guida, motivarne la decisione nella pagina di discussione corrispondente e utilizzare il template "Da cancellare".
Convenzioni
Ci sono delle semplici convenzioni da rispettare in modo che il contenuto del wiki cresca in maniera omogenea e quindi più facile da leggere, per tutti.
- Inserite, all'inizio di ogni guida, il template Versioni compatibili, che permette di capire immediatamente a quali versioni di Debian fa riferimento la guida in oggetto. Per le istruzioni specifiche su come inserire questo template si veda la pagina Usare i Template.
- Ciascuna guida deve far parte di una o più categorie per essere indicizzata e permetterne una più facile ricerca e individuazione. Ricordarsi pertanto di inserire, in calce alla guida, il tag [[Categoria: nome_della_categoria]] per ciascuna categoria di cui la guida andrà a far parte.
- Tutte le volte che riportate un comando, un pezzo di un file di configurazione, o in genere dei dati ASCII, racchiudeteli in un riquadro (racchiudendo tra <pre> e </pre>).
- Se riportate un comando usate come primo carattere
$se il comando deve essere lanciato da utente normale e#se il comando deve essere lanciato da root. Lasciate anche uno spazio dopo questo carattere, in modo che il comando non risulti attaccato al$o#e quindi poco leggibile. - Quando dovete inserire all'interno del corpo del testo i seguenti elementi:
- percorsi di file o cartelle;
- nomi di file;
- comandi, opzioni di comandi, singole stringhe e/o direttive dei file di configurazione;
racchiudeteli tra i tag <code> e </code>.
- Dividete in maniera logica la guida in sezioni, sottosezioni (e, se necessario sotto-sottosezioni). In questo modo si sfrutterà meglio la potenza di MediaWiki che creerà automaticamente un indice iniziale che renderà molto più facile la navigazione nella vostra guida.
- Usate, quando necessario, i vari elementi di formattazione (descrizioni, riquadro di warning, esempio ecc.): la guida risulterà più leggibile.
- Cercate di rendere leggibile e pulito il codice della pagina, evitando ad esempio di lasciare tante righe vuote consecutive.
- Cercate il più possibile di inserire link ad altre pagine del wiki, in modo da aumentare le interconnessioni e rendere più facile la ricerca delle informazioni.
Firmare una guida
L'autore di una guida può, se vuole, firmarla, preferibilmente alla fine. Per inserire la firma bisogna utilizzare il template "Autori" ed aggiungere il proprio nickname attraverso tre o quattro tilde " ~ " (AltGr+ì sulla tastiera):
{{Autori | Autore = ~~~~ }}
oppure:
{{Autori | Autore = ~~~~~ }}
- Tre tilde (~~~) vengono convertite automaticamente nel nickname;
Ad esempio:
~~~
diventa:
S3v
- Quattro tilde (~~~~) vengono convertite automaticamente nel nickname più la data attuale;
Ad esempio:
~~~~
diventa:
S3v 17:12, 13 apr 2012 (CEST)
Ovviamente il nickname inserito al posto delle tilde cambia a seconda di chi scrive.
Inoltre, cliccando sul nickname, si accede alla corrispondente pagina personale sulla quale si possono scrivere, se si vuole, informazioni o note personali.
Evoluzione delle guide
Le guide su Guide @ Debianizzati.org 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 seguente box iniziale:
| Attenzione Questo articolo è ancora incompleto o richiede delle verifiche. Sentiti libero di contribuire cliccando sul tasto "Modifica". |
inseribile semplicemente aggiungendo all'inizio della guida il seguente testo:
{{stub}}
- Guida completa: la guida è ragionevolmente completa e può essere usata per conoscere nuovi argomenti. Le guide di questo tipo non hanno nessun segno particolare. Le guide complete sono state terminate dall'autore iniziale e cercano una sorta di testing da parte della comunità.
- Guida Debianized: è il terzo è 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. Le guide Debianized si distinguono con un apposito Template posto al loro inizio dallo staff di debianizzati. Nell'indice le guide Debianized sono facilmente individuabili da uno swirl:
. Tutte le guide sul wiki possono diventare Debianized una volta ricevuto un sufficiente feedback dalla comunità.
Se leggi una guida e verifichi la sua correttezza, per favore, inserisci alla fine della guida, dopo il nome dell'autore una nota come questa:
| Esempio firme in calce ad un articolo :Autore: The_Noise
|
In tal modo si può tenere traccia della maturità della guida. Analogamente per correzioni od estensioni di un certo rilievo (non certo per una correzione ortografica) è consigliabile inserire una nota come nell'esempio:
| Esempio firme in calce ad un articolo :Autore: The_Noise |
Con questi piccoli accorgimenti che richiedono un piccolo aiuto da parte della community, speriamo di poter tracciare e mantenere lo "stato di salute" delle guide, sperando che un numero sempre maggiore di esse diventi Debianized ;-).
Ripristinare versioni precedenti di una pagina
Il wiki tiene traccia completa della storia di tutte le modifiche effettuate su ogni pagina. È possibile accedere allo storico delle modifiche cliccando sul link cronologia in alto. Dalle revisioni di una pagina è possibile ripristinare una qualsiasi versione precedente se il suo contenuto è stato danneggiato o cancellato. Ecco perché è importante loggarsi sempre e scrivere un chiaro sommario per ogni modifica.
Monitorare una pagina
Se hai scritto una guida probabilmente vorrai controllare anche le modifiche successive che vengono fatte da altri. Questo è molto facile, basta premere su link segui in alto in ogni pagina e quella pagina verrà aggiunta alla tua lista di Osservati Speciali (anche questo link è in alto).
Discussioni
Ad ogni pagina del wiki è associata una pagina di discussione nella quale si può parlare di come estendere o modificare un particolare articolo. Per accedere alla pagina delle discussioni basta cliccare su link discussione, in alto. Nella pagina di discussione devono essere discussi e risolti eventuali disaccordi su come modificare una pagina.
La pagina di discussione è anche un utile strumento per chiedere chiarimenti o estensioni su un articolo, ed in genere per parlare di tutto ciò che riguarda una particolare pagina.
Segnalazione dei problemi
Ogni segnalazione può essere fatta editando la pagina di Discussione relativa alla guida su cui si è riscontrato un problema oppure aprendo una discussione nel forum (sezione "Guide@Debianizzati.Org").
Le segnalazioni vanno inviate nei seguenti casi:
- Problemi di visualizzazione dei contenuti (specificare il browser utilizzato, il sistema operativo ed ogni altra cosa si reputi utile alla risoluzione del malfunzionamento)
- Violazione di licenze o copyright
- Comportamento inaspettato di funzionalità del Wiki
- Contenuti ritenuti inappropriati, discriminatori, censori o che vìolino il contratto sociale
- Contenuti che possono delinearsi come spam
è inoltre possibile segnalare, sempre nella pagina di Discussione della relativa guida, apprezzamenti, critiche, proposte e indicazioni di passaggi errati o fuorvianti.
Non si devono segnalare problemi derivanti dall'applicazione della guida, ma piuttosto avvalersi del forum.
Tenere sempre presente che questo Wiki è uno strumento democratico e collaborativo. Ognuno può liberamente correggere o integrare le guide nel rispetto del contratto sociale.
Pagine protette
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 (come ad es. i template). In nessun caso un articolo di documentazione riguardate Debian GNU/Linux verrà resa protetta. Se trovate una pagina di documentazione protetta, per favore, segnalatelo agli amministratori.
Licenze
Ogni articolo pubblicato è da considerarsi rilasciato secondo una licenza Creative Commons. Ti preghiamo di non inserire nel wiki contenuti coperti da diritti d'autore. Qualora si scoprano violazioni di copyright gli articoli interessati verranno rimossi.
Alcuni articoli saranno firmati da Utente:Guide @ Debianizzati.Org. Questi l'articoli possono nascere da una discussione sul forum, in chat o in genere dallo sforzo collaborativo di più persone della community.