Skip to content

Latest commit

 

History

History
93 lines (57 loc) · 7.44 KB

README.md

File metadata and controls

93 lines (57 loc) · 7.44 KB

UniTeX

UniTeX is a collection of scientific oriented and minimalistic LaTeX templates suitable for many assignment types.

LaTeX Shell Script Overleaf

LICENSE release

Table of contents

Getting started

Configuration

Local LaTeX installation

Todo

Getting started

The simplest way to use UniTeX's templates is by dowloading one from the links below

Template Description See template Download link
Classic Most likely suits longer document style such as lab and internship reports. See default Get classic
Assignment Useful for homework assignments or projects that needs clear split between uncorrelated sections. See default Get assignment
Presentation Beamer presentation style. Very minimalistic. See default Get presentation
RevTeX Two columns LaTeX template for non-official article style. WIP WIP

You can directly use the downloaded within Overleaf by selecting New project > Upload project > Select a .zip file.

To use it locally, UniTeX requires a complete TeX distribution. Most features need external tools such as latexmk that fully automates LaTeX document generation. Latexmk is usually part of TeX distributions like MikTeX and MacTeX but you can always install it separately by following these steps.

Configuration

Every template folder contains a main.tex file in which are inputed configuration files (preamble.sty, style.sty, commands.sty and colors.sty) and the .tex files of the different sections of the project. Here we will describe how you can personnalise the template using the variables in these files.

Classic

  • main.tex: use this file to change the color of the document details by changing the value of MasterColor variable for one listed in colors.sty. Title page variables are also at the beginning of this file.
  • colors.sty: use this file to choose a color for you document! If you want a color that is not listed in the file, add it by yourself using the same format.
  • style.sty: This is where all the modules are imported and briefly commented. Then, the style is defined (TOC setting, headers, references, dimensions, titles and etc.).
  • commands.sty: This is the place to defined your own commands. I put some for math & physics as well as the custom colored boxes.

Assignment

  • main.tex: use this file to change the color of the document details by changing the value of MasterColor and MinorColor (lighter than principal color for the filling of the section box) variables for one listed in colors.sty. Title page variables are also at the beginning of this file.
  • colors.sty: use this file to choose a color for you document! If you want a color that is not listed in the file, add it by yourself using the same format.
  • style.sty: This is where all the modules are imported and briefly commented. Then, the style is defined (TOC setting, headers, references, dimensions, titles and etc.).
  • commands.sty: This is the place to defined your own commands. I put some for math & physics as well as the custom colored boxes.

Presentation

  • premable.sty: Beamer theme and color are defined here. Same for used modules and style settings. I regrouped all of the configuration files in one because of the simplicity of the project.

RevTeX

WIP.

Local LaTeX installation

You can find the most used TeX distributions here. In my experience, TeX Live and MiKTeX are the most reliable and easy to use out-of-the-box.

Latexmk is usually part of TeX distributions like MikTeX and MacTeX but you can always install it separately by following these steps. It is essential if you want to use the Makefiles.

Each UniTeX template contains a Makefile in which are defined very useful commands if you plan to compile the templates locally. For example, using

make

at the root of a template will start a continuous compilation with latexmk and will update itself when you modify any of the project's file. The possible commands are

  • make clean: Cleans the project's folder from garbage files (.bbl, .synctex, .aux, etc.)
  • make dry: Compiles the project but non-contiuously
  • make zip: Compiles the project then build a .zip with it.
  • make targz: Compiles the project then build a .tgz with it.

Todo

  • 'Classic' template
  • 'Homework' template (Overleaf's rebuild)
  • 'RevTeX' template
  • 'Presentation' template from Beamer
  • Rework CLI (make it robust and clean to install)