LaTeX è uno degli strumenti più utilizzati per la scrittura di testi elaborati come una tesi di laurea.

Di seguito sono riportate alcune linee guida per la realizzazione di tesi in LaTeX, e per la realizzazione di presentazioni delle tesi stesse.

Sono benvenuti commenti, aggiunte, osservazioni.

Scrittura di una tesi in LaTeX

Le informazioni che seguono sono alcune linee guida per la redazione di documenti di una certa complessità utilizzando LaTeX, come un libro, una tesi o un articolo scientifico.

I suggerimenti riportati derivano da una lunga esperienza di utilizzo di LaTex, e in particolare derivano dall’osservazione di tipici utilizzi da parte di studenti i quali utilizzano LaTeX per la prima volta. Ovviamente non sono da considerarsi delle verità universali, quanto dei suggerimenti utili a chi affronta per la prima volta il problema di strutturare un documento LaTeX complesso in modo semplice ma efficace.

Queste indicazioni sono invece da ritenersi perentorie per tesisti e dottorandi dei quali sono responsabile. ;-)

Se le indicazioni che seguono ti risultano utili per la scrittura della tesi, ti invito a considerare di citare questa fonte:

[Fac09] Tullio Facchinetti, “Linee guida per la realizzazione di una tesi in LaTeX”, 2009. http://robot.unipv.it/toolleeo/contrib/guidelines_x_tesi/

oppure utilizzando la seguente voce BibTeX:

\misc{Fac09,
  author = {Tullio Facchinetti},
  title = {Linee guida per la realizzazione di una tesi in LaTeX},
  year = {2009},
  note = {\url{http://robot.unipv.it/toolleeo/contrib/guidelines_x_tesi/}},
}

Per l’utilizzo è richiesto l’uso del package url.

Strutturazione del documento

• suddividere il documento principale in file separati
• ogni file conterrà un capitolo, e i file saranno inclusi nel documento principale per mezzo della direttiva \input di LaTeX

Strutturazione della directory di lavoro

• collocare tutti i file .tex in un’unica directory di lavoro;
• collocare tutti i file di immagini, sia i sorgenti (svg, fig, …) che i file da includere (eps, jpg, png, pdf, …), in un’unica sottodirectory della directory di lavoro;

Non ha senso ne’ è conveniente avere un albero delle directory eccessivamente complicato. Per contro, mettere tutti i file .tex e le immagini nella stessa directory ne complica la gestione.

Nomi dei file

Evitare quanto più possibile, se non in modo assoluto, gli spazi nei nomi dei file. Per due ragioni:

• l’inclusione di file all’interno di altri file (comandi \include o \input di LaTeX) può essere difficile da gestire;
• l’inserimento del nome da linea di comando diventa lento e spesso difficoltoso.

Realizzazione di immagini e figure

• Immagini e figure sono indispensabili per la buona presentazione dei contenuti di una tesi. Si consiglia di utilizzare strumenti che permettano la realizzazione di immagini di buona qualità in modo semplice e intuitivo.
• E’ preferibile la realizzazione di immagini in formato vettoriale piuttosto che in formato bitmap, in quanto le immagini vettoriali scalano senza sgranare indipendentemente dalla dimensione. Il formato standard per l’editing di immagini vettoriali è SVG.
• Un potente editor per la realizzazione di immagini vettoriali in formato SVG è inkscape.
• Nel caso sia necessario realizzare grafi o strutture di database, un comodo strumento è graphviz, che partendo da una descrizione in formato testo del grafico genera una immagine nella quale i simboli e i componenti sono formattati adeguatamente.
• Infine, i grafici possono derivare da elaborazioni effettuate ad esempio in MatLab. In questo caso è semplice esportare l’immagine in un formato vettoriale appropriato come SVG o EPS.

ATTENZIONE. LaTeX non supporta direttamente il formato SVG, ovvero non è possibile inserire direttamente nel documento l’immagine in tale formato. Il formato vettoriale è utile per mantenere l’immagine in un formato editabile. Per l’inclusione nel documento LaTeX è necessario convertirla in formato .eps, per l’uso con il comando latex oppure in format .pdf (consigliato), per l’uso col comando pdflatex.

Espedienti e raccomandazioni varie

• quando nel documento è presente un termine di uso comune ma complicato o prono a errori di digitazione, definite un nuovo comando con \newcommand e usare il comando nel testo; in genere un nuovo comando è utile nel caso in cui siano presenti combinazioni di maiuscole e minuscole, caratteri tipografici speciali, o un testo particolarmente lungo; questo permette, tra l’altro, di cambiare semplicemente il termine se necessario; per esempio:

  \newcommand{\lgl}{LaTeX-guiDELineS}

E’ poi possibile utilizzare il comando in questo modo “questo testo fa riferimento a \lgl”.

• usare coerenza nell’uso di maiuscole e minuscole nel testo; se si scrive “figura X”, usare sempre la minuscola, e non scrivere “Figura Y”; questo vale principalmente per i seguenti termini: figura, equazione, tabella, sezione, capitolo
• allo stesso modo, essere coerenti nella scrittura di termini tecnici e non, con particolare attenzione all’uso della combinazione di lettere maiuscole/minuscole e trattini; ad esempio, modi diversi per scrivere lo stesso termine andrebbero evitati, utilizzando sempre lo stesso: es. Real-Time, Real-time, real-time, real time
• privilegiare i riferimenti a formule, equazioni e capitoli indicando il numero della formula o capitolo con un comando \ref, invece che scritture del tipo “nell’equazione seguente”, o “nel capitolo precedente”; questo permette, tra l’altro, di riorganizzare l’ordinamento di capitoli e sezioni senza preoccuparsi di andare a modificare il testo che vi fa riferimento
• usare coerenza nel terminare la caption di una tabella o figura; se si termina con il punto, usarlo sempre
• le note a pié di pagina (comando \footnote) iniziano con la maiuscola e terminano col punto; non ci sono spazi tra il comando \footnote e la parola che lo precede
• in corrispondenza di una citazione (comandi \ref e \cite), separare il comando dalla parola precedente con la tilde () e senza spazi; questo introduce uno spazio nel testo generato da LaTeX, ma evita l’andata a capo tra la parola e la citazione, che non è stilisticamente piacevole (es. “articolo\cite{Fac05}”)
• includere una indicazione dell’anno nelle etichette dei riferimenti bibliografici (es. Fac05, Silvan1976, TFTB01); questo permette di capire immediatamente quanto recente è la citazione
• in tabelle e figure, inserire la \1abel all’interno della \caption; questo evita fastidiosi problemi che talvolta si verificano con la numerazione automatica effettuata da LateX (es. \caption{Testo.\label{f:figura}})
• citare tutte le fonti dalle quali le informazioni sono state prese, in particolare quando vengono menzionati dati quantitativi (numeri) che non sono calcolati esplicitamente
• ogni riferimento nella bibliografia deve essere citato nel testo
• ogni figura o tabella deve avere un riferimento nel testo
• ogni volta che un nuovo termine viene introdotto, esso deve essere correttamente definito; es., se si parla di “bias”, anche se questo è un termine tecnico di uso (abbastanza) comune, è bene, la prima volta che viene citato, specificare cosa esso significa
• a meno che non ci siano ottime ragioni per fare il contrario, lasciare che sia LaTeX a posizionare tabelle e figure; evitare quindi di specificare opzioni come [htbp] per l’ambiente; in particolare [h] specifica di inserire la tabella o immagine in corrispondenza del punto del testo in cui si inserisce l’ambiente \figure o \table; questo è da evitare, e lasciare che sia LaTeX a posizionare l’oggetto, che in genere viene posto nella parte alta della pagina

La coerenza innanzi tutto! Il testo LaTeX si può assimilare al codice di un programma: la lettura del sorgente (ovvero l’attività che svolge il revisore del testo) viene facilitata notevolmente se si usa una convenzione coerente.

Presentazione della tesi

Le seguenti indicazioni fanno riferimento ad una tipica presentazione di un lavoro di tesi che si svolge presso il Laboratorio di Robotica.

Organizzazione della presentazione

Nella indicazione del numero di slide viene considerato un tempo totale per la presentazione di circa 15-20 minuti (a seconda del tipo di laurea).

Tra parentesi quadre il numero orientativo di slide

• n. 1 : titolo
• n. 1 : sommario (contenuto della presentazione)
• n. 1-2 : obiettivo della tesi
• n. 0-2 : state dell’arte / campi di applicazione
• n. 1-2 : visione d’insieme del lavoro di tesi
• n. 1-5 : parte hardware
• n. 1-5 : parte software
• n. 1-5 : risultati sperimentali
• n. 1 : conclusioni

Si consideri di realizzare circa 15-17 slide di contenuti, ovvero esclusa la slide del titolo e di conclusione.

Presentazione in LaTex

Se la redazione della tesi viene effettuata utilizzando LaTeX, può essere molto agevole utilizzare Beamer per realizzare la presentazione.

Beamer è una classe LaTeX molto potente per la creazione di presentazioni. Il vantaggio è che, se non si desiderano effetti “speciali”, è possibile produrre una presentazione di ottima qualità in breve tempo copiando il testo LaTeX dalla tesi, e adattandolo opportunamente allo stile di una presentazione.

Beamer produce tipicamente un file in formato PDF, una slide per pagina. Questo, tra l’altro, evita la necessita’ di programmi di presentazione dedicati, che devono essere presenti sul computer utilizzato per la presentazione. Inolte, si evita qualsiasi problemi di compatibilita’ al variare delle versioni di tali programmi.

E’ possibile realizzare semplici effetti di transizione riportando su slide consecutive il materiale che “rimane a video” (testo, immagini), e aggiungendo in ciascuna slide il nuovo materiale. Inoltre Beamer fornisce potenti strumenti per realizzare i classici effetti di apparizione delle voci in un elenco puntato e vari altri effetti.