summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/unitn-bimrep/README.md
blob: b1d163f0f08086daad69499a1cade03ab3a858a3 (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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# unitn-bimrep

A LaTeX class for the Bimonthly report for the University of Trento. The class formats the document in order to 
obtain the typical aspect required by the bimonthly report.

## Installation

If you want to use it for now, you have to put `unitn-bimrep.cls` and `unitn-bimrep.jpg` in the same directory
of your main LaTeX file.

## Usage

There are some very simple step to complete a document:

 1. Use `unitn-bimrep` as your `\documentclass`
 1. In the preamble:
     * Define the `\author` (your name)
     * Define the `\advisor` (name of your advisor, or comma separated list of advisors)
     * Define the `\title` (the title of your thesis)
     * Define the `\cycle` (your school cycle)
 3. In your document (exactly in this order):
     1. Insert the `research` (or `research*`) environment
     2. Insert the `school` (or `school*`) environment
     3. Insert the `production` (or `production*`) environment

If one of the above element is missing, the class will raise an error.

### Environments

#### Research

The `research` enviroment should contain a sequence of `\item` that describe your work. Inside the environment you can use directly the `\item` macro,
that is interpreted as in a `itemize`. The environment can also be empty.

If you prefer to write a small paragraph, you should use the `research*` environment instead.

`research` (or in alterntive `research*`) can be used **only once**.

#### School

The `school` enviroment should contain a sequence of `\item` that describe the courses you have attended. Inside the environment you can use directly the `\item` macro,
that it is slightly different with respect to the standard one. This `\item` can take upto 3 arguments:

```latex
\item{Title of the course}{Teacher or Organization}{Duration in hours or ECTS credit}
```

If you prefer to write a small paragraph, you should use the `school*` environment instead.

`school` (or in alterntive `school*`) can be used **only once**, after the `research` environment.

#### Production

The `production` enviroment should contain a sequence of `\item` that describe The course you have attended. Inside the environment you can use directly the `\item` macro,
that it is slightly different with respect to the standard one. This `\item` can take upto 3 arguments:

```latex
\item{List of Authors}{Title of the publication}{More information about the paper}
```

If you prefer to write a small paragraph, you should use the `production*` environment instead. This opens tothe usage of more advanced function, such as list of publication generated by `bibtex`.

`production` (or in alterntive `production*`) can be used **only once**, after the `research` and `school` environments.


### Examples

#### Normal Mode

The code:

```latex
\documentclass{unitn-bimrep}

\author{Student Name Surname}
\title{An awesome thesis for a PhD student}
\advisor{Advisor Name Surname}
\cycle{XXX}

\begin{document}

\begin{research*}
  For my ctivities I usually prefer to write a small paragraph. Since I used the
  \texttt{research*} environment, I cannot use the \texttt{research} after.
\end{research*}

\begin{school}
  \item{Interesting course}{A. Einstein}{20h}
\end{school}

\begin{production}
  \item{Student Name Surname, Advisor Name Surname}{An awesome publication}{Awesome journal (in review)}
\end{production}


\end{document}
```

produces:

![example](examples/example.png?raw=true)

#### With Biblatex

The code:

```latex
\documentclass[bib]{unitn-bimrep}

\addbibresource{ref.bib} % Define here the bibliography file to use

\author{Student Name Surname}
\title{An awesome thesis for a PhD student}
\advisor{Advisor Name Surname}
\cycle{XXX}

\begin{document}

\begin{research*}
  For my ctivities I usually prefer to write a small paragraph. Since I used the
  \texttt{research*} environment, I cannot use the \texttt{research} after.
\end{research*}

\begin{school}
  \item{Interesting course}{A. Einstein}{20h}
\end{school}

\begin{production*}
  \nocite{ref:1,ref:2} % Import the citations with \nocite
  \printbibliography  % and print the bibliography.
\end{production*}

\end{document}
```

produces:

![example](examples/example_bib.png?raw=true)