Wiki Ubuntu-it

Indice
Partecipa
FAQ
Wiki Blog
------------------
Ubuntu-it.org
Forum
Chiedi
Chat
Cerca
Planet
  • Pagina non alterabile
  • Informazioni
  • Allegati
  • Differenze per "Installazione/CreazioneLiveUsb"
Differenze tra le versioni 12 e 14 (in 2 versioni)
Versione 12 del 14/09/2015 08.32.11
Dimensione: 7839
Commento:
Versione 14 del 23/09/2015 08.09.35
Dimensione: 1354
Commento:
Le cancellazioni sono segnalate in questo modo. Le aggiunte sono segnalate in questo modo.
Linea 4: Linea 4:
<<Indice>>
Linea 6: Linea 5:
= Revisione delle pagine =

Gli [[GruppoDocumentazione/Organizzazione#Editori|editori]] si occupano della pubblicazione delle pagine di documentazione svolte dagli utenti. Per fare questo è necessario eseguire una serie di controlli elencati in questa pagina.

== Procedura generale ==

La procedura standard degli editori può essere riassunta nella sua globalità in questi sei passi:

 0. '''Tenere d'occhio il forum''': controllare di frequente la [[http://forum.ubuntu-it.org/viewforum.php?f=46|sezione]] per la segnalazione di modifiche a pagine esistenti o la creazione di pagine nuove.
 0. '''Tabella revisioni''': inserire i dati di una pagina appena editata nella [[GruppoDocumentazione/PagineDaFare|tabella delle revisioni]].
 0. '''Prendere in consegna''': se si è in condizione di farlo, prenotarsi per la revisione della pagina inserendo il proprio nome nella [[GruppoDocumentazione/PagineDaFare|tabella]].
 0. '''Revisionare la pagina''': controllare (se possibile) la correttezza della guida e adeguarla agli standard in uso.
 0. '''Tabella pagine svolte''': spostare i dati dalla tabella delle revisioni a quella delle [[GruppoDocumentazione/LavoroSvolto|pagine svolte]].
 0. '''Comunicare nel forum''': comunicare la fine della revisione e la pubblicazione della pagina nel [[http://forum.ubuntu-it.org/viewforum.php?f=46|forum]].

= Info pagina e macro =

Assicurarsi che la pagina contenga:

 * '''Macro Indice''': posta insieme al rimando a capo in cima alla pagina (sotto eventuali commenti), garantisce la struttura standard a capitoli e paragrafi:{{{
<<BR>>
<<Indice()>>
}}}

 * '''Macro Informazioni''': posta sotto la macro Indice, indica versioni supportate e link alla relativa discussione sul forum. È del tipo:{{{
<<Informazioni(forum="INSERIRE_LINK_DISCUSSIONE"; rilasci="12.04 14.04")>>
}}}
 * '''Category''': posta a fondo pagina indica le [[GuidaWiki/Categorie|categorie]] di appartenenza. Ad esempio se una pagina fa parte dei portali Hardware e Multimedia sarà del tipo:{{{
----
CategoryHardware CategoryMultimedia
}}}

= Struttura pagina =

La presenza della macro Indice garantisce la [[DocumentazioneModello|struttura]] in capitoli e paragrafi. Per una migliore leggibilità è bene cercare di mantenere basso il numero di paragrafi o sotto paragrafi.

 * Cercare (finché possibile) di utilizzare al massimo i capitoli, ossia i titoli di primo livello, del tipo:{{{
= Capitolo =
}}}

La struttura di una pagina può variare in base agli argomenti trattati, non esiste uno schema unico. Tuttavia è bene evitare casi "estremi" come ad esempio una pagina costituita da un unico capitolo suddiviso in una decina di paragrafi.

= Revisione tecnica =

È buona cosa verificare di persona la correttezza dei contenuti. Purtroppo per vari motivi ciò non è sempre possibile (non si dispone dell'hardware trattato, non si conosce nel dettaglio il software trattato, ecc..).

In questi casi cercare comunque di verificare che i passaggi mantengano una '''logica corretta''' e che non manchino passaggi fondamentali nella procedura.

= Revisione stilistica =

Occorre controllare che la pagina sia scritta:

 * '''in italiano corretto''';
 * '''in forma impersonale''';
 * '''in modo sintetico''';
 * e rispetti i '''formati standard''' in uso.

In definitiva si tratta di adattare il testo agli esempi riportati nella pagina [[GuidaWiki/Standard|Standard]], che raccoglie gran parte delle casistiche esistenti.<<BR>>
Per approfondire determinati argomenti la [[GuidaWiki|Guida Wiki]] presenta link a guide di vario genere come: inserimento di [[GuidaWiki/RegoleStilistiche#Note.2C_avvisi_e_suggerimenti|note e avvisi]], struttura delle [[GuidaWiki/Editor#Tabelle|tabelle]], ecc..

||<tablestyle="text-align: justify; width:100%;" style="border:none;" 5%><<Immagine(Icone/Grandi/info.png,,center)>>||<style="padding:0.5em; border:none;">Spesso il metodo più pratico per risolvere l'editazione di alcuni passaggi, è prendere spunto dalle pagine già esistenti controllandone il codice.||

= Nome e indicizzazione pagine =

In base all'argomento trattato la pagina sarà linkata nel portale di appartenenza e il nome, oltre all'argomento trattato dovrà indicare il portale e gli eventuali sotto-portali di appartenenza. Ad esempio la pagina sulla [[Hardware/DispositiviPartizioni/GestioneDisco|gestione del disco]]:
 * è stata nominata '''Hardware/DispositiviPartizioni/GestioneDisco''';
 * ed è [[Hardware/DispositiviPartizioni|linkata]] nel portale '''Hardware/DispositiviPartizioni'''.

Se una pagina in revisione non ha già un nome appropriato, è opportuno rinominarla attraverso il menù a tendina '''Altre azioni:''' (presente in alto in ogni pagina) selezionando la voce '''Rinomina pagina'''.<<BR>>
Se la pagina in questione è una '''pagina di prova''' per una guida già esistente, allora a revisione ultimata sarà sufficiente eseguire il copia/incolla dei contenuti sulla pagina ufficiale, inserendo un commento in modo che sia chiaro quale utente abbia contribuito alle modifiche.

||<tablestyle="text-align: justify; width:100%;" style="border:none;" 5%><<Immagine(Icone/Piccole/note.png,,center)>> ||<style="padding:0.5em; border:none;">''In caso di affinità una pagina può essere linkata su portali differenti. Ad esempio una guida su di un lettore mp3 può essere indicata sia sul portale multimediale che sul portale hardware.'' ||

= Aggiornare le tabelle =

A lavoro terminato spostare i dati dalla [[GruppoDocumentazione/PagineDaFare|tabella delle revisioni]] alla tabella delle [[GruppoDocumentazione/LavoroSvolto|pagine svolte]].

= Comunicare sul forum =

Terminata la revisione fare presente sul forum le modifiche apportate comprese le aggiunte delle voci negli indici dei portali.<<BR>>

Più in generale cercare di non essere parsimoniosi nell'uso dei link, in modo da fare sempre presente in modo chiaro a quale pagine si stia facendo riferimento. Questo tenendo anche conto che i post col tempo possono essere disseminati di link a pagine non più esistenti.

= Lavori sporchi =
= Ulteriori attività =
Linea 93: Linea 9:
 * Eliminare dalla documentazione i riferimenti a versioni di Ubuntu non più supportate. Si ricorda di non cancellare le pagine relative a note di rilascio e file torrent, in quanto contengono collegamenti incrociati con forum, sito web e newsletter. Verranno lasciate morte.  * Commentare o eliminare dalla documentazione i riferimenti a versioni di Ubuntu non più supportate. Si ricorda di __non__ cancellare le pagine relative a note di rilascio e file torrent, in quanto contengono collegamenti incrociati con forum, sito web e newsletter.
Linea 95: Linea 11:
 * Rivedere la situazione dei redirect all'interno del wiki e valutare quali siano veramente necessari e quali superflui; correggere redirect multipli.  * Controllare la situazione dei redirect all'interno del wiki e valutare quali siano veramente necessari e quali superflui. Correggere i redirect multipli.
Linea 97: Linea 13:
 * Sfogliare la [[http://help.ubuntu-it.org|documentazione]] e controllare i collegamenti che puntano al wiki in cerca di pagine spostate e sparite. Una volta trovata la pagina morta, impostare il redirect alla pagina nuova e inserire un commento indicando a quale versione della guida fa riferimento (Trusty, Vivid..) così una volta non più supportata la guida possiamo togliere il redirect.  * Sfogliare la documentazione e controllare i collegamenti in cerca di pagine spostate e sparite. Una volta trovata la pagina morta, impostare il redirect alla pagina nuova.
Linea 103: Linea 19:
}}} bisognerebbe sostituire la parola ''view'' con ''get''. Quindi: {{{ }}} bisogna sostituire la parola ''view'' con ''get'': {{{
Linea 107: Linea 23:
= Ulteriori risorse =

 * [[GruppoDocumentazione/Organizzazione|Pagina del Gruppo Doc]]
 * [[GuidaWiki|Guida Wiki]]


Ulteriori attività

Infine, un elenco di attività da svolgere occasionalmente:

  • Commentare o eliminare dalla documentazione i riferimenti a versioni di Ubuntu non più supportate. Si ricorda di non cancellare le pagine relative a note di rilascio e file torrent, in quanto contengono collegamenti incrociati con forum, sito web e newsletter.

  • Controllare la situazione dei redirect all'interno del wiki e valutare quali siano veramente necessari e quali superflui. Correggere i redirect multipli.
  • Sfogliare la documentazione e controllare i collegamenti in cerca di pagine spostate e sparite. Una volta trovata la pagina morta, impostare il redirect alla pagina nuova.
  • Sostituire le immagini .jpg con immagini in formato .png.

  • Sostituzione di link allegati. Cercando per testo:

    &do=view

    bisogna sostituire la parola view con get:

    &do=get

    Questo perché, altrimenti, il wiki invece di visualizzare gli allegati visualizzerebbe un internal error. E' un refuso dell'upgrade del wiki. Molto probabilmente con la funzione 1.5.8 questa soluzione andava bene. Questo vale solo per i file con estensione .txt.


CategoryHomepage