Extended README. Added English version of README. Updated version num…

…ber to 1.2.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2018 Máté Cserép, Bálint Bognár
+Copyright (c) 2013-2019 Máté Cserép, Bálint Bognár
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,12 +1,32 @@
+See [English version](README_en.md).
+
 # ELTE IK szakdolgozat és diplomamunka sablon
 
 A [thesis.tex](thesis.tex) és a belőle előálló [thesis.pdf](thesis.pdf) szolgál kiindulási példaként.
-A sablon alkalmazza a szakdolgozatra / diplomamunkára vonatkozó formai előírásokat, valamint elkészíti a megadott metaadatok alapján a címlapot.
+A sablon alkalmazza a szakdolgozatra / diplomamunkára vonatkozó formai előírásokat, valamint elkészíti a megadott metaadatok alapján a címlapot. A példa dokumentum tartalmi fejezetei a BSc szakdolgozat tipikus felépítését tükrözik.
 A formai megkötések az ELTE Informatikai Kar szabályzatában rögzítetteknek felelnek meg, de általánosan (a megfelelő módosításokkal) alkalmazható más egyetemek dolgozataihoz is.
 
 A sablon alapértelmezetten a javasolt egy oldalas nyomtatásra konfigurált, de előkészítetten (kikommentelve) tartalmazza a két oldalas nyomtatáshoz szükséges beállításokat. A sablon magyar és angol nyelvű dokumentumok elkészítését támogatja (ld. `\documentlang`).
 
-## Fontosabb kiegészítő csomagok
+## Fordítás
+
+```bash
+# thesis.aux fájl generálása (PDF fájl még hibás hivatkozásokat fog tartalmazni)
+pdflatex thesis.pdf
+# Irodalomjegyzék generálása
+bibtex thesis
+# Jelölésjegyzék generálása (ha szükséges)
+makeindex -s nomencl.ist -t thesis.nlg -o thesis.nls thesis.nlo
+# Végleges PDF fájl generálása
+pdflatex thesis.pdf
+pdflatex thesis.pdf
+```
+
+**Megjegyzés:** az irodalomjegyzék változása esetén a `bibtex`, majd a `pdflatex` _kétszeri_ futtatása szükséges a helyes hivatkozások előállításához.
+
+A fordításhoz tetszőleges fejlesztő környezet is használható (pl. [TexStudio](https://www.texstudio.org/)), ugyanezen utasítások kiadásával.
+
+## Fontosabb függőségi csomagok
 
 **Képkezelés:**
 * Minimális és maximális méret: [adjustbox](https://ctan.org/pkg/adjustbox)
@@ -17,7 +37,7 @@ A sablon alapértelmezetten a javasolt egy oldalas nyomtatásra konfigurált, de
 * Oszlopok és sorok egyesítése: [multirow](https://ctan.org/pkg/multirow)
 * Tördelhető táblázat: [longtable](https://ctan.org/pkg/longtable)
 * Cellatartalom vertikális igazítása: [array](https://ctan.org/pkg/array)
-* Többsoros cellák: [makecell](https://ctan.org/pkg/makecell)
+* Többsoros cellák (sortörés): [makecell](https://ctan.org/pkg/makecell)
 
 **Felsorolások:**
 * Szoros térközű felsorolások: [paralist](https://ctan.org/pkg/paralist)

README_en.md

@@ -0,0 +1,58 @@
+# ELTE FI bachelor and master thesis template
+
+The [thesis.tex](thesis.tex) and the produced [thesis.pdf](thesis.pdf) serves as an example of usage.
+This class template enforces the required formatting rules for bachelor and master theses and generates the cover page given on the provided metadata. The chapters of the example document follows the typical structure of a BSc thesis.
+The formatting rules are defined to meet the requirements for theses submitted at the Eötvös Loránd University, Faculty of Informatics (Budapest, Hungary). However with minor modifications the template should be usable at other universities, too.
+
+The template is configured for single sided printing by default, but also contains the required settings for double sided printing (commented out). The template supports producing both Hungarian and English theses, which can be easily controlled (see `\documentlang`).
+
+## Compilation
+
+```bash
+# Generate thesis.aux file (PDF file contains incorrect references yet)
+pdflatex thesis.pdf
+# Generate bibliography
+bibtex thesis
+# Generate nomenclature (optional)
+makeindex -s nomencl.ist -t thesis.nlg -o thesis.nls thesis.nlo
+# Generate final PDF file
+pdflatex thesis.pdf
+pdflatex thesis.pdf
+```
+
+**Note:** in case the bibliography changes, executing `bibtex`, then `pdflatex` _twice_ is required to generate to correct references in the PDF output.
+
+Compilation might be carried out through a preferred IDE (e.g. [TexStudio](https://www.texstudio.org/)), given the same commands should be executed.
+
+## Required packages (without completeness)
+
+**Image handling:**
+* Minimal and maximal size: [adjustbox](https://ctan.org/pkg/adjustbox)
+* Subfigures: [subfigure](https://ctan.org/pkg/subfigure)
+* Rotation: [rotating](https://ctan.org/pkg/rotating)
+
+**Table management:**
+* Multirow and multicolumn support: [multirow](https://ctan.org/pkg/multirow)
+* Breakable tables: [longtable](https://ctan.org/pkg/longtable)
+* Vertical positioning of cells: [array](https://ctan.org/pkg/array)
+* Multiline cells (line breaks): [makecell](https://ctan.org/pkg/makecell)
+
+**Lists:**
+* Lists with narrow spacing: [paralist](https://ctan.org/pkg/paralist)
+
+**Mathematical formulas and algorithms:**
+* Mathematical formulas: [amsmath](https://ctan.org/pkg/amsmath)
+* Mathematical definitions: [amsthm](https://ctan.org/pkg/amsthm)
+* Mathematical symbols: [amsfonts](https://ctan.org/pkg/amsfonts)
+* Algorithms: [algorithmic](https://ctan.org/pkg/algorithms)
+* Code blocks: [listingsutf8](https://ctan.org/pkg/listingsutf8)
+
+**Miscellaneous:**
+* Todos: [todonotes](https://ctan.org/pkg/todonotes)
+
+## Predefined theorem-like environments
+
+* *definition*
+* *theorem*
+* *remark*
+* *note*

elteikthesis.cls

@@ -1,6 +1,6 @@
 %% MIT License
 %%
-%% Version 1.1, 2019/04/30
+%% Version 1.2, 2019/06/09
 %% Copyright (c) 2013-2019 Máté Cserép, Bálint Bognár
 %%
 %% Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -22,7 +22,7 @@
 %% SOFTWARE.
 
 \NeedsTeXFormat{LaTeX2e}
-\ProvidesClass{elteikthesis}[2019/04/30 ELTE FI bachelor and master thesis template]
+\ProvidesClass{elteikthesis}[2019/06/09 ELTE FI bachelor and master thesis template]
 
 % LaTeX programozói eszközök
 \RequirePackage{etoolbox}
@@ -76,26 +76,26 @@
 % Fordítások
 \DeclareDocumentCommand{\documentlang}{m}{
 	\selectlanguage{#1}
-	
+
 	% Magyar
 	\ifthenelse{\equal{\detokenize{#1}}{\detokenize{magyar}}}
 	{
 		\newcommand{\authorlabel}{Szerző}
 		\newcommand{\suplabel}{Témavezető}
 		\newcommand{\intsuplabel}{Belső témavezető}
 		\newcommand{\extsuplabel}{Külső témavezető}
-		
+
 		\newcommand{\deflabel}{Definíció}
 		\newcommand{\theolabel}{Tétel}
 		\newcommand{\remlabel}{Emlékeztető}
 		\newcommand{\notelabel}{Megjegyzés}
-		
+
 		\newcommand{\codelabel}{forráskód}
 		\newcommand{\alglabel}{Algoritmus}
-		
+
 		\newcommand{\biblabel}{Irodalomjegyzék}
 		\newcommand{\lstfigurelabel}{Ábrajegyzék}
-		\newcommand{\lsttablelabel}{Táblázatjegyzék}		
+		\newcommand{\lsttablelabel}{Táblázatjegyzék}
 		\newcommand{\lstcodelabel}{Forráskódjegyzék}
 		\newcommand{\lstnomencl}{Jelölésjegyzék}
 		\newcommand{\todolabel}{Teendők listája}
@@ -104,19 +104,19 @@
 		\newcommand{\suplabel}{Supervisor}
 		\newcommand{\intsuplabel}{Internal supervisor}
 		\newcommand{\extsuplabel}{External supervisor}
-		
+
 		\newcommand{\deflabel}{Definiton}
 		\newcommand{\theolabel}{Theorem}
 		\newcommand{\remlabel}{Remark}
-		\newcommand{\notelabel}{Note}		
-		
-		\newcommand{\codelabel}{Code}		
+		\newcommand{\notelabel}{Note}
+
+		\newcommand{\codelabel}{Code}
 		\newcommand{\alglabel}{Algorithm}
-		
+
 		\newcommand{\biblabel}{Bibliograhpy}
 		\newcommand{\lstfigurelabel}{List of Figures}
 		\newcommand{\lsttablelabel}{List of Tables}
-		\newcommand{\lstcodelabel}{List of Codes}		
+		\newcommand{\lstcodelabel}{List of Codes}
 		\newcommand{\lstnomencl}{List of Symbols}
 		\newcommand{\todolabel}{Todo list}
 	}
@@ -230,7 +230,7 @@
 		\RequirePackage[skip=0pt]{parskip}
 	}{
 		% alapértelmezés szerint nincs térköz, de van behúzás
-	}	
+	}
 }
 % ------------------------------
 
@@ -325,7 +325,7 @@
 \RequirePackage{array}
 % Sortörés táblázat cellákban
 \RequirePackage{makecell}
-% Táblázatjegyzék elnevezése	
+% Táblázatjegyzék elnevezése
 \renewcommand{\listtablename}{\lsttablelabel}
 % ------------------------------
 
@@ -444,36 +444,36 @@
 % Címlap
 \renewcommand{\maketitle}{
 	\begin{titlepage}
-		
+
 		\begin{center}
-			
+
 			\begin{tabular}{ c c }
 				\multirow{4}{*}{\hspace{-1.0cm}\includegraphics[width=0.25\textwidth]{\logofilename}}
-				
+
 				& {\sc \Large \makecell{\univname}} \vspace{0.3cm}\\
 				& {\sc \Large \makecell{\facname}} \vspace{0.5cm}\\
 				& {\sc \large \makecell{\deptname}}
 			\end{tabular}
-			
+
 			\vspace{5.0cm}
 			{\bf \LARGE \thesistitle}
 			\vspace{4.0cm}
-		
+
 			\ifdefined\extsupaff
 				{\it \large \authorlabel:}\\
 				{\large \authorname}\\
 				\degreename\\
 				\vspace{2.0cm}
-			
+
 				\begin{tabular}{ l c l }
 					{\it \large \intsuplabel:} &
 					\hspace{4.0cm} &
 					{\it \large \extsuplabel:}\\
-					
+
 					{\large \supname} &
 					\hspace{4.0cm} &
 					{\large \extsupname}\\
-					
+
 					\supaff &
 					\hspace{4.0cm} &
 					\extsupaff\\
@@ -484,23 +484,23 @@
 					{\it \large \suplabel:} &
 					\hspace{4.0cm} &
 					{\it \large \authorlabel:}\\
-					
+
 					{\large \supname} &
 					\hspace{4.0cm} &
 					{\large \authorname}\\
-					
+
 					\supaff &
 					\hspace{4.0cm} &
 					\degreename\\
 				\end{tabular}
 			\fi
-			
+
 			\vfill
-			
+
 			{\it \cityname, \thesisyear}
-			
+
 		\end{center}
-		
+
 	\end{titlepage}
 }
 % ------------------------------

thesis.tex

@@ -4,7 +4,7 @@
 	%nohyp, % Szavak sorvégi elválasztásának tiltása / No hypenation of words
 	%twoside, % Kétoldalas nyomtatás
 	%final, % Teendők elrejtése / Set final to hide todos
-]{elteikthesis}[2019/04/30]
+]{elteikthesis}[2019/06/09]
 
 % Dolgozat metaadatai
 % Document's metadata