Introduzione a come contribuire

La creazione di documentazione di qualità è questione sia di contenuti che di struttura. I contenuti devono essere quanto più pedagogici possibile in relazione al gruppo di lettori a cui essi sono rivolti. Per questo conviene corredare le esposizioni con esempi e, se necessario, con immagini. Nonostante la documentazione non debba essere necessariamente completa è auspicabile che una sua parte sia stabile e corretta dal punto di vista dell'ortografia. Le parti sperimentali di documentazione verranno inserite nella directory incoming o in TeXmacs Wiki.

Un ulteriore importante aspetto riguarda la struttura da conferire ai documenti che deve essere curata e organizzata ricorrendo principalmente all'uso dei marcatori inclusi nello stile tmdoc. La strutturazione dei documenti serve per poter compilare automaticamente libri stampabili, per poter utilizzare diverse modalità di visualizzazione degli stessi e per rendere più efficenti le ricerche di informazioni contenute al loro interno. In modo particolare ogni documento deve contenere indicazioni sul copyright e sulla licenza e, se esso fa riferimento a molti file, deve contenere le indicazioni per poter spostarsi automaticamente all'interno della restante documentazione.

Avviso 1. Se state traducendo un documento non dimenticate di selezionare il comando Documento→Lingua→Your language. In questo modo alcune parti del documento, come i menu o le istruzioni, verranno automaticamente tradotte. Si raccomanda anche l'utilizzo del correttore ortografico di TeXmacs il cui uso è chiaramente condizionato dalla scelta della lingua in cui è redatto il documento.