UniTeX

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

Table of contents

Overleaf support

Requirements (full installation)

TeX

Shell

PDF viewer

Installation

Unix based OS

Windows

Quick start

Features

Screenshots

Classic

Homework

Presentation

TODO

Overleaf support

Using UniTeX templates inside an Overleaf project is encouraged and pretty simple to setup. Download the .zip file associated with wanted template and upload it inside Overleaf by selecting New project > Upload project > Select a .zip file. To do so, download any template folder using the links:

Classic	Homework	Presentation
Download	Download	Download

then import wanted template directly from Overleaf.

Requirements (full installation)

TeX

UniTeX requires a complete TeX distribution (you can find the most used TeX distributions here). 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.

Shell

A Unix shell is better to install UniTeX properly. Commands such as mkdir, cp, ln and others are used within install script and makefiles so it's important for you to have access to this type of shell to install UniTeX correctly.

PDF viewer

A responsive pdf viewer like Skim, Zathura and SumatraPDF is also a must have when working on LaTeX projects. These are some viewers that provide automatic refresh on file change and this is why they are working very well with latexmk. For example, using Skim on MacOS, the viewer settings offer to check automatically for changes and reload the pdf

Installation

Unix based OS

The ideal way to install UniTeX is via the install script install.sh.

git clone https://github.com/BCarnaval/UniTeX

cd UniTeX && chmod +x install.sh && ./install.sh

By doing it like so, you will be able to use UniTeX's commands (see unitex -h).

Windows

On Windows, install.sh might be not the best way to use UniTeX. I personnally suggest to people in this situation to clone the repository somewhere on their system and use directly template's folder Classic, Article, Homework and Cover. Makefiles should work properly so one can copy Homework template for some homework and, in the same directory, use

make <dry, clean, all, zip, targz>

to work with it.

Quick start

Once installation properly done and unitex -h command outputs no error, you can directly build any UniTeX template

1. Select a directory (folder) in which store template's files to edit later. For the example, we use a folder named test in home directory.

mkdir ~/test

2. Build the template inside previous directory using unitex by specifying the flags -b build: template (classic, article, homework, cover), -d directory: directory in which build it (directory created in step 1.) and -o opt: building options (clean, dry, targz, zip or empty to tell latexmk to continuously compile your project on save).

unitex -b classic -d ~/test -o dry

Here, the dry option means that latexmk will not compile your project continuously and not clean the directory either. It will simply build the template inside the specified directory and leave stallite files there. To clean it, you must use the option clean with the -o flag. These commands being done (dry and clean), you should have the following content inside your test folder

$ ls ~/test
Makefile
PageTitre.tex
colors.sty
commands.sty
figs/
main.pdf
main.tex
refs.bib
sections/
style.sty

3. Assuming that test directory isn't missing any files, you can configure/customize the template to satisfy the nature of your project. Simply open your text editor and remove default values from main.tex, all the files inside sections/ and figs/ directories, references from refs.bib and feel free to add your personnal commands/style features inside commands.sty, style.sty.

Features

IN DEVELOPPEMENT.

Screenshots

Classic

Example from 'classic' template with Yale's darkblue as main color

Default title page	Sections layout

Maths display	References

Homework

Example from 'homework' template with lavender as main color

Default title page	Problem(s) presentation

Basic problem solving	Problem(s) presentation

Presentation

Example from 'presentation' template with light blue as main color

WIP.

TODO

• 'Classic' template
• 'Homework' template (Overleaf's rebuild)
• 'RevTeX' template
• 'Beamer' template
• Install/uninstall scripts
• Version control
• REAME.md
• Add all well explained commands and features
  • Supported colors
  • Supported Universities (emblems + colors)