Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/njakob/template-latex

LaTeX template for MSE semester and thesis reports
https://github.com/njakob/template-latex

Last synced: 17 days ago
JSON representation

LaTeX template for MSE semester and thesis reports

Host: GitHub
URL: https://github.com/njakob/template-latex
Owner: njakob
Created: 2013-03-16T14:43:31.000Z (almost 12 years ago)
Default Branch: master
Last Pushed: 2013-10-02T13:52:34.000Z (over 11 years ago)
Last Synced: 2024-12-16T18:29:35.741Z (17 days ago)
Homepage:
Size: 1.96 MB
Stars: 9
Watchers: 4
Forks: 6
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Template-LaTeX

LaTeX template for MSE semester and thesis reports.

## Getting Started

This template provides a LaTeX class which simply replaces and extends the standard directive `report`.

### Without Git

You can simply check out [releases](https://github.com/njakob/template-latex/releases) and download [last zip package](https://github.com/njakob/template-latex/archive/v2.1-package.zip).

*It is recommended that you configure your workspace as shown below, then it will be easy to keep it updated.*

### Clone this Repository

Create a new folder for your report, then run git clone command.

```sh
$ git clone [email protected]:njakob/template-latex.git
```

Then copy an example from `/examples` folder into your workspace.
```sh
$ cp -a template-latex/examples/simple-report/* ./
```

Now you can start to write your report in `thesis.tex`.

### Setup your Own Repository

Create a new folder for your report, and then initialize your repository as usual.

```sh
$ git init
$ git remote add origin
```

Then you can link this template with your repository with git submodule.

```sh
$ git submodule add [email protected]:njakob/template-latex.git ./template-latex
```

This sub-module will work the same way as a normal repository. For example, you can change the version as shown below. More documentation could be found at .

```sh
$ cd ./template-latex
$ git checkout v2.1
$ cd ..
```

Then copy an example from `/examples` folder into your workspace.
```sh
$ cp -a template-latex/examples/simple-report/* ./
```

Now you can start to write your report in `thesis.tex`.

## Options

Different options can be defined for the document class.

### Confidential

Type: `Boolean` Default: False

Place a confidential marker on the first page.

### Lang

Type: `String` Default: `en`
Accept: `fr`, `en`

Language of your document.

### Major

Type: `String` Default: `tin`
Accept: `tic`, `tin`

Define your major, `tic` for *Information and Communication Technologies* or `tin` for *Industrial Technologies*.

### Path

Type: `String`

Path to this document class.

### Type

Type: `String` Default: `thesis`
Accept: `semester`, `thesis`

Define whether it is a semester project or thesis.

## Metadata

Some metadata listed below must be provided to the document class.

### Advisor

Advisor of your project, it is usually the same person as `\professor`.

Example:
```latex
\advisor{Prof. John Doe}
```

### Author

Your full name.

Example:
```latex
\author{Nicolas Jakob}
```

### Contact

Your e-mail address.

Example:
```latex
\contact{[email protected]}
```

### Expert

Name and contact information of your expert(s).

Example:
```latex
\expert{
Prof. John Doe
\institute{HES-SO}
\email{[email protected]}
}
```

### HeadOfMSE

Name of Head of MSE.

Example:
```latex
\headofmse{Fariba Moghaddam Bützberger}
```

### Location

*Optional*

When you are abroad, place the information about the school or institute where you have done your work.

Example:
```latex
\location{
Institute which is aboard
\institute{HES-SO}
}
```

### Title

Title of your report.

Example:
```latex
\title{\LaTeX\ Thesis Template}
```

### Professor

Professor(s) who follow your research.

Example:
```latex
\professor{
Prof. John Doe
\institute{HES-SO}
\email{[email protected]}
\and
Prof. John Doe
\institute{HES-SO}
\email{[email protected]}
}
```

### ProposedBy

Person or company who proposed the subject of your work.

Example:
```latex
\proposedby{
Nicolas Jakob
\institute{HES-SO}
\email{[email protected]}
}
```

### Supervisor

*Optional*

When you are abroad, place information about the person following your research.

Example:
```latex
\supervisor{
Prof. John Doe
\institute{HES-SO}
\email{[email protected]}
}
```

### Version

Keep track of the published version of your document.

Example:
```
\version{Version 1}
```