UEK LaTeX Assignment Class

LaTeX class for short and also for long assignments created for students of Cracow University of Economics.

Installation | Class options | Live example | License

Features

Full Polish fonts support (include listings);
UTF-8 encoding by default;
Many class options for easy personal confuguation;
Autoconfiguration for male or female formating of thesis;
Easy to set global variables;
Download repository, compile and have great fun;
Ready for Windows, Linux and Mac OSX Operating Systems;

Class options

Options are Case Sensitive (so there is a difference between indexNumber and indexnumber and IndexNumber)

male or female - sets all general setting (like ex: author's statement) to men or women preferences (default value is: male);
authorStatement - prints author's statement (default value is: off)
This attach to document that author's thesis was made by himself and himself alone.
twoside - sets type of printing of the document (default value is: oneside);
fileVersion - print version of document (default value is: off)
It's usually used only for helping purposes. This option is defined by \globalVersion variable.
indexNumber - print student's index number; (default value is: off)
This option is defined by \globalIndexNumber variable.
thanks - Author's thanks page () (default value is: off)
This option is defined by \globalAcknowledgements variable.

Installation

Sugested Text Editor
Install neccesary libraries like: TeXLive or MikTeX
Copy repository to your hard drive
Compile document
Become a LaTeX Ninja!

Sugested Text Editor

For editing TeX/LaTeX files (.tex) I definately recommend TeX Studio Editor for good start. This program has very clear and intuitive interface with many customization options. Moreover it could be used by LaTeX's ninja and also for those people which just begin the journey with LaTeX. I found in this editor (and also in [Vim] ;)) the best visual good practises of all, while working with LaTeX files.

If you don't like TeXStudio see this article (http://tex.stackexchange.com/questions/339/latex-editors-ides) for more great editors for .tex files.

Installation of TeXLive or MikTeX

Firstly you need to install La(Tex) libraries --- If you have TexLive, MikTeX or similar libraries packages system all ready installed and also biber as well, you can skip this subpoints ;)

Linux

For most linux distributions based on Debian like: (ex: Ubuntu, Mint, ElementaryOS, etc) you could install texlive by run this command in terminal:

sudo apt-get install texlive-full

apt-get program will install whole bunch of Tex libs (~1.5GB). It's a lot of stuff and contains more libs then we'll ever use, but the main advantage of this setp is that you probably won't get any errors like missing common libraries while you'll be writting your thesis --- less errors, less worries - simple as that ;)

Sometimes biber (a BibTeX replacement for users of BibLaTeX) is not include into texlive-full package. In order of fix this, you need to install it by running sudo apt-get install biber into terminal. If you need more up-to-date version of biber, look at its Github repository for further instructions.

Windows

You can download Miktex. It's more-less an equivalent of Texlive libs and it's build specially for Windows systems. On Miktex's website you will find all information you need to use this piece of software.

Copy this repository to your hard drive

Using Git you can clone this repo:

git clone git@github.com:egel/uek-latex-assignment-class.git "lib"

or use gitmodules to add it to your exsisting thesis repository (recommended):

git submodule add git@github.com:egel/uek-latex-assignment-class.git "lib"

Also you can simply use download button ;)

Compile whole document using uekthesis class

How to add this class to document?

You see at my another repo which presents full latex thesis example with using very similar class to this one.

Then compile you file (standard full LaTeX compilation)

$ pdflatex main.tex
$ pdflatex main.tex
$ biber bibliography.tex
$ pdflatex main.tex

Become a LaTeX Ninja

All done :) ...and now you can give a easy try to become a powerful LaTeX Ninja!

License

MIT License - 2014 | Maciej Sypień

egel / uek-latex-assignment-class