Skip to content

An LTU report template utilizing some styling, and allowing you to work with a document in dark theme

Notifications You must be signed in to change notification settings

JosefUtbult/LTU-Report-Template

Repository files navigation

LTU Report Template

An LTU report template based on the LTU SRT Thesis Template

Adding the option to work with a document in dark theme. A custom TODO implementation is also a part of the template, allowing you to write TODOs for your report.

The following are examples of the light and dark themes.

Setup - Manual build

Begin with installing TexLive full.

Ubuntu

sudo apt-get install texlive-full

After that, make sure you can run pdflatex

pdflatex -v

Also, make sure you can run bibtex

bibtex -v

Then, build the project using the build script. Use the --hard flag to make it rebuild everything including the bibliography.

./build --hard

After that you can skip the hard flag if you don't need to change the bibliography.

The resulting PDF should be located in out/report.pdf.

Setup - docker build

Make sure Docker is installed

Ubuntu

sudo apt install -y docker docker-compose

Build the docker image and name it latex. Add you UID and GID to make the image with your own user, resulting in the output from the docker container being owned by you.

sudo UID=$(id -u) GID=$(id -g) docker-compose build

Then, build the project using the docker-build script. Use the --hard flag to make it rebuild everything including the bibliography.

./docker-build --hard

After that you can skip the hard flag if you don't need to change the bibliography.

If you want to run the build command manually, use this.

sudo UID=$(id -u) GID=$(id -g) docker-compose run latex build

Make sure the out directory exists before running the docker image, as this is created as a directory owned by root otherwise.

The resulting PDF should be located in out/report.pdf.

Editing

Your document will begin in the file report.tex. In there you have definitions for title, author and right/left heading. Change all these out for your own.

This document uses a file structure for every section and subsection. I recommend using this style, as it is much easier to navigate through longer documents. Use the input macro in the same way the two example sections are implemented, to include your different files into the report.

This theme uses the IEEEtran bibliography style to apply the references from the file refs.bib. You can find a guide on how to apply this at Overleaf

You have three definitions in the beginning of the file. With DARKMODE enabled, the color scheme of the document changes to dark mode.

With HIGHRES enabled, a higher resolution LTU logo is used. This takes a second longer to compile and should therefore be used when submitting the report, and not when writing it.

With TODOLIST enabled, a list of TODOs will be appended to your document after the abstract.

You can enable/disable these modes by commenting and uncommenting the lines.

\def\DARKMODE{}

\def\HIGHRES{}

\def\TODOLIST{}

You can use the tag \todo to get a list of TODOs for your document. With TODOLIST enabled these will show up as a list.

About

An LTU report template utilizing some styling, and allowing you to work with a document in dark theme

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published