Skip to content

LaTeX Template for Practical Reports, Project Reports and Bachelor Thesis at the DHBW Mannheim, Faculty of Engineering

License

Notifications You must be signed in to change notification settings

stefreschke/Report-Template

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Internship Report Template for DHBW Mannheim Faculty Technology

This template is in development. It's based on Luca Vazzano's template and it's customized for use at DB Systel (it does not correspond to the DB Cooperate Design).

Please use XeLaTeX or LuaLaTex for building.

Buildstatus

Build Status

Features

  • all formal layout-properties of the document are in accordance to the requirements given by the Technical Faculty of DHBW Mannheim.
  • Titlepages for Internship Reports, Study Reports and Bachelor Thesis in accordance to these requirements included

various Titlepages

  • Fully customizable coloring

Coloring

  • Easy switching between the (default) english and german version of the document

How to Setup and Use

  1. Copy the directory ./userdata/ExampleContent to ./userdata/ and rename it. For example you can call it PraxisT1000 if its your first internship report.
  2. inside ./userdata/usersetup.tex:
    • choose the type of your Report
    • choose your prefered Theme (DB Systel or DB default)
    • choose if you want to use the DB Font (have to be added by yourself - you can find instructions for that below)
    • add the name of your content directory which we copied in step 1
    • choose if you want to write your report in english or german
    • fill out the fields for your informations
  3. places the entries for your bibliography into ./userdata/ <YOUR CONTENT DIRECTORY> /resources/references.bib
  4. place the .tex-files containing your content into ./userdata/ <YOUR CONTENT DIRECTORY> /content and define the structure of your content inside ./userdata/ <YOUR CONTENT DIRECTORY> /content/content.tex
  5. fill your acronyms and custom macros as needed into ./userdata/ <YOUR CONTENT DIRECTORY> /content/acronyms.tex and ./userdata/macros.tex
  6. save your image files into ./userdata/ <YOUR CONTENT DIRECTORY> /resources/images
    • you can then use them easily by just referencing \includegraphics{asdf} if you saved your file at ./resources/images/asdf.png

How to use DB Fonts

The DB Fonts aren't included in this Repository, so you have to add them by yourself.

  1. Create a new directory ./userdata/lib/fonts/db/
  2. Add the font DB Sans as Truetypefont in the Styles:
    • regular: DB_Sans.ttf
    • bold: DB_Sans_Bold.tff
    • italic: DB_Sans_Italic.tff
    • bold italic: DB_Sans_Bold_Italic.tff
  3. Add the font DB Head as Truetypefont in the Styles:
    • regular: DB_Head.ttf
    • black: DB_Head_Black.tff
    • italic: DB_Head_Italic.tff
    • black italic: DB_Head_Black_Italic.tff
  4. Activate DbFont in ./userdata/usersetup.tex by removing the % Symbol in front of DbFont in the usepackage section

Included Custom Elements for Ease of Use

Note: <asdf> inside the general code denotes a placeholder

striped Tables

\begin{stripedacenttable}
    {<caption>}
    {\label{tab:<label>}}
    {<formating>}
    {<Headings-Content>}
    <row definitions>
\end{stripedacenttable}

\begin{stripedtable}
    {<caption>}
    {\label{tab:<label>}}
    {<coloring>}
    {<formating>}
    {<Headings-Content>}
    <row definitions>
\end{stripedtable}
  • needs to be enclosed inside \label to keep the auto-completion functionality of your editor working correctly
  • formating should have the form x^x^x^... where x specifies the alignment for the column
    • possible aligments: l: left-aligned , c: centered , r: right-aligned

Example (with captions):

\begin{stripedacenttable}
    {A plain but nice looking table}
    {\label{tab:ex1}}
    {c^l^l}
    {Quarter & asdf & foobar}
    prev. Year & 42 & 17 \\
    Q1 & -3 & -7 \\
    Q2 & +7 & -1 \\
    Q3 & -4 & +12 \\
    Q4 & +2 & +2 \\
\end{stripedacenttable}

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Ut purus elit, vestibulum ut, placerat ac, adipiscing vitae, felis.

\begin{stripedtable}
    {A colorful, nice looking table}
    {\label{tab:ex1}}
    {Green}
    {c^l^l}
    {Quarter & asdf & foobar}
    prev. Year & 42 & 17 \\
    Q1 & -3 & -7 \\
    Q2 & +7 & -1 \\
    Q3 & -4 & +12 \\
    Q4 & +2 & +2 \\
\end{stripedtable}

Tables

Code Listings

\begin{lstlisting}[
    caption={<description of your program>},
    label={lst:<label>},
    captionpos=b,
    language=<language-name>
]
<your code>
\end{lstlisting}

Example:

\begin{lstlisting}[
    caption={The Classic, realized in Python},
    label={lst:python1},
    captionpos=b,
    language=Python
]
> # classic
>
> hi = "Hello Wolrd"
print(hi)
\end{lstlisting}

Code Lisitng

Fancy Symbols

The FontAwesome Package is bundeled into this repository, so you can use all the nice symbols..

Example:

\faFileTextO{} \faStar{}\faStar{}\faStar{}\faStar{}\faStar{} $=$ \faGraduationCap{}

Code Lisitng

The MarVoSym-Package is also loaded to provide additional symbols.

Example:

\Estatically{} \Forward{} \Printer{} \ \ \MVRightArrow{} \ \ \EyesDollar\EyesDollar\EyesDollar

Code Lisitng

Citations in the Footnotes

\footnotecite{<source-reference>}

Mark Incomplete Things You Need To Do

\incompletemarker{<note>}

Code Lisitng

Prevent Pagebreaks absolutely, definitively

\begin{absolutelynopagebreak}
    <content>
\end{absolutelynopagebreak}

Contributing

I'm open for all forks, feedback and Pull Requests ;)

License

This project is licensed under the terms of the GNU General Public License v3.0. For further information, please look here or here(DE).

About

LaTeX Template for Practical Reports, Project Reports and Bachelor Thesis at the DHBW Mannheim, Faculty of Engineering

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TeX 97.0%
  • Shell 3.0%