Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "ipleiria-thesis",
"name": "epfl-thesis",
"image": "mcr.microsoft.com/devcontainers/base:ubuntu",
"features": {
"ghcr.io/prulloac/devcontainer-features/latex:1.3.1": {
Expand Down
1 change: 0 additions & 1 deletion .github/FUNDING.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/latex.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: LaTeX Document Compilation
uses: xu-cheng/latex-action@v3
with:
root_file: IPLeiriaMain.tex
root_file: EPFLMain.tex
latexmk_use_xelatex: true
latexmk_shell_escape: true
extra_fonts: |
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ TSWLatexianTemp*

### Overleaf Bundle Script ###
overleaf-bundle.sh
ipleiria-thesis-overleaf-*.zip
epfl-thesis-overleaf-*.zip

### macOS
.DS_Store
2 changes: 1 addition & 1 deletion .latexmkrc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
$pdf_mode = 5;

# Main TeX file.
$root_filename = 'IPLeiriaMain.tex';
$root_filename = 'EPFLMain.tex';

# Additional flags for the TeX engine.
set_tex_cmds("--shell-escape --synctex=1 --file-line-error --halt-on-error %O %S");
Expand Down
8 changes: 0 additions & 8 deletions Bibliography/Bibliography.bib
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,3 @@ @Article{Elgamal1985
doi = {10.1109/TIT.1985.1057074},
url = {https://ieeexplore.ieee.org/document/1057074},
}

@Misc{IPLeiriaThesis,
author = {{José Areia}},
title = {Polytechnic University of Leiria: LaTeX Thesis Template},
year = {2023},
month = dec,
url = {https://github.com/joseareia/ipleiria-thesis},
}
42 changes: 20 additions & 22 deletions Chapters/01-Introduction.tex
Original file line number Diff line number Diff line change
Expand Up @@ -4,59 +4,57 @@
{
\parindent0pt

\textit{Author: José Areia}
\textit{Template: EPFL Thesis}

\textit{Current Version: 2.2.13}
\textit{Current Version: 1.0.0}

\textit{License: \LaTeX~Project Public License v1.3c}

\textit{Official Repository: \href{https://github.com/joseareia/ipleiria-thesis}{GitHub Repository}}
\textit{Official Repository: \href{https://github.com/pmdlt/epfl-thesis}{GitHub Repository}}

\vspace{.935em}

Welcome to the \textcolor{maincolor}{\textit{IPLeiria Thesis}} template! Thank you for choosing it for your dissertation, report, or project. This template reflects many hours of development, and I hope you enjoy using it as much as I did creating it. This chapter introduces its purpose and helps you get started. See \autoref{cp:user-guide} for a detailed guide, and \autoref{cp:latex-tutorial} for a brief \LaTeX~tutorial to maximise its use.
Welcome to the \textcolor{maincolor}{\textit{EPFL Thesis}} template! Thank you for choosing it for your dissertation, report, or project at the École polytechnique fédérale de Lausanne. This chapter introduces its purpose and helps you get started. See \autoref{cp:user-guide} for a detailed guide, and \autoref{cp:latex-tutorial} for a brief \LaTeX~tutorial to maximise its use.
}

\section{Motivation}
I've been using \LaTeX~since 2020 for a wide range of purposes. Over time, I've reviewed over a hundred templates, and there's always something missing. \textit{Always}. Powerful templates---\textit{i.e.}, highly customisable with many options---are often poorly organised. Well-organised ones usually lack flexibility. Some even compile with errors and warnings. Most importantly, many aren't user-friendly. So, I created my own template for theses and reports, tailored to the Polytechnic University of Leiria. My goals were: \(i)\) clear and structured file organisation, \(ii)\) a clean, professional, and attractive design, \(iii)\) high customisability, and \(iv)\) ease of use, especially for beginners.

This template provides a structured, professional LaTeX foundation for EPFL students writing theses and academic reports. It combines clear file organisation, a clean design aligned with EPFL branding, and flexible class options for language, cover style, and document stage. The goal is to let you focus on your research content rather than document formatting.

\section{Getting Started}
To start using this template, you first need to know how to use \LaTeX. For this, please refer to \autoref{cp:latex-tutorial}. Once you are familiar with \LaTeX, you will need to either install it locally or use an online \LaTeX~editor.

If you prefer an online editor, I highly recommend \href{https://www.overleaf.com/}{Overleaf}. While Overleaf offers a paid subscription for extended compilation time, this template is specifically designed to compile within the limits of the free subscription plan. To use the template in Overleaf, just refer to \href{https://www.overleaf.com/latex/templates/unofficial-polytechnic-university-of-leiria-estg-thesis-slash-report-template/tqgbrncfhwgt}{official template page} and click \textit{Use as Template}. But if you prefer to use a different version of it (which I do not recommend), you can do the following:
If you prefer an online editor, \href{https://www.overleaf.com/}{Overleaf} is a popular choice. To use this template locally:

\begin{enumerate}[font=\itshape]
\setlength{\itemsep}{.375em}
\item \textit{Download the \href{https://github.com/joseareia/ipleiria-thesis/releases}{desired version} from the GitHub repository as a Zip file.}
\item \textit{Login to your Overleaf account.}
\item \textit{In your Project area, click in the menu and then: New Project \(\to\) Upload Project.}
\item \textit{Upload the Zip file.}
\item \textit{Let Overleaf compile the document.}
\item \textit{Clone the \href{https://github.com/pmdlt/epfl-thesis}{repository} from GitHub.}
\item \textit{Install a \LaTeX~distribution (TeX Live, MacTeX, or BasicTeX).}
\item \textit{Edit \texttt{Metadata/Metadata.tex} with your thesis details.}
\item \textit{Build with \texttt{make all} or \texttt{latexmk}.}
\end{enumerate}

If you choose to use a local editor, you must first install \LaTeX~on your machine. For this, there are several options, but I personally recommend either \href{https://www.tug.org/texlive/}{TeX-Live} or \href{https://miktex.org/}{MikTeX}. After installing \LaTeX, you will need to select an editor for writing and editing your documents. To help with this decision, I suggest checking out this helpful \href{https://tex.stackexchange.com/questions/339/latex-editors-ides}{post}, which provides a comprehensive overview of various editors you can use. Once \LaTeX~and your editor are set up, simply clone or download the \href{https://github.com/joseareia/ipleiria-thesis/releases}{latest} version of the template from GitHub and start using it!
If you choose to use a local editor, you must first install \LaTeX~on your machine. I recommend either \href{https://www.tug.org/texlive/}{TeX Live} or \href{https://miktex.org/}{MikTeX}. After installing \LaTeX, select an editor for writing and editing your documents. A helpful overview of editors is available on \href{https://tex.stackexchange.com/questions/339/latex-editors-ides}{TeX Stack Exchange}. Once \LaTeX~and your editor are set up, clone the template from GitHub and start writing.

\begin{block}[tip]
In the official GitHub repository, you'll find a \href{https://github.com/joseareia/ipleiria-thesis/blob/master/Makefile}{Makefile} and a \href{https://github.com/joseareia/ipleiria-thesis/blob/master/.latexmkrc}{Latexmk configuration file}, either of which can be used to compile the project. The Makefile supports both \texttt{rubber} and \texttt{latexmk} as compilers, so you can choose the one that best suits your preferences.
In this repository, you'll find a \href{https://github.com/pmdlt/epfl-thesis/blob/master/Makefile}{Makefile} and a \href{https://github.com/pmdlt/epfl-thesis/blob/master/.latexmkrc}{Latexmk configuration file}, either of which can be used to compile the project. The Makefile supports both \texttt{rubber} and \texttt{latexmk} as compilers.
\end{block}

\section{Getting Help}
As a newcomer, you may encounter situations where you want to do something in \LaTeX~or with this template but aren't sure how. When questions arise, you have several options. First, you can read the wiki available in the \href{https://github.com/joseareia/ipleiria-thesis}{GitHub} repository for this template. Another great option is the \href{https://tex.stackexchange.com/}{TeX Stack Exchange}, an active community that can help with nearly any issue. Of course, Google is always a reliable resource. If all else fails, feel free to contact me directly with any questions about the template. You can reach me at \textit{\textcolor{blue}{\ul{jose.apareia@gmail.com}}}.
As a newcomer, you may encounter situations where you want to do something in \LaTeX~or with this template but aren't sure how. When questions arise, you have several options. The \href{https://tex.stackexchange.com/}{TeX Stack Exchange} is an active community that can help with nearly any issue. The demo chapters in this document also explain how to use the template. Of course, searching online is always a reliable resource.

\subsection{Issues, Feature Request and Suggestions}
If, by any chance, you encounter a bug, have a suggestion, or would like to request a feature, you can submit them via the \textit{Issues} tab in the \href{https://github.com/joseareia/ipleiria-thesis}{GitHub} repository. Please be as descriptive as possible when reporting issues, and make sure to provide the appropriate labels to help me triage them effectively.
\subsection{Issues and Suggestions}
If you encounter a bug or have a suggestion, you can submit them via the \textit{Issues} tab in the \href{https://github.com/pmdlt/epfl-thesis}{GitHub} repository. Please be as descriptive as possible when reporting issues.

For feature requests or suggestions, you can either follow the steps mentioned above or, if you prefer, you can implement the feature yourself and submit a pull request. Both pull requests and pushes trigger a \href{https://github.com/joseareia/ipleiria-thesis/actions/workflows/latex.yml}{GitHub Action} that will automatically compile the document. If the compilation fails, the pull request will be automatically rejected. Please keep this in mind and take care when submitting changes.
Pull requests and pushes trigger a \href{https://github.com/pmdlt/epfl-thesis/actions/workflows/latex.yml}{GitHub Action} that automatically compiles the document. If the compilation fails, the pull request checks will fail. Please keep this in mind when submitting changes.

\subsection{In-Built Comments, Guidance Texts and Warnings}
Within this document template, you may encounter informational text displaying the message ``Writing Guidance.'' These sections are provided solely as guidance to help users understand what content should be included in specific sections. They are not related to the \LaTeX~code itself within this template.

While navigating through the template, especially the configuration files, you will notice that everything is thoroughly commented. \LaTeX~can sometimes be difficult to understand without proper documentation for the packages we are working with. With that in mind, I have made an effort to comment on all the changes I’ve made. Occasionally, I may forget or deem it unnecessary to comment on simpler changes, but more advanced modifications are always accompanied by detailed comments.
While navigating through the template, especially the configuration files, you will notice that everything is thoroughly commented. \LaTeX~can sometimes be difficult to understand without proper documentation for the packages we are working with. With that in mind, advanced modifications are accompanied by detailed comments.

Finally, regarding warnings: please take them into consideration when compiling the document. As you may have noticed, the template is designed to be free of warnings, so please strive to maintain this clean compilation.
Finally, regarding warnings: please take them into consideration when compiling the document. The template is designed to compile cleanly, so please strive to maintain warning-free builds.

\section{Important Notices}
Although this template is specifically tailored for students from all six schools of the Polytechnic University of Leiria, you are welcome to use it if you are from a different institution. It is highly customisable and can be easily modified to suit the needs of other schools. If your school is interested in adopting this as the official template, please contact me first.
This template is tailored for EPFL students writing theses, dissertations, and academic reports. Update the metadata in \texttt{Metadata/Metadata.tex} with your school, department, supervisors, and thesis details before submitting your work.

If you decide to use this template, please consider acknowledging it in your work. To do so, simply cite it using \verb|\citep{IPLeiriaThesis}|. You can also show your appreciation for this template by giving a \href{https://github.com/joseareia/ipleiria-thesis/stargazers}{star} on the GitHub repository. This helps increase its visibility, and you will receive notifications about the latest updates and releases. Either way, acknowledging this work, which involved significant effort and countless hours, would be greatly appreciated.
If you find this template useful, consider giving the \href{https://github.com/pmdlt/epfl-thesis}{repository} a star on GitHub to help others discover it.
Loading
Loading