From 4d2f3009eafee392d9da1d9f1a3659240c9fc02d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerardo=20Marx=20Ch=C3=A1vez-Campos?= Date: Tue, 4 May 2021 14:27:11 +0000 Subject: [PATCH 1/4] Update 'README.md' --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 461b918..5de8fb5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,43 @@ -# The ITMorelia Thesis Class +# The ITMorelia Protocol Class + +The present Redme file shows how to work with and compile the `Protocol-Class` in LaTeX. This class is mainly base in the `Thesis-Class`![](). If you want know what sections should be included and its content visit the **Wiki** of this repository. + +# Repository structure +Below you can see the repository's contents. The repository is made of 27 files and 2 folders. The folder `Chapters` includes each `.tex` file that will be included on your portocol; later you will learn how to included. On the other hand, the folder `FrontBackMatter` folder includes `.tex` files related with common chapters/section required on protocols guides like: *Titlepage, Abstract, Colophon, Dedication, Glossary, and others*; you can include as much as you need. + + + +```bash +. +├── Chapters +│   ├── A01.tex +│   ├── Chapter01.tex +│   ├── Chapter02.tex +│   └── Chapter0A.tex +├── configuration.tex +├── FrontBackMatter +│   ├── Abstract.tex +│   ├── Bibliography.tex +│   ├── Colophon.tex +│   ├── Contents.tex +│   ├── Declaration.tex +│   ├── Dedication.tex +│   ├── Foreword.tex +│   ├── glossary-entries.tex +│   ├── Glossary.tex +│   ├── Resumen.tex +│   ├── Titleback.tex +│   ├── TitlepageIng.tex +│   └── TitlepageMC.tex +├── itm.jpg +├── itmthesis.cls +├── precontent.tex +├── README.md +├── Reference.bib +├── sepLogo.jpg +├── tecnmBW.png +├── thesisStructure.pdf +└── thesisStructure.tex +``` + From 8e544b00411f7359f1938b7b9000b9acc5b5fd70 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerardo=20Marx=20Ch=C3=A1vez-Campos?= Date: Tue, 4 May 2021 15:05:12 +0000 Subject: [PATCH 2/4] Readme outline --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5de8fb5..90b8871 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ The present Redme file shows how to work with and compile the `Protocol-Class` i # Repository structure Below you can see the repository's contents. The repository is made of 27 files and 2 folders. The folder `Chapters` includes each `.tex` file that will be included on your portocol; later you will learn how to included. On the other hand, the folder `FrontBackMatter` folder includes `.tex` files related with common chapters/section required on protocols guides like: *Titlepage, Abstract, Colophon, Dedication, Glossary, and others*; you can include as much as you need. - +In the `root` are files related with the organization and the structure of the **Protocol** (the `thesisStructure.tex` and `precontent.tex` files). Also, in `root` is included the main file that gives the special format to the document (`itmthesis.cls`), and finally the `Reference.bib` file to include a bibliography on your work. ```bash . @@ -41,3 +41,24 @@ Below you can see the repository's contents. The repository is made of 27 files ``` + +# The `thesisStructure` file + +## Chapters + +## Apendix + +## including images + +# The `configuration` file + +# Defined variables + +# Titlepage + +# Glossary + + + +# References + From 51cf31846e32d3e500b1f0d595805134954b13c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerardo=20Marx=20Ch=C3=A1vez-Campos?= Date: Tue, 4 May 2021 23:40:44 +0000 Subject: [PATCH 3/4] Update 'README.md' --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 90b8871..ee1b717 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,43 @@ In the `root` are files related with the organization and the structure of the * # The `thesisStructure` file +The main file in the project is the `thesisStructure.tex` file. + +```Tex +% Engineering, master and phd degree +%PROPOSAL(PROTOCOL) format, April 2021, for the +%**Instituto Tecnológico de Morelia** +\documentclass[listings,drafting,spanish]{itmthesis} %itm thesis class +\input{configuration}% configuration and packages +\input{FrontBackMatter/glossary-entries} +\begin{document} +\pagenumbering{roman} % Roman page numbering +\input{precontent} %Includes titlepage, dedication, Foreword, abstract, publication, acknowledgement +\include{FrontBackMatter/Contents} % Contents, list of figures/tables/listings and acronyms +\pagenumbering{arabic} % Arabic page numbering +%-=-=-=-=-=-=-=-=-=-=-=-=- +% Thesis Main Contents +\include{Chapters/Chapter01} %Introduction +\cleardoublepage +\include{Chapters/Chapter02} %Results +%-=-=-=-=-=-=-=-=-=-=-=-=- +% Apendix + +\appendix + +\include{Chapters/Chapter0A} % Appendix A + +%-=-=-=-=-=-=-=-=-=-=-=-=- +% References +\cleardoublepage +\include{FrontBackMatter/Bibliography} +%-=-=-=-=-=-=-=-=-=-=-=-=- +% Back Matter +\cleardoublepage +\include{FrontBackMatter/Colophon} +%-=-=-=-=-=-=-=-=-=-=-=-=- +\end{document} +``` ## Chapters From 66ddbeeaf3609a666679422e40631ba71349205d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerardo=20Marx=20Ch=C3=A1vez-Campos?= Date: Wed, 5 May 2021 00:27:18 +0000 Subject: [PATCH 4/4] Update the Readme on thesisStructure --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ee1b717..557b123 100644 --- a/README.md +++ b/README.md @@ -40,10 +40,14 @@ In the `root` are files related with the organization and the structure of the * └── thesisStructure.tex ``` +# 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. +From here the document class, for the Protocol, is defined with `\documentclass[]{itmthesis}`, and this file determine the way the PDF file is generated by the options. The options defined are: -# The `thesisStructure` file -The main file in the project is the `thesisStructure.tex` file. +- `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 % Engineering, master and phd degree