From d6ad16c43606784f503e4052650df01f3a945325 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 22 Oct 2017 19:55:11 +0000 Subject: unitn-bimrep (22oct17) git-svn-id: svn://tug.org/texlive/trunk@45581 c570f23f-e606-0410-a88d-b1316a301751 --- .../texmf-dist/doc/latex/unitn-bimrep/LICENSE.md | 28 +++++ Master/texmf-dist/doc/latex/unitn-bimrep/README.md | 138 +++++++++++++++++++++ .../texmf-dist/doc/latex/unitn-bimrep/README.pdf | Bin 0 -> 220537 bytes .../texmf-dist/doc/latex/unitn-bimrep/VERSION.md | 1 + .../doc/latex/unitn-bimrep/examples/example.pdf | Bin 0 -> 350978 bytes .../doc/latex/unitn-bimrep/examples/example.png | Bin 0 -> 83122 bytes .../doc/latex/unitn-bimrep/examples/example.tex | 24 ++++ .../latex/unitn-bimrep/examples/example_bib.bib | 17 +++ .../latex/unitn-bimrep/examples/example_bib.pdf | Bin 0 -> 354791 bytes .../latex/unitn-bimrep/examples/example_bib.png | Bin 0 -> 90526 bytes .../latex/unitn-bimrep/examples/example_bib.tex | 26 ++++ 11 files changed, 234 insertions(+) create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/LICENSE.md create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/README.md create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/README.pdf create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/VERSION.md create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.pdf create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.png create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.tex create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.bib create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.pdf create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.png create mode 100644 Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.tex (limited to 'Master/texmf-dist/doc/latex/unitn-bimrep') diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/LICENSE.md b/Master/texmf-dist/doc/latex/unitn-bimrep/LICENSE.md new file mode 100644 index 00000000000..d45367e2789 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unitn-bimrep/LICENSE.md @@ -0,0 +1,28 @@ +**Copyright (c) 2017 - Matteo Ragni, University of Trento** + +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +*** + +University of Trento owns the file unitn-bimrep.jpg, that can be +used only for the compilation of bimonthly reports, through the +class unitn-bimrep.cls, and cannot be used otherwise. diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/README.md b/Master/texmf-dist/doc/latex/unitn-bimrep/README.md new file mode 100644 index 00000000000..b1d163f0f08 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unitn-bimrep/README.md @@ -0,0 +1,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) diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/README.pdf b/Master/texmf-dist/doc/latex/unitn-bimrep/README.pdf new file mode 100644 index 00000000000..5f44482dfb3 Binary files /dev/null and b/Master/texmf-dist/doc/latex/unitn-bimrep/README.pdf differ diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/VERSION.md b/Master/texmf-dist/doc/latex/unitn-bimrep/VERSION.md new file mode 100644 index 00000000000..37f0780c1fa --- /dev/null +++ b/Master/texmf-dist/doc/latex/unitn-bimrep/VERSION.md @@ -0,0 +1 @@ +2017/10/22 diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.pdf b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.pdf new file mode 100644 index 00000000000..4b749f2107c Binary files /dev/null and b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.pdf differ diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.png b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.png new file mode 100644 index 00000000000..a856a38595b Binary files /dev/null and b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.png differ diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.tex b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.tex new file mode 100644 index 00000000000..930f43a5ec6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example.tex @@ -0,0 +1,24 @@ +\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} diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.bib b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.bib new file mode 100644 index 00000000000..a23cb13cce6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.bib @@ -0,0 +1,17 @@ +@article{ref:1, + author = "Albert Einstein", + title = "On the electrodynamics of moving bodies", + journal = "Annalen der Physik", + volume = "322", + number = "10", + pages = "891--921", + year = "1905" +} + +@book{ref:2, + author = "Michel Goossens and Frank Mittelbach and Alexander Samarin", + title = "The \LaTeX\ Companion", + year = "1993", + publisher = "Addison-Wesley", + address = "Reading, Massachusetts" +} diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.pdf b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.pdf new file mode 100644 index 00000000000..37076986ea9 Binary files /dev/null and b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.pdf differ diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.png b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.png new file mode 100644 index 00000000000..a66ae082bcc Binary files /dev/null and b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.png differ diff --git a/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.tex b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.tex new file mode 100644 index 00000000000..fd167aabcd5 --- /dev/null +++ b/Master/texmf-dist/doc/latex/unitn-bimrep/examples/example_bib.tex @@ -0,0 +1,26 @@ +\documentclass[bib]{unitn-bimrep} + +\addbibresource{example_bib.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} -- cgit v1.2.3