swepz/latex-templates

LaTeX Templates for Bachelor's and Master's

This repository provides a suite of LaTeX templates designed with Bachelor's and Master's students in mind. While they are made to cater to the needs of a broad range of students, the templates are particularly tailored for Robotics Engineering students.

Purpose

These templates serve various purposes, such as presentations, self-evaluations, project planning, and thesis writing. While some templates have a specific design focus, they are adaptable and versatile, making them applicable to various academic requirements.

One notable template is the Thesis template, a versatile tool that can be used by students writing a Master's thesis, Licentiate, or Doctoral thesis. These templates are designed to provide a well-structured, professional, and consistent format for academic documents.

Structure

The templates included in this repository are as follows:

• Presentation
• Project-Charter
• Project-Plan
• Proposal
• Self-Evaluation
• Technical-Report
• Thesis

The Self-Evaluation template follows an older examination structure, while the Project-Plan and Project-Charter are designed based on the templates from Författare: Bo Tonnquist. The Proposal template is primarily designed for Master's students but can also be used by Ph.D. students. The Technical-Report template is an adaptation of the default IEEE tran Conference template, but with additional structure. It can be used for preparing publications.

Getting Started

You can clone this repository and begin using the templates straight away. Each folder contains a LaTeX template about its title. Either clone the repository or press "Code" and Download Zip.

• NOTE: If separating a folder like "Thesis" from this repo, copy the .gitignore to the separated folder.

Usage

The templates are prepared as LaTeX files. To use them, open the desired template with any LaTeX editor and replace the placeholder text with your content.

If you prefer an online LaTeX editor, you can upload the templates to Overleaf. Here are the steps to do this:

1. Download the template you want to use from this repository.
2. Go to Overleaf.
3. Create an account or log in if you already have one.
4. Click the New Project button in the top left corner.
5. Choose Upload Project.
6. Select the downloaded template file.
7. Once the upload is completed, you can edit your document.

Please maintain the document's structure while editing and keep the formatting consistent, maintaining a professional appearance.

Prerequisites

Ensure you have a LaTeX distribution installed on your machine. We recommend using TeX Live for Unix/Linux systems, MacTeX for MacOS, and MikTeX for Windows.

If you're using Overleaf, no local LaTeX installation is needed as the platform is entirely web-based.

Contributing

Contributions to enhance these templates are welcome. Please feel free to create a pull request or open an issue if you have suggestions or improvements.

License

These templates are released under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0). This license allows you to remix, adapt, and build upon the material in any medium or format for noncommercial purposes only, and only so long as attribution is given to the creator.

For more information, visit CC BY-NC-SA 4.0.

Acknowledgments

We want to acknowledge the work of Författare: Bo Tonnquist, whose templates have served as a basis for the Project-Plan and Project-Charter templates. The Technical-Report template has also been adapted from the default IEEE tran Conference template. The adjustments have added more structure and made it suitable for publication purposes. Contact For any inquiries or issues, feel free to contact us via GitHub.

latex-templates's Issues

Use of @ in macro names.

When compiling the presentation template with vim-tex i get the following errors.

  1 include.tex|1 error| -> unmatched "beginning of file include.tex" [tex/lacheck]
  2 include.tex|1 error| -> unmatched "beginning of file include.tex" [tex/lacheck]
  3 include.tex|1 error| -> unmatched "beginning of file include.tex" [tex/lacheck]
  4 include.tex|1 error| -> unmatched "beginning of file include.tex" [tex/lacheck]
  5 include.tex|1 error| -> unmatched "beginning of file include.tex" [tex/lacheck]
  6 include.tex|1 error| -> unmatched "beginning of file include.tex" [tex/lacheck]
  7 include.tex|1 error| -> unmatched "beginning of file include.tex" [tex/lacheck]
  8 include.tex|8 error| Do not use @ in LaTeX macro names. "\@title" [tex/lacheck]
  9 include.tex|8 error| Do not use @ in LaTeX macro names. "\@author" [tex/lacheck]
 10 include.tex|67 error| <- unmatched "}" [tex/lacheck]

According to this you should treat all these fragments as a package proper, bundling them up into a sty file and including them with \usepackage

Thesis template - authors & wrapping

1. Authors of each page is broken, it doesn't change, only says "Authors".
2. The line wrap of the references is broken.

Thesis template might not follow IEEEtran standard

The bibliography style (unsrtnat) in the thesis template (main.tex) does not follow the IEEEtran standard.

When using bibtex references straight from google scholar the output is formatted not according to the IEEE standard.
E.g. it spells out the full first name of the author "Yuan Chen", when it is supposed to convert it to "Y. Chen".