NoTeX

A custom LaTeX template for taking notes • v1.4

⚠️ Warning: the template in the `main` and `dev` branches is still being worked on. If you want to use the template, please download the files from the `old` branch

Yeah sure, but what IS NoTeX to begin with?

In this repository I want to publish the template that I use for taking notes during university classes. I will update it from time to time. If you want to see my notes they'll eventually be uploaded in an (maybe) accesible cloud, since I'm not feeling like sharing them at the moment.

The template is under GPL license (until I will find a CC 4.0 license file to replace the GPL one), but it's not excluded that one day I'l write my own license. You are free to use my template, as long as you credit me. It's fine if you want to edit the template, based on your needs, but don't edit a couple lines and then sell it as your own template

File structure
Customization of the project
About the boxes
Time complexity
Special thanks ❤️

1) File structure

How does the template work? In order to answer such question is worth mentioning the file structure. The template is based on this structure here:

├ 📁 assets
│ ├ 📁 images
│ │ └ 📄 ...
│ │
│ ├ 📁 preamble
│ │ ├ 📄 boxes.tex
│ │ ├ 📄 colors.tex
│ │ ├ 📄 custom_commands.tex
│ │ ├ 📄 packages_setups.tex
│ │ ├ 📄 packages.tex
│ │ ├ 📄 preamble_assembler.tex
│ │ ├ 📄 section_styles.tex
│ │ └ 📄 table_of_contents.tex
│ │
│ ├ 📄 macros.tex
│ └ 📄 title.tex
│
├ 📁 chapters
│ ├ 📄 chap0_license.tex
│ ├ 📄 chap1_lorem.tex
│ ├ 📄 chap2_ipsum.tex
│ └ 📄 ...
│
├ 📄 main.tex
└ 📄 NoTeX.pdf

whereas:

📁 assets: is the folder with all the elements that are needed to build the PDF (such as images, packages, settings, etc...):
- 📁 images: is the folder for all the images used in the PDF. It's not necessary to put your images here, but it's highly suggested in order to maintain a clear environment;
- 📁 preamble: it's the folder with all the preamble settings (packages, their settings, the custom boxes, etc...):
  - 📄 boxes.tex: this file contains all the commands for the boxes;
  - 📄 colors.tex: this file contains all the custom colors;
  - 📄 custom_commands.tex: this file contains all the custom commands needed for the packages / their relative settings;
  - 📄 packages_setups.tex: this file contains all the settings for all the packages;
  - 📄 packages.tex: this file queries for all the needed packages;
  - 📄 preamble.assembler.tex: this file connects all the other files in the preamble folder;
  - 📄 section_styles.tex: this file has all the settings relative to the style of the chapter, section and subsection elements;
  - 📄 table_of_contents.tex: this file contains the settings for the table of contents. Heavily inspired by SeniorMars' template;
- 📄 macros.tex: is a file made to store all the macros relative to the document;
- 📄 title.tex: is the file with the first page's code;
📁 chapters: is the folder with all the chapters (the name of the files can also not necessarily be chapXX_lorem_ipsum.tex);
📄 main.tex: is the main file, where all the other files are imported (such as the preamble and the title);
📄 NoTeX.pdf: the output of the main.tex file.

I highly suggest you to make a file for each chapter (the class of the document is report, so the \chapter command can be used) and then include it into the main.tex. An example of a simple project structure could be:

> ./chapters/chap21_whatever.tex:

\chapter{NoTeX is nice}

\noindent In this chapter we are going to show how NoTeX
is a nice template [...] so now we can conclude by saying
that we should all use it. Thanks for coming to my TEDx talk

> ./main.tex:

\document[12pt, letterpaper]{report}

% Assume that here we import preamble_assembler.tex, title.tex and macros.tex

\begin{document}

% Assume that here we place the table of contents and the title.
% From the next line we'll import all the chapters

% [...]

\input{chapters/chap21_whatever.tex}
\pagebreak

\input{chapters/chap22_secretChap.tex}
\pagebreak

\input{chapters/appendix.tex}

\end{document}

The structure that I suggest you to follow is to first include a file with the \input command, then use a \pagebreak to format it evenly. Little tip: suppose that appendix.tex is our last chapter: notice how there is no \pagebreak: this is because otherwise we would have a blank page at the end. I suggest you to break between each chapter in the main.tex file just to keep everything in order and have a better overview of the project.

2) Customization of the project

In order to customize the project you have to edit the files inside the preamble folder. The folder contains multiple files:

the packages file;
the colors file;
the packages_setups file, related to the packages' settings;
the section_styles file, with all the commands relative to the Chapter, Section and Subsection elements;
the boxes file, which contains all the commands used to generate the boxes;
the custom_commands file, where all the custom commands needed for the packages' settings are stored;
the table_of_contents file, with the table of contents' commands;

If you aim to change the main color of the file, just edit the doc color in the colors.tex file. A large number of elements depend on such color, like the Table of Contents, the Chapters' first page, or the question custom box.

Further customization can be done by editing the macros.tex file, where all the macros (and custom commands) are stored, and the title.tex file, which handles the title page of the document. The structure itself of the project is pretty self-explanatory.

3) About the boxes

You can see that in the file there are 2 types of boxes: theory boxes and practice boxes. The theory boxes are recognisable by the blue line on the left of the boxes, while the practice boxes have a yellow line. Remark and Curiosity boxes are "special", so they have their own colors. The Question box uses the main document's color (doc). Here is a list of all the boxes officially working:

Box cathegory	Box name	Relative code	Notes
Theory	Definition	\begin{definition}{customName} [...] \end{definition}
	Theorem	\begin{theorem}{customName} [...] \end{theorem}
	Corollary	\begin{corollary}{customName} [...] \end{corollary}
	Lemma	\begin{lemma}{customName} [...] \end{lemma}
	Proof	\begin{proof} [...] \end{proof}	Must be used straight after another Theory box. An example can be found at the end of this section
Practice	Example	\begin{example}{customName} [...] \end{example}
	Exercise	\begin{exercise}{customName} [...] \end{exercise}
	Solution	\begin{solution} [...] \end{solution}	Similarly to the proof box, it must be used after a Practice box
Remark	Remark	\begin{remark}{customName} [...] \end{remark}
Curiosity	Curiosity	\begin{curiosity}{customName} [...] \end{curiosity}
Question	Question	\begin{question} [...] \end{question}

Two examples for using both the proof and the solution boxes:

% About the proof box

\begin{theorem}{MyTheorem}
  This is a theorem.
  \\    % <-- Remember to make a new line
\end{theorem}
\begin{proof}{theorem}
  This is the proof of the theorem
\end{proof}

% About the solution box

\begin{exercise}{MyTheorem}
  Let us consider this integral:
  \[ \int_{-2}^0 x^2 \; \dd x \]
  \\    % <-- Remember to make a new line
\end{exercise}
\begin{solution}{exercise}
  The solution is a specific \textbf{real} number $a \in \mathbb{R}$
\end{solution}

4) Time complexity

How well does NoTeX perform? It depends on the compiler and on the compile settings that you use. I'm providing here some benchmarks made on my computers with different OSs, and I'll leave also the specs for further comparison:

Examinated element		Linux Mint	macOs
HW/SW Specs	OS Version	Linux Mint 21.2	macOs Monterey
	CPU	Intel i7-4770 @ 3.9 GHz	N/A
	RAM	16GB DDR3	8GB DDR3
Compiler tectonic	Command used	`tectonic main.tex -Z continue-on-errors`
Compiler tectonic	Time needed (on average)	~23s	~40s

5) Special Thanks ❤️

I'd like to thank SeniorMars for both his repository and his video over the way he takes notes with LaTeX, which inspired me to build my own template and taking notes with it. Oh btw, you should thank Daniel Falbo too, since if he didn't ask me "Hey, why don't you upload your notes on GitHub?" then all this material won't be here.

If you want to contribute to the template, just feel free to do so! It's not guaranteed that your contribution will be implemented, but it could be worth a shot!

ElBi21/NoTeX

NoTeX

⚠️ Warning: the template in the `main` and `dev` branches is still being worked on. If you want to use the template, please download the files from the `old` branch

Yeah sure, but what IS NoTeX to begin with?

Table of contents

1) File structure

2) Customization of the project

3) About the boxes

4) Time complexity

5) Special Thanks ❤️

ElBi21/NoTeX

NoTeX

⚠️ Warning: the template in the main and dev branches is still being worked on. If you want to use the template, please download the files from the old branch

Yeah sure, but what IS NoTeX to begin with?

Table of contents

1) File structure

2) Customization of the project

3) About the boxes

4) Time complexity

5) Special Thanks ❤️

⚠️ Warning: the template in the `main` and `dev` branches is still being worked on. If you want to use the template, please download the files from the `old` branch