Come scrivere pagine per l'help online (Document expired)
Come scrivere pagine per l'help online di IGSuite
Per permettere a chiunque di contribuire alla scrittura dell'help online di IGSuite, in questa piccolo howto abbiamo definito degli stili e delle regole. Vogliamo orientare chi vuole scrivere documentazione per l'help online a realizzare pagine che risultino tutte simili nell'aspetto e identiche nella struttura.
Tutte le pagine destinate a far parte dell'help devono avere impostato nelle proprietà il template 'template-help'.
Tutte le pagine devono avere sia come permessi di lettura ma anche di scrittura la voce "Tutti indistintamente" in modo che anche chi non è autenticato come utente possa visualizzarle e crearne delle nuove bozze.
I titoli delle pagine devono rispettare questa formattazione "Feature - titolo_help" esempio: "IGCalendar - Come inserire un evento"
I contenuti devono essere organizzati per titoli ( == titoli == ) su più livelli in modo che IGWiki possa generare il TOC automatico.
Le immagini, a meno che non siano "inline", dovrebbero avere per quanto possibile tutte l'attributo "right" in modo d'averle tutte sulla destra dei contenuti.
Le pagine devono essere elaborate tenendo in mente che la loro larghezza può variare.
Quando si modificano pagine altrui, onde evitare di sommergere il proprietario delle pagine di messaggi di avviso, occorre utilizzare il più possibile il tasto "anteprima" e salvare la pagina solo a fine lavori.