Skip to content

Latest commit

 

History

History
205 lines (149 loc) · 4.05 KB

README.md

File metadata and controls

205 lines (149 loc) · 4.05 KB
Raw

Teltow LaTex Package

A LaTeX package for creating IHK(Industrie- und Handelskammer) conform project documentation. created by students for students.

created: 19. Mar 2024

last updated: 25. Apr 2024

Installation

Download the package via IT-Server or GitHub

IT-Server (IP: 10.10.210.10)

  1. Download the package

    click on the file you want to download it should download automaticlly

  2. Put the package in your project folder so that you can find it easily. as example:

    copy teltowPack.sty [projectRoot]/packages/teltowPack.sty

GitHub

  1. Clone the repository

    git clone https://github.com/itCarl/osz-technik-teltow.git

  2. Put the package in your project folder so that you can find it easily. as example:

    copy teltowPack.sty [projectRoot]/packages/teltowPack.sty

Usage

Just include the package on top of your main LaTeX document as you would with any other package via:

... other Packages
\usepackage[ihkPotsdam, timeNotesPage, tocSettings, headerAndFooter]{../packages/teltowPack}
...
...
\begin{document}

Fill the title page with your data and show it as the first page.

...
... packages, setup, etc.
...

% parameters you can change
\setThemeColor[... HTML Hexcode]
\isExamInSummer[... boolean]
\setAuthor[...string, ...string]
\setLoginDetails[...string]
\setSpecialization[...string]
\setCompanyName[...string]
\setSupervisorName[...string]
\setSupervisorEmail[...string]
\setSupervisorTelefon[...string]
\setProjectTitle[...string]
\setCompanyLogo[...path]
% per page header
\setHeaderLogoPosition[2.8]
\setHeaderLogoSize[2.75cm]


\begin{document}

% include title page
\makeIHKTitlePage\

% include time note page
\makeTimeNotesPage{
    \entry{...datum}{...text}{...number}
    \entry{01.02.2069}{Implementirung der Geschäftislogik)}{3}
    ...
    ..
}
...
... your documentation
... 
\begin{document}

enjoy   \(＾－＾)/

Example usage

under /example you can see a full documentation example

Themeing

% IHK logo colors. We recommend to set this to your companys main color
% dark blue  => #003366 (default)
% light blue => #ccd7e6
\setThemeColor[HTML Hexcode]
\setThemeColor[003366] % dark blue (default)
\setThemeColor[ccd7e6] % light blue

Summer or Winter exam

% 
\isExamInSummer[true]  % (default) => Sommerprüfung 20xx
\isExamInSummer[false] % => Winterprüfung 20xx

Author

\setAuthor[lastname, firstname]
\setAuthor[Mewes, Maximilian]

Login (Login to the online portal)

\setLoginDetails[your online id]
\setLoginDetails[ID-24z5n2fxasdf]

Specialization

\setSpecialization[Ausbildungsberuf / Fachrichtung]
\setSpecialization[Fachinformatiker für Anwendungsentwicklung]

Company name

\setCompanyName[company name]
\setCompanyName[Bug Guardians GmbH \& Co. KG]

Supervisor name

\setSupervisorName[supervisor name]
\setSupervisorName[Hanno Nym]

Supervisor Email

\setSupervisorEmail[supervisor email]
\setSupervisorEmail[nym.hanno@bug.guardians.de]

Supervisor Telefon

\setSupervisorTelefon[supervisor telefon]
\setSupervisorTelefon[03328 35070]

Projectname

\setProjectTitle[The same as on your project application]
\setProjectTitle[Implementierung einer Desktopanwendung zur Verarbeitung und Verwaltung von Übertragungswerten]

Company logo

\setCompanyLogo[path to your company logo]

example project document structure:
project-documentation
├ assets
│   ├ ... other files
│   └ company-logo.png <<<<<
├ documentation
│   ├ ... [.pdf, .aux, .out, etc.]
│   └ project-documentation.tex
└ packages
    ├ ... other packages
    └ teltoPack.sty <<<<<

\setCompanyLogo[../assets/company-logo.png]

Header Logo

\setHeaderLogoPosition[2.8] % (optional) used to set offset for pixel perfect alignment
\setHeaderLogoSize[2.75cm]

Contributing

when updating the LaTeX package dont forget updating the readme too.