Help:Contents
From :indamud
Contents |
Intro
Questo sito è un wiki, che in soldoni 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 (figo vero??) ;)
Quelle di seguito sono delle semplici linee guida che ho scritto, anzi, che ho gentilmente copiato in giro per la rete, 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.
- Le pagine in genere non dovrebbero mai essere rinominate. Se avete dato un titolo errato, potete rinominare la pagina ma ricordatevi di aggiornare anche tutti i link alla pagina stessa (guardate l'apposito link nella toolbox a sinistra). 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.
- Scegliete accuratamente il titolo, in modo che si capisca subito di cosa tratta la guida, ma evitate titoli troppo lunghi.
Creare una pagina
Il modo più comodo per creare una pagina è quella di creare un link (che sarebbe il titolo racchiuso tra [[ ]]) alla pagina che si vuole creare. Potete usare a questo scopo la vostra pagina personale. 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 comparià una pagina vuota bensì un pagina in cui potrete inserire il testo dell'articolo.
Per approfondimenti su come creare link:
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.
- Tutte le volte che riportate un comando, un pezzo di un file di configurazione, od 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.
- 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 una tavola dei contenuti 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 fare 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 basta scrivere:
: ~~~
ottenendo questo (c'è il mio nome perchè l'ho scritto io):
se si vuole inserire anche il nome reale e la data basta usare quattro tilde (~) al posto di tre. Cliccando sul nome si accede alla pagina personale di ogni iscritto nella quale potrete scrivere, se volete, informazioni su di voi.
Per separare la firma dal corpo della guida è consigliabile inserire una linea con quattro trattini (segno meno):
----
che nell'output diventano una linea continua come questa:
Evoluzione delle pagine
Le guide su :indamud seguono un percorso abbastanza semplice, passano quindi attraverso 3 fasi di "revisione":
- Draft: 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. |
{{draft}}
- Completed: 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 cominità.
- Reviewed: è 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, perfavore, inserisci alla fine della guida, dopo il nome dell'autore una nota come questa:
|
Esempio firme in calce ad un articolo
|
In tal modo si può tenere traccià 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 |
Con questi piccoli accorgimenti che richiedono un piccolo aiuto da parte della community, speriamo di poter tracciare e mantere 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 revisioni 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 watch 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 discussion, 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.
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:indamud.org. Questi l'articoli possono nascere da una discussione sul forum, in chat o in genere dallo sforzo collaborativo di più persone della community.
