summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/lectures/README.md
blob: 5d515b8aaa7d964c7fdf0d5d63ba5f7af03f1fc3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# lectures
A LaTeX documentclass for lecture notes.

## Usage
### Including the document class
You can include the document class `lectures` as follows:

```latex
\documentclass{lectures}
```

To specify a particular language (currently supported just *italian* and *english*) you can do the following:

```latex
\documentclass[italian]{lectures}
```

### Title page
One of the main features of the library is the provided title page. You can create it as follows:
```latex
\documentclass{lectures}
\begin{document}
    \maketitle{
      Your title
    }{
      First author name,Second author name
    }{
      First professor name,Second professor name
    }{
      Parlo Parloni,Parletti Parini
    }{
      Year
    }{
      CFU of the course
    }{
      Informatica
    }{
      University name
    }{
      Country
    }

\end{document}
```

## Features

### Silenced useless warnings
Using the package [`silence`](https://ctan.org/pkg/silence?lang=en) the library silences the following warnings:

- **latex**
    -  You have requested package
    -  There were undefined references
    -  Command
- **latexfont**
    -  Size substitutions with differences
    -  Font shape
- **biblatex** 
    -  Using fall-back BibTeX(8)
    -  Please (re)run BibTeX on the file(s)
-  **auxhook**
    - Cannot patch  
- **glossaries** 
    - No \printglossary or \printglossaries found.

### Float related gimmicks
All floating objects are automatically centered and set to `H` as position with other objects.

### Table related gimmicks
#### L
A new column type is given `L`, that allows for automatic mathmode in column.

TODO: Add usage example!

### Theorems related gimmicks
All theorems are in `definition` style, meaning that they are not in *italic*.

Proofs are treated as theorem environments.

The following theorem-like environments are provided: 
- theorem
- corollary
- lemma
- proposition
- observation
- definition
- complexity
- property
- problem
- proof

### Lists related gimmicks
- Lists are built to be more compact and leave less blank space.
- Using the environment `todolist` it is possible to create checklists.

TODO: Add todolist example.

### Additional gimmicks
- When a page is empty, Latex won't generate page number or other page elements.
- When you want to leave a blank line you can just leave a blank line, without adding `\\`.
- If you'd like to use roman numerals there a command for that: `\rom{your number goes here}`.