Strumenti Utente

Strumenti Sito


wiki:collabora

Differenze

Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.

Link a questa pagina di confronto

Prossima revisione
Revisione precedente
wiki:collabora [2011/05/19 15:15]
gbonanome creata
wiki:collabora [2021/03/08 15:39] (versione attuale)
Linea 1: Linea 1:
 +====== Collabora al manuale di DNG ======
  
 +Il presente manuale è **aperto alla collaborazione** di tutti coloro vogliano contribuire al suo miglioramento. Proprio per questo abbiamo scelto di utilizzare una piattaforma wiki!
 +
 +Chiunque è in grado di modificarne le pagine una volta [[:​home?​do=register|registrato]].
 +
 +Per aiutare chiunque si avvicinasse per la prima volta al mondo dei wiki, abbiamo predisposto una pagina che introduce alla [[wiki:​syntax|Sintassi wiki]], inoltre è possibile trovare online diversi strumenti per la conversione automatica (per esemprio sul [[http://​www.dokuwiki.org/​tips:​htmltowiki|sito ufficiale di DokuWiki]] oppure anche [[http://​toolserver.org/​~diberri/​cgi-bin/​html2wiki/​|qui]]).
 +
 +Abbiamo installato diversi plugin, uno dei più utili è [[https://​www.dokuwiki.org/​plugin:​wrap|wrap]] per la creazione e il posizionamento di box nella pagina. Consigliamo di usarlo per le [[#Regole di formattazione|note]].
 +
 +===== Come contribuire =====
 +
 +E' possibile aiutare in diversi modi:
 +  * **per chi già conosce la [[wiki:​syntax|sintassi dokuwiki]]**,​ è possibile creare o migliorare direttamente le pagine\\ Ogni volta che trovare un link in rosso, sarà sufficiente cliccarvi per poter creare la pagina (solo per utenti registrati),​ mentre quando trovate l'​icona FIXME significa che la pagina è da verificare e migliorare.
 +  * **per chi si stesse avvicinando per la prima volta al mondo wiki**, potreste migliorare le pagine utilizzando l'​editor presente in "​Modifica":​\\ ​ - aggiungendo link tra le pagine\\ - inserendo screenshots (immagini delle pagine di DNG)\\ - aggiungendo il tag FIXME dove ritenete ci siano cose da correggere\\ - migliorando la leggibilità del testo con a capo, grassetti, corsivi e sottolineati :)
 +  * **per chi non avesse voglia di editare le pagine**, ma avesse comunque del materiale utile per il manuale, potete inviare una mail ad //​assistenza@comperio.it//​ specificando nell'​oggetto [DNG Manual] e allegando il materiale in questione. L'​ideale sono file in formato .odt o .doc. (che convertiti grazie agli strumenti linkati prima, permettono di preservate le intestazioni e i link).
 +
 +
 +[[?​do=search&​id=FIXME|Cerca le pagine del manuale da correggere]].
 +===== Regole di formattazione =====
 +
 +**Intestazioni**,​ vanno utilizzate il più possibile a partire dal primo livello (H1), questo permette la generazione automatica del menu di navigazione nella parte superiore destra della pagina.
 +
 +Nel caso di descrizione di un elenco di elementi come i filtri di ricerca, è preferibile utilizzare una tabella che elenchi le etichette sulla sinistra e il significato sulla destra.
 +
 +Le **NOTE** dovrebbero essere suggerimenti o osservazioni particolarmente rilevanti e vanno formattati utilizzando la seguente sintassi
 +
 +<​code>​
 +<WRAP info round>
 +== Titolo della nota ==
 +testo della nota
 +</​WRAP>​
 +</​code>​
 +
 +Per l'​aggiunta di note abbiamo scelto di usare il plugin per DokuWiki [[https://​www.dokuwiki.org/​plugin:​wrap|wrap]]. In questo senso, a seconda del tipo di nota, al posto di //info//, è possibile usare anche: //​important//,​ //tip//, //help//, //​download//,​ //todo//, //alert//.
 +
 +Per il link alle **FAQ** o ai **GUIDE** sarebbe meglio utilizzare la seguente sintassi
 +
 +<​code>​
 +:?: **GUIDE:** [[link alla guida]]
 +:?: **FAQ:** [[link alla FAQ]]
 +</​code>​