Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/egel/pou-latex-assignment-class

LaTeX assignment class created for students of Polish Open University.
https://github.com/egel/pou-latex-assignment-class

Last synced: 5 days ago
JSON representation

LaTeX assignment class created for students of Polish Open University.

Awesome Lists containing this project

README 

        
# POU LaTeX Assignment Class

[![MIT License](http://img.shields.io/badge/license-MIT-yellowgreen.svg)](https://github.com/egel/uek-latex-thesis-class/blob/master/LICENSE)



LaTeX class for short/long assignments created for students of Polish Open University.



* * *

[Installation](#installation) | [Class options](#class-options) | [Live example](https://www.sharelatex.com/project/548b548ddbb91e9c7f2351d6) | [License](#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



1. [Sugested Text Editor](#sugested-text-editor)

2. [Install neccesary libraries like: TeXLive or MikTeX](#installation-of-texlive-or-miktex)

3. [Copy repository to your hard drive](#copy-this-repository-to-your-hard-drive)

4. [Compile document](#compile-whole-document-using-uekthesis-class)

5. [Become a LaTeX Ninja!](#become-a-latex-ninja)



### Sugested Text Editor

For editing TeX/LaTeX files (`.tex`) I definately recommend [TeX Studio Editor](http://texstudio.sourceforge.net/) 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)](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](https://www.debian.org/) like: (ex: [Ubuntu](http://www.ubuntu.com/), [Mint](http://www.linuxmint.com/), [ElementaryOS](http://elementaryos.org/), 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`](http://biblatex-biber.sourceforge.net/) (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](https://github.com/plk/biber) for further instructions.



##### Windows

You can download [Miktex](http://miktex.org/). 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 [email protected]:egel/pou-latex-assignment-class.git "lib"



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



    git submodule add [email protected]:egel/pou-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](https://github.com/egel/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ń