UEK LaTeX Thesis Class

LaTeX thesis class created for students of Cracow University of Economics.

Installation | Class options | Live DEMO | Learn more on wiki | License

Features

Full Polish fonts support (include listings)
UTF-8 encoding by default
Already implemented The UEK Editorial Recommendations
Modern bibliography management with biblatex and biber
Many class options for easy, personal configuration
Easy to set global variables
Auto-configuration formatting of thesis for male or female
PDF metadata done right
Ready for Windows, Linux and macOS

Download the repository, link the class, compile your document, and have great fun! 🙂

Available options

Available options are separated into 2 parts:

class options - a list of switchers to enable/disable some functionalities of the document.
global variables - a list of global variables to modify document/class options in order to get more adjusted results.

Class options

Example:

\documentclass[male, authorStatement, indexNumber, fileVersion, keywords, thanks]{lib/uekthesis}

General

male or female - sets all general setting (like ex: author statement) to men or women preferences (default value is: male)
twoside - sets type of printing of the document (default value is: oneside)

Front page options

indexNumber - print student's index number; (default value is: off)
This option can be set by \globalIndexNumber variable.
fileVersion - print version of document (default value is: off)
It's usually used only for helping purposes or improvement for repository management like Git. This option is defined in \globalVersion variable.

Second page options

authorStatement - prints author's statement (default value is: off)
This attach to document that author's thesis was made by himself and himself alone.
keywords - print keywords from \globalKeywords variable (default value is: off)

Third page

thanks - print student's thanks phrase; (default value is: off)
Default thanks phrase can be changed by modifying \globalAcknowledgements variable.

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

Global variables

\globalFullAuthor{Jan Kowalski} - Full name of the author
\globalShortAuthor{J. Kowalski} - Short name of the author.
\globalFullTitle{Przygotowanie pracy dyplomowej \\[2mm] wraz z systemem LaTeX} - Full name of the thesis
\globalShortTitle{Praca dyplomowa w systemie \LaTeXe} - Short title of the thesis
\globalFullUniversity{Uniwersytet Ekonomiczny w Krakowie} - Full name of the university
\globalShortUniversity{UEK} - Short name of the University
\globalDepartment{Wydział Zarządzania} - Department
\globalDegreeprogramme{Informatyka Stosowana} - Field of study
\globalThesisType{Praca magisterska} - Type of the thesis
\globalUnderTheSupervisonOf{Pod kierunkiem} - Text before supervisor name
\globalSupervisor{prof. n. dr hab. Jana Iksińskiego} - Full name of your supervisor
\globalAcknowledgements{Dla moich rodziców oraz najbliższych przyjaciół za - niezłomną wiarę w~moje zwycięstwo.} - Acknowledgments text
\globalFileVersion{0.1.0} - File version
\globalIndexNumber{123456} - Number of your index
\globalCity{Kraków} - City of creation
\globalYear{2015} - Year of creation
\globalKeywords{nauka, komputery, praca dyplomowa, latex, uczelnia, student} - Keywords for your document

Install LaTeX

Firstly you need to install LaTeX libraries, and best way it to do it via get LaTeX. Additonally, you may also install a biber package separately.

Linux

For most linux distributions based on Debian like Ubuntu you could install full version of texlive by execute below command in the terminal:

sudo apt-get install texlive-full

apt-get will install a bunch of Tex libraries (>1.5GB). It's a lot and probably contains more libraries than you'll ever use, but the main advantage of this approach is that you probably won't get any errors like "missing package" while you'll be working on your thesis - fewer errors, fewer worries - simple as that.

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

Windows

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

macOS

Download and install the full version of MacTeX and that is pretty much it.

Add document class to your project

You can get the class simply by downloading the latest version.

or using Git you can clone this repository:

without a GitHub account:

git clone https://github.com/egel/uek-latex-thesis-class.git "lib"

with GitHub account:

git clone [email protected]:egel/uek-latex-thesis-class.git "lib"

How to add this class to the document?

You can take a look at this live demo which presents uek-latex-thesis-class in practice.

Compile the document

After downloading the class, then in few formal steps, you can compile your file.

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

All done. Now you can give an easy try to become a very powerful LaTeX Ninja 🥷 High five 🙌

If this looks weird to you, maybe you give it a shot to TeXstudio, the best known to me LaTeX GUI editor (it hasn't got a candy look, but it's the most configurable program of all I've been tried) or if you prefer LUI, choose VIM with latex-suite plugin.

Contribute

Feel free to fork this project and adjust to your needs. Any pull requests also are very welcome 🙇‍♂️

If you have some problems you can leave a question in issues (some a question may be worth asking in front of the public) or drop me a line on maciejsypien at gmail dot com

License

MIT License, 2014 - Maciej Sypień

egel / uek-latex-thesis-class Goto Github PK