- The \glox and \gloxspacing commands have been removed

- The glossary and acronyms entries and usage have been improved
- The code handling and management have been enhanced
- Minor enhancements and improvements

Author: giovannifil-64

README.md

@@ -34,6 +34,9 @@ Rispetto alla versione originale, sono state apportate alcune modifiche, tra cui
 
 Qui puoi vedere un esempio del [PDF generato](res/thesis_template.pdf).
 
+> [!NOTE]
+> Se devi stampare la tesi, assicurati di rimuovere il colore dal documento decommentando la riga `\hypersetup{draft}` in `config/thesis_config.tex`, in modo da rimuovere i link e il colore dai riferimenti.
+
 ## Utilizzo
 
 Dopo aver scaricato la repo, nel percorso [```thesis/files```](https://github.com/giovannifil-64/unipd-thesis-template/tree/main/thesis/files) troverete i file in LaTeX della tesi. Per copiarla su Overleaf va compressa la cartella ```files``` e caricare il file ```.zip``` ottenuto.
@@ -46,11 +49,16 @@ Dopo aver scaricato la repo, nel percorso [```thesis/files```](https://github.co
 
 > [!NOTE]
 >
-> - Per far apparire il Glossario e la lista degli Acronimi e abbreviazioni occorre citare almeno un termine con ```\gls{termineg}``` (dove ```g``` è una convenzione interna). Questo farà apparire il termine in forma estesa, ad esempio ```\gls{sdkg}``` apparirà come "_Software Development Kit_".
-> - Per far anche apparire la sigla, occorre utilizzare ```\gls{termine}```, quindi non con la ```g```. Ad esempio ```\gls{sdk}``` apparirà come "_Software Development Kit (SDK)_".
-> - Per inserire una g a pedice, occorre utilizzare ```\gls{termineg}\glox```, in questo modo apparirà come "_Software Development Kit<sub>g</sub>_".
-> In caso vi sia la presenza di un carattere dopo la g, come un punto o una virgola, occorre utilizzare ```\gls{termineg}\glox\gloxspacing```, in questo modo vi sarà il giusto spazio tra la g a pedice e il carattere.
-> - Per inserire un termine nel Glossario, bisogna aggiungere la voce nel file ```references/glossary_acronyms.tex```, seguendo la struttura già presente.
+> - Per far apparire il Glossario e la lista degli Acronimi e abbreviazioni occorre citare almeno un termine all'interno del documento. Per farlo si può utilizzare la sintassi ```\gls{termine}```.
+> Ad esempio:
+> ```latex
+> Lorem \gls{sdkg} ispum dolor
+> ```
+> il termine apparirà come "_Software Development Kit (SDK)<sub>G</sub>_".
+> Nei successivi utilizzi, il termine apparirà come "_Software Development Kit<sub>G</sub>_".
+> se invece si vuole che il termine appaia sempre con la sigla, si può utilizzare la sintassi ```\gls{sdkg}``` (l'utilizzo di g è una convenzione per indicare che il termine è un acronimo).
+> Per inserire un termine nel Glossario, bisogna aggiungere la voce nel file ```references/glossary_acronyms.tex```, seguendo la struttura già presente.
+>
 > In caso di dubbi, si può consultare il Capitolo 7 di questo template, che mostra alcuni esempi di utilizzo.
 
 ### latexmk
@@ -61,7 +69,7 @@ Successivamente, è possibile compilare il documento tramite il comando `latexmk
 
 ## PDF/A
 
-Il template è predisposto per la generazione di un file PDF/A-1A. Per le immagini si raccomanda di usare **sempre** un file _jpeg_, in modo da non avere problemi con la trasparenza per la validazione.
+Il template è predisposto per la generazione di un file PDF/A-1A. Per le immagini si raccomanda di usare **sempre** un file _jpeg_ o _jpg_, in modo da non avere problemi con la trasparenza per la validazione.
 
 Al momento sono presenti due warning:
 

res/thesis_template.pdf

@@ -14,6 +14,10 @@ Il template è strutturato nel seguente modo:
 │   ├── 2_processes.tex
 │   └── ...
 │
+├── code/
+│   ├── example.py
+│   └── ...
+│
 ├── config/
 │   ├── packages.tex
 │   ├── thesis_config.tex
@@ -42,6 +46,7 @@ Questi sono i documenti più importanti:
   - `bibliografia.tex`: la struttura automatica della bibliografia. Non è necessario modificare nulla qui
   - `glossary_entries.tex:` dove si inseriscono le definizioni del glossario, seguendo la sintassi dei termini di esempio.
   - `webliography.bib`: dove si inserisce il contenuto effettivo della sitografia. In genere si tratta di link a siti web, articoli online, ecc. È possibile utilizzare lo stesso file di bibliografia, ma è consigliabile tenerli separati per una maggiore chiarezza. Se non si ha bisogno di una sitografia, è rimuovere il riferimento a questo file in `thesis.tex`
+- `code/`: contiene tutti i file di codice che si vogliono includere nella tesi. Si possono importare direttamente nel documento con `\inputminted{python}{code/example.py}`.
 - `config/`
   - `variables.tex`: è il primo file da consultare.
     Definisce tutte le variabili che verranno utilizzate per riempire automaticamente alcuni contenuti del documento, come il titolo, il vostro nome, il vostro professore, ecc.
@@ -66,7 +71,7 @@ Vi si trovano già alcuni capitoli di esempio, che hanno lo scopo di mostrare co
 Utilizzate nomi di file che riflettano il contenuto del capitolo, evitando di chiamarli `capitolo-03.tex`.
 
 > [!IMPORTANT]
-> Quando si creano, si cancellano o si modificano file, è necessario modificarne il riferimento dentro `thesis.tex` per riflettere i cambiamenti.
+> Quando si creano, si cancellano o si modificano file dei capitoli, è necessario aggiornare il file `thesis.tex` per includere i nuovi file o rimuovere i vecchi.
 
 - `latexmkrc`: file di configurazione per latexmk, lo strumento usato per compilare il documento. Non dovrebbe essere necessario modificare nulla qui.
 - `output.xmpdata`: Contiene i metadati della tesi, come titolo, autore, parole chiave ecc. Dovete modificarlo in base alla vostra tesi, non accetta le variabili definite in `config/variables.tex`.

thesis/README.md

@@ -45,7 +45,7 @@ \section{Organizzazione del testo}
 Riguardo la stesura del testo, relativamente al documento sono state adottate le seguenti convenzioni tipografiche:
 \begin{itemize}
 	\item gli acronimi, le abbreviazioni e i termini ambigui o di uso non comune menzionati vengono definiti nel glossario, situato alla fine del presente documento;
-	\item per la prima occorrenza dei termini riportati nel glossario viene utilizzata la seguente nomenclatura: \textit{parola}\glox\gloxspacing;
+	\item per la prima occorrenza dei termini riportati nel glossario viene utilizzata la seguente nomenclatura: \gls{apig};
 	\item i termini in lingua straniera o facenti parti del gergo tecnico sono evidenziati con il carattere \textit{corsivo}.
 \end{itemize}
 

thesis/files/chapters/1_introduction.tex

@@ -10,22 +10,10 @@ \chapter{Verifica e validazione}
 
 \lipsum[1-2]
 
+% Esempio di come importare un file contenente codice
 Lorem ipsum:
 \begin{listing}[H]
-\begin{minted}{python}
-def recur_fibo(n):
-   if n <= 1:
-       return n
-   else:
-       return(recur_fibo(n-1) + recur_fibo(n-2))
-nterms = 10
-if nterms <= 0:
-   print("Plese enter a positive integer")
-else:
-   print("Fibonacci sequence:")
-   for i in range(nterms):
-       print(recur_fibo(i))
-\end{minted}
+\inputminted{python}{code/example.py}
 \caption{Fibonacci recursive}
 \label{listing:py_fibo}
 \end{listing}

thesis/files/chapters/6_verify_validate.tex

@@ -2,27 +2,33 @@ \chapter{Conclusioni}
 \label{chap:conclusioni}
 
 \section{Consuntivo finale}
-Ipsum
+Esempio di aggiunta di un termine con glossario e acronimo:\\
+Lorem \gls{sdk} ispum dolor.
+
+Nel successivo utilizzo, apparirà solo l'acronimo:\\
+Lorem \gls{sdk}.
+
+Nel caso si voglia invece mettere solo il termine per esteso, si può usare:\\
+Lorem \gls{sdkg}.
 
 \section{Raggiungimento degli obiettivi}
-Sit amet
+Esempio di termine con solo acronimo\\
+Lorem \gls{tsa}, ipsum dolor sit amet
+
+termine costruito senza acronimo:
+Lorem \gls{TermineSenzaAcronimo}, ipsum dolor sit amet
 
 \section{Conoscenze acquisite}
+Lorem Ipsum dolor Lorem \gls{api}
 
-For applying a subscripting G:\\
-Lorem \gls{sdkg}\glox ispum dolor.\\
-If the G is followed by a punctuation, such as a "." like in this example, you need to use \textit{gloxspacing}\\
-Lorem \gls{sdk}\glox\gloxspacing.\\
-Otherwise...\\
-Lorem \gls{sdkg}\glox.\\
-The "." is not placed in the correct place.\\
-Lorem Ipsum dolor \gls{sdkg}\glox\gloxspacing, sit amet.\\
-Lorem \gls{apig}
+Lorem Ipsum dolor Lorem \gls{apig}
+
+Si può consultare il file \textit{glossary\_acronyms.tex} per alcuni esempi.
 
 \section{Valutazione personale}
-Lorem \gls{umlg}\glox\gloxspacing, ipsum dolor sit amet
+
 
 \section{Valutazione personale}
-Lorem Ipsum dolor Lorem \gls{sdk}
+
 
 \newpage

thesis/files/chapters/7_conclusions.tex

@@ -0,0 +1,12 @@
+def recur_fibo(n):
+   if n <= 1:
+       return n
+   else:
+       return(recur_fibo(n-1) + recur_fibo(n-2))
+nterms = 10
+if nterms <= 0:
+   print("Plese enter a positive integer")
+else:
+   print("Fibonacci sequence:")
+   for i in range(nterms):
+       print(recur_fibo(i))

thesis/files/code/example.py

@@ -30,8 +30,9 @@
 \usepackage{lipsum}
 \usepackage{setspace}
 \usepackage{titlesec}
-\usepackage{minted} % https://it.overleaf.com/learn/latex/Code_Highlighting_with_minted
+\usepackage[cachedir=minted-caches]{minted} % https://it.overleaf.com/learn/latex/Code_Highlighting_with_minted
 \usepackage{xcolor}
 \usepackage{csquotes} % gestisce automaticamente i caratteri (")
 \usepackage{etoolbox}
 \usepackage[bottom]{footmisc}
+\usepackage{zref-totpages}

thesis/files/config/packages.tex

@@ -5,14 +5,16 @@
 % Define custom colors
 \definecolor{hyperColor}{HTML}{0B3EE3}
 \definecolor{tableGray}{HTML}{F5F5F7}
+\definecolor{veryPeri}{HTML}{6667ab}
 
 % Set line height
 \linespread{1.5}
 
 % Custom hyphenation rules
 \hyphenation {
-    e-sem-pio
-    ex-am-ple
+    data-base
+    al-go-rithms
+    soft-ware
 }
 
 % Images path
@@ -29,10 +31,7 @@
 \addtolength{\topmargin}{-2.45pt}
 
 % Add a subscript G to a glossary entry
-\newcommand{\glox}{\textsubscript{\textbf{\textit{G }}}}
-
-% If the subscript G is followed by a punctuation character, or anything else, you need to use \gloxspacing to prevent rendering issues, where the characters collide. Example in Chapter 7
-\newcommand{\gloxspacing}{\hspace{-0.3em}}
+\newcommand{\glox}{\textsubscript{\textbf{\textit{G}}}}
 
 % Improvements the paragraph command
 \titleformat{\paragraph}
@@ -96,13 +95,25 @@
 \endgroup
 }
 
+% Adds a blank page while increasing the page number
+\newcommand\blankpagewithnumber{ 
+  \clearpage
+  \thispagestyle{plain} % Use plain page style to keep the page number
+  \null
+  \clearpage
+}
+
 % Increase page numbering
 \newcommand\increasepagenumbering{
     \addtocounter{page}{+1}
 }
 
 % Make glossaries and bibliography
 \makeglossaries
+% Redefine the format for the glossary entries to be italic
+\renewcommand*{\glstextformat}[1]{\textit{#1}\glox}
+%\glsaddall
+
 \bibliography{references/bibliography}
 \defbibheading{bibliography} {
     \cleardoublepage
@@ -155,4 +166,15 @@
     font=small,
     format=hang,
     labelfont=bf
-}
+}
+
+% When draft mode is on, the hyperlinks are removed. Useful when printing the document. To enable/disable, uncomment/comment the command
+% \hypersetup{draft}
+
+% prevents cleaning up the cache at the end of the run (needed to keep the unused caches, generated by other editions)
+\makeatletter
+\renewcommand*{\minted@cleancache}{}
+\makeatother
+
+% Break lines in code blocks whe using inputminted
+\setminted{breaklines}

thesis/files/config/thesis_config.tex

@@ -2,13 +2,14 @@
 \newacronym{api}{API}{Application Program Interface}
 \newacronym{sdk}{SDK}{Software Development Kit}
 \newacronym{uml}{UML}{Unified Modeling Language}
+\newacronym{tsa}{TSA}{Termine solo acronimo}
 
 % Glossary
 \newglossaryentry{apig}{
     name={API},
     text={Application Program Interface},
     sort=api,
-    description={In computer science, an API is a set of procedures available to programmers, typically grouped to form a toolkit for a specific task within a program. Its purpose is to provide an abstraction, usually between hardware and the programmer or between low-level and high-level software, simplifying the programming process}
+    description={In informatics, an API is a set of procedures available to programmers, typically grouped to form a toolkit for a specific task within a program. Its purpose is to provide an abstraction, usually between hardware and the programmer or between low-level and high-level software, simplifying the programming process}
 }
 
 \newglossaryentry{sdkg}{