@ -41,48 +41,222 @@ In the `root` are files related with the organization and the structure of the *
```
```
# The `thesisStructure` file
# The `thesisStructure` file
The main file in the project is the `thesisStructure.tex` file. The file is mainly divided on four parts: 1)configuration, 2)Front Matter, 3) Main contents, and 4) References and 5)Back Matter.
The main file in the project is the `thesisStructure.tex` file. The file is mainly divided on four parts: 1)Configuration, 2)Front Matter, 3) Main contents, and 4) References and 5)Back Matter.
From here the document class, for the Protocol, is defined with `\documentclass[<options>]{itmthesis}`, and this file determine the way the PDF file is generated by the options. The options defined are:
The file contents is show below and detailed explained on next sections.
- `drafting`: The options prints the date of compilation at the end of each page. Suitable opton to know that the latest version is on review or writing process.
- `listing`: The option loads the `listings` package and configures the compilation to generates a gray scale listings outputs.
- `spanish`: The option enables the babel package to print-out the sectional units on spanish language; otherwise, english will be used.
```Tex
``` tex
% Engineering, master and phd degree
% Engineering, master and phd degree
%PROPOSAL(PROTOCOL) format, April 2021, for the
%PROPOSAL(PROTOCOL) format, April 2021, for the
%**Instituto Tecnológico de Morelia**
%**Instituto Tecnológico de Morelia**
%-=-=-=-=-=-=-=-=-=-=-=-=-
% 1)Configuration:
\documentclass[listings,drafting,spanish]{itmthesis} %itm thesis class
\documentclass[listings,drafting,spanish]{itmthesis} %itm thesis class
\include{FrontBackMatter/Contents} % Contents, list of figures/tables/listings and acronyms
\include{FrontBackMatter/Contents} % Contents, list of figures/tables/listings and acronyms
\pagenumbering{arabic} % Arabic page numbering
\pagenumbering{arabic} % Arabic page numbering
%-=-=-=-=-=-=-=-=-=-=-=-=-
%-=-=-=-=-=-=-=-=-=-=-=-=-
% Thesis Main Contents
% 3) Thesis Main Contents
\include{Chapters/Chapter01} %Introduction
\include{Chapters/Chapter01} %Introduction
\cleardoublepage
\cleardoublepage
\include{Chapters/Chapter02} %Results
\include{Chapters/Chapter02} %Results
%-=-=-=-=-=-=-=-=-=-=-=-=-
%-=-=-=-=-=-=-=-=-=-=-=-=-
% Apendix
% Apendix
\appendix
\appendix
\include{Chapters/Chapter0A} % Appendix A
\include{Chapters/Chapter0A} % Appendix A
%-=-=-=-=-=-=-=-=-=-=-=-=-
%-=-=-=-=-=-=-=-=-=-=-=-=-
% References
% 4) References
\cleardoublepage
\cleardoublepage
\include{FrontBackMatter/Bibliography}
\include{FrontBackMatter/Bibliography}
%-=-=-=-=-=-=-=-=-=-=-=-=-
%-=-=-=-=-=-=-=-=-=-=-=-=-
% Back Matter
% 5) Back Matter
\cleardoublepage
\cleardoublepage
\include{FrontBackMatter/Colophon}
\include{FrontBackMatter/Colophon}
%-=-=-=-=-=-=-=-=-=-=-=-=-
%-=-=-=-=-=-=-=-=-=-=-=-=-
\end{document}
\end{document}
%%% Local Variables:
%%% mode: latex
%%% TeX-master: t
%%% End:
```
## 1) Configuration section ##
### Class' options ###
The code next only refers to the configuration of the `itmthesis` class:
``` tex
% 1)Configuration:
\documentclass[listings,drafting,spanish]{itmthesis} %itm thesis class
\input{configuration}% configuration and packages
\input{FrontBackMatter/glossary-entries}
```
From here the document class, for the Protocol, is defined with `\documentclass[<options>]{itmthesis}`, and this file determine the way the PDF file is generated by the options. The options defined are:
- `drafting`: The options prints the date of compilation at the end of each page. Suitable opton to know that the latest version is on review or writing process.
- `listing`: The option loads the `listings` package and configures the compilation to generates a gray scale listings outputs.
- `spanish`: The option enables the babel package to print-out the sectional units on spanish language; otherwise, english will be used.
### `configuration.tex` file ###
Then, `\input` command is used to include files with `LaTeX` commands. Specifically, the `configuration` file includes all the required packages and its configuration, variable(title, author, university, and so on), and command definitions. The complete code is shown next and sectioned on: 1)Listing configuration, 2)Command and Variable definitions, 3)Short descriptions on Math, 4)Packages, and 5)Text space configuration(indent, interline space, and paragraph space); however, the sections that user should modify are only 2), 4) and 5).
``` tex
%!TeX root=./thesisStructure.tex
%Add here the packages, variables, definitions, environments and specific elements created only for your thesis
% 1 Code listing setup
%------------------
\RequirePackage{listings}
\RequirePackage{xcolor}
\definecolor{gray97}{gray}{0.97}
\definecolor{gray45}{gray}{0.45}
\newcaptionname{spanish}{\lstlistlistingname}{Sección de Códigos}
\renewcommand{\lstlistingname}{Código}
\renewcommand{\lstlistlistingname}{Códigos}
\lstset{ frame=Ltb,
framerule=0pt,
aboveskip=0.2cm,
framextopmargin=3pt,
framexbottommargin=3pt,
framexleftmargin=0.4cm,
framesep=0pt,
rulesep=.4pt,
backgroundcolor=\color{gray97},
rulesepcolor=\color{black},
%
stringstyle=\ttfamily,
showstringspaces = false,
%basicstyle=\small\ttfamily,
%basicstyle=\small,
commentstyle=\color{gray45}\ttfamily,
keywordstyle=\bfseries,
%
numbers=left,
numbersep=15pt,
numberstyle=\tiny,
numberfirstline = false,
breaklines=true,
}
% 2 Commands and variables
% 2.1 Thesis's title page config
%------------------
\newcommand{\myTitle}{Un Título de la Tesis no Muy Complicado y Largo Pero Capaz de Definir Concretamente}
\newcommand{\mySubtitle}{Caso de Estudio a Nivel Maestría}
\newcommand{\myDegree}{Maestría en Ciencias en Ingeniería Electrónica}
Thus, if you require to change the thesis' title modify `\myTitle` definition on section *2.1*. If you need to change your data as an author modify `\myname` on section *2.2*, and the same foe the other options as the reviewing group (*2.3*), and institution (*2.4*).
On the other hand, if you want to add new packages to your Protocol, you can added on the main file; the `thesisStructure.tex` file. However, to maintain a clean code you should add on the `configuration` file, specifically on section *4*.
Finally to set specific values of separation for tabulation, paragraphs or text separation between text(interline), please modify section *5*. Here you can use several measurement units as `em`, `cm` , `in` or lines `2`(just a number). E.g:
