LaTeXi

LaTeXi è un template LaTeX per tesi di laurea in italiano ed inglese. Il suo obiettivo principale è abbattere il monte annuo di imprecazioni lanciate contro LaTeX dagli studenti universitari.

LaTeXi è realizzato in modo da essere facile e veloce da usare anche per persone che muovono i primi passi con LaTeX. Il template è già pronto per la compilazione ed i commenti e questo documento vi guideranno gradualmente nella personalizzazione, dal frontespizio all'elenco dei capitoli.

LaTeXi è espressamente pensato per atenei italiani, poiché si basa sulle funzionalità offerte dal pacchetto TopTesi.

Se state usando Overleaf, potete partire dai due template pubblicati nella Overleaf Gallery:

LaTeXi nasce dal template che Antonio Uccio Verardi (aka poros) ha incominciato a passare ai propri amici come bootstrap (o copia-incolla, che dir si voglia) per le loro tesi di laurea. Da buon informatico, poros l'ha poi commentato, ripulito e messo su GitHub, per il software libero, il progresso dell'umanità, la pace nel mondo e tutta quella roba là.

Guida

Lingua

LaTeXi è composta da due file principali: tesi.tex per tesi in lingua italiana e thesis.tex per tesi in lingua inglese. Eliminate il file che non vi serve. La procedura descritta di seguito è valida per entrambe le lingue.

Dipendenze

Questa guida non dà consigli su editor LaTeX o su problemi di installazione particolari. Internet, invece, sì.

Le dipendenze di LaTeXi sono innumerevoli, ma non tutte sono attivamente utilizzate dal template. Nella lista figurano tutti quei pacchetti che hanno una probabilità medio-alta di essere utilizzati in una comune tesi di laurea. Quando nel bel mezzo della tesi vorrete posizionare un'immagine in maniera assoluta, scrivere una formula o inserire del codice, controllate la lista di pacchetti già inclusi. Probabilmente quello che cercate è già lì in mezzo.

La totalità dei pacchetti dovrebbe essere installabile facilmente tramite qualsiasi gestore di pacchetti LaTeX. L'approccio compila-errore-pacchetto-assente-installa è comunque il modo migliore di procedere se volete installare i pacchetti manualmente.

La dipendenza più problematica da installare potrebbe risultare TopTesi. DOVETE installare TopTesi, LaTeXi è costruito intorno a questo pacchetto. Se il vostro gestore pacchetti è nei guai, seguite le istruzioni riportate nella documentazione ufficiale del pacchetto TopTesi.

Se state usando Overleaf, invece, l'installazione di TopTesi è sostituita dalla cartella tex e dal file latexmkrc.

Compilazione

Compilare sempre il documento principale, mai i capitoli.

Compilare un capitolo al posto del documento principale risulterà solo in una valanga di errori ed in una imprecazione in più.

La compilazione del template genera dei warning. Non vi preoccupate, sono del tutto innocui. Allo stato attuale, LaTeXi non è ancora warning-free, mi dispiace. :(

Come molti documenti in LaTeX è necessario compilare più volte prima di visualizzare correttamente il documento.

Prima compilazione

PDFLaTeX
Biber
PDFLaTeX
PDFLaTex

Compilazioni successive

Ogni volta che le vostre modifiche interessano indici o riferimenti a capitoli, sezioni o immagini:

PDFLaTeX
PDFLaTeX

Ogni volta che le vostre modifiche interessano la bibliografia o riferimenti alla bibliografia:

Biber
PDFLaTeX
PDFLaTex

Ogni altra modifica:

PDFLaTeX

Struttura della cartella

Tutti i file principali risiedono nella cartella LaTeXi. Siete liberi di cambiare il nome della cartella a vostro piacimento. La sotto-cartella images è stata pensata per ospitare le immagini, mentre la cartella code è pensata per mantenere il vostro codice (sì, era ovvio, ma l'ho scritto lo stesso in grassetto, non si sa mai). Ricordatevi che il nome della sotto-cartella figurerà nel percorso da specificare ogni volta che vorrete includere immagini o codice, come mostrato negli esempi (images/cat_photo.png).

Siete liberi di aggiungere, eliminare o modificare le sotto-cartelle, ma, vi prego, ricordatevi di cambiare anche i percorsi all'interno della tesi. Vi prego (sappiamo tutti come andrà a finire...).

Supporto per Overleaf

Se state usando Overleaf, potete partire dai due template pubblicati nella Overleaf Gallery:

Se invece preferite direttamente fare l'upload dei file dal vostro computer, l'installazione di TopTesi è sostituita dalla cartella tex e dal file latexmkrc.

Componenti da personalizzare

Informazioni PDF

La prima cosa da fare è cercare la sezione pdfinfo e personalizzare titolo, autore, soggetto e parole chiave. Non vorrete che un Tinaso qualsiasi risulti l'autore della vostra tesi, vero?

Frontespizio

Il frontespizio è presumibilmente l'unica pagina che chiunque leggerà. Per questo ricordatevi di metterci il vostro nome sopra. Sostituite i campi principali quali titolo, candidato, relatore e data (per carità, ricordatevi la data!). Il formato consigliato per la data è mese in lettere seguito dall'anno, come nell'esempio.

Se lo desiderate, potete cambiare praticamente ogni dicitura presente nel frontespizio (candidato in studente, tesi di laurea in monografia, etc.). I commenti nel template vi segnaleranno cosa modificare.

Sostituite il logo nella cartella images con quello della vostra università. E rinominate l'immagine logo. Oppure cambiate il nome del file all'interno del template, seguendo i commenti. Altrimenti tenetevi il cane.

Se avete scritto una tesi a quattro mani o avete la sfortuna di avere due relatori o, peggio ancora, avete un tutor aziendale, non disperate. L'esempio presenta già i campi necessari. Nel caso in cui non vi servano, invece, fate in modo di cancellarli come suggerito dai commenti.

Per ogni altra particolare personalizzazione, vi prego di rifarvi alla documentazione di TopTesi.

Lista capitoli

Cercate la dicitura includeonly. L'elenco sottostante dovrà corrispondere alla vostra lista dei capitoli ed appendici. LaTeXi consiglia di seguire la regola aurea un capitolo = un file. Vi prego anche di seguire il formato usato nell'esempio.

Subito sotto l'elenco dei capitoli, potete modificare il nome del file di bibliografia. LaTeXi presenta già un file chiamato bibliography da usare.

Dedica e Citazioni

Queste due sezioni sono opzionali. Se odiate tutte le forme di vita di questo quadrante d'universo e l'ultimo libro che avete letto è il manuale del Nokia 3310, siete liberi di eliminarle. Per le persone normali, invece, viene proposto un allineamento orizzontale a destra, un allineamento verticale ad un sesto della pagina e l'uso del corsivo per la fonte citata.

Siete liberissimi di cambiare lo stile del testo: potete allinearlo a sinistra o al centro o più in basso o più in alto, seguendo i commenti o facendo di testa vostra (io ho usato una tabulazione sinistra a 10 cm dal margine destro, per esempio).

Ringraziamenti

Anche questa sezione è opzionale. Vi cosiglio di evitare di superare la pagina, se possibile. Qualunque cosa succeda non superate le due pagine, ma siate consapevoli che una doppia pagina di ringraziamenti ha una probabilità del 50% di creare problemi in stampa, soprattutto se il vostro tipografo di fiducia è un cretino.

Sommario o Abstract

Più un promemoria che altro. Scrivete il vostro sommario o abstract dove indicato dai commenti e tutto andrà liscio.

Indici e varie

LaTeXi presenta di default i seguenti indici:

Indice generale
Indice delle figure
Indice delle tabelle
Indice dei listati

Se un indice non vi serve (mai mettere un indice delle tabelle, se non avete tabelle!!!), semplicemente eliminatelo.

Se volete aggiungere un indice, seguite l'esempio di quello per i listati poco sotto l'elenco delle dipendenze. I commenti vi indicheranno la sezione adatta. (Avviso: aggiungere un indice è un'operazione complessa. Vi sconsiglio di farlo, se siete alle prime armi.)

Poco sopra vi è anche la possibilità di modificare lo stile dei dei collegamenti ipertestuali (in pratica i colori) e la sintassi default, insieme ai colori per le parole chiave, da usare per i listati.

Lista capitoli (sì, di nuovo)

Sì, una seconda lista dei capitoli. Per gli utenti base, questa lista va assolutamente allineata con la precedente (gli utenti avanzati, invece, sanno benissimo come crearsi problemi da soli). È importante notare che la mancata inclusione di un capitolo in una delle due liste, lo farà sparire dal corpo della tesi. (Lo so che è una scocciatura, ma è per il vostro bene, fidatevi.)

Questa seconda lista, che è nel corpo del documento (mentre la prima era nel preambolo) è quella che effettivamente include i vari file con i capitoli all'interno della tesi. Ogni include verrà sostituito dal capitolo corrispondente.

FAQ

Sono alle prime armi con LaTeX, dove posso trovare altre informazioni?

La rete amica e alleata ti è, giovane Padawan. Comunque, ecco un ottimo sito da cui cominciare a cercare.

Ho un problema con LaTeXi! Che faccio?

Prima di tutto, spegni e riaccendi. Secondo, fai il clean dei file temporanei. Terzo, prova a cercare su internet il messaggio di errore: il 99% delle volte è solo una parentesi non chiusa o un _ senza \. Se sei convinto sia colpa del template, scrivi un commento alla fine di questa pagina. Proveremo a cercare una soluzione insieme il prima possibile. Se sai usare GitHub, invece, apri un issue.

Non ci sono gli acronimi!!!

Ehm, sì, non ci sono gli acronimi. Lo so che alcuni professori vogliono la lista degli acronimi ed è comprensibile che voi vogliate accontentarli. Ma, dopo aver provato sulla mia pelle pacchetti come acronym e glossary, penso che tutta la complessità aggiunta dal loro uso (compilazioni accessorie, indice aggiuntivo, riferimenti, etc.) potrebbero danneggiare seriamente l'usabilità di LaTeXi dal punto di vista degli utenti meno esperti. LaTeXi ha come mantra quello di essere semplice da usare. Sinceramente, non credo che il gioco valga la candela. Inoltre, LaTeXi è un template, potete sempre aggiungerli voi! Comunque sono disposto a discuterne, in un commento o in un issue.

Oh, due file diversi per l'inglese e l'italiano! Uuuh, code replication! Brrr...

Sì, sì, sì, hai perfettamente ragione. Tuttavia, LaTeXi è pensata soprattutto per un utenza che non ha grande dimestichezza con LaTeX e con la programmazione in generale. Dividere le due lingue, che hanno configurazioni differenti per frontespizio e titoli delle sezioni, risparmia all'utente un bel po' di personalizzazioni e permette di dare dei simpatici valori di default che variano in base alla lingua. Certo, è un compromesso, ma il Keep It Simple Stupid ha sempre la meglio. Se desideri discuterne ancora, apri un issue.

Perché LaTeXi è un template e non un pacchetto?

Perché un valido pacchetto per scrivere tesi per gli atenei italiani c'è già e si chiama TopTesi. L'idea che sta dietro LaTeXi è quella di essere un template già funzionante e pronto per essere personalizzato in pochissimo tempo, soprattutto da utenti poco esperti.

Non era mia intenzione rimpacchettare tutte le funzioni di TopTesi in un pacchetto che non aggiunge nessuna funzionalità e che avrebbe richiesto una discreta conoscenza di LaTeX per essere usato. LaTeXi si ispira, invece, alla pratica più comune per gli utenti LaTeX: copiare un vecchio documento e cambiargli il titolo. LaTeXi è la tesi che vi avrebbe passato il vostro amico appena laureato.

Ma il codice è in bianco e nero! Buuuuh, volevo i colori...

LaTeXi è stata pensata per avere una discreta resa di stampa in qualsiasi condizione, anche in bianco e nero. Per questo l'unico colore utilizzato oltre al nero è il blu (ben poco blu, solo per alcuni tipi di collegamenti). Comunque, non ti negherò che anche a me piace il codice con i colori dell'arcobaleno e gli unicorni. Anzi, ogni colorazione di sintassi per listing è ben accetta e raccomandata. Se ne siete in possesso, fate una pull request o scrivete un commento alla fine della pagina (soprattutto se per Matlab, linguaggio usato da molta gente senza praticamente nessuna base di programmazione, la quale ne beneficerebbe senz'altro). Sarò felicissimo di aggiungerle come commenti! :)

Mi scoccia poter compilare solo dal documento principale! Perché non hai usato il pacchetto subfile?

Sì, scoccia anche a me. Ma subfile introduce troppa complessità d'uso per gli utenti più inesperti, che si troverebbero ad avere anche un file template per ogni capitolo (e qualche altro problema in più). Se ne può parlare, in un commento o in un issue, ma non credo che il gioco valga la candela, ora come ora.

Mi piacerebbe partecipare al progetto! Come faccio?

Siamo su GitHub, amico! Se hai del codice da aggiungere fai pure una pull request o, se hai trovato un bug o vuoi richiedere una feature, apri un issue. Se non sai di cosa sto parlando, scrivi un commento qui sotto! Ti risponderò appena mi sveglio (sì, di solito dormo).