mirror of
https://github.com/Relintai/elteikthesis.git
synced 2024-11-10 07:42:09 +01:00
Preparing the initial CTAN version of the template.
This commit is contained in:
Máté Cserép
parent
36993f0276
commit
16348af7db
9
LICENSE
9
LICENSE
@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2013-2019 Máté Cserép, Bálint Bognár
|
||||
Copyright (c) 2013-2020 Máté Cserép <mcserep@inf.elte.hu>, 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
|
||||
@ -19,3 +19,10 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
The original 1.x versions of the CTAN package were developed by
|
||||
Dániel Majoros, under the LaTeX Project Public License version 1.2.
|
||||
This updated work is a complete rewrite with no connection
|
||||
to the original package.
|
||||
|
||||
84
README.md
84
README.md
@ -1,61 +1,65 @@
|
||||
See [English version](README_en.md).
|
||||
# ELTE FI bachelor and master thesis template
|
||||
|
||||
# ELTE IK szakdolgozat és diplomamunka sablon
|
||||
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 sufficient modifications the template should be usable at other universities, too.
|
||||
|
||||
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 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.
|
||||
The template contains configuration both for single and double sided printing (see `twoside` option), by default it is set to the recommended single side format.
|
||||
The template supports producing both Hungarian and English theses, which can be easily controlled (see `\documentlang` command).
|
||||
|
||||
A sablon tartalmazza az egy és két oldalas nyomtatáshoz szükséges beállításokat is (ld. `twoside` paraméter), alapértelmezetten a javasolt egy oldalas nyomtatásra konfigurált. (Érdemes figyelembe venni, hogy 20-nál kevesebb lapszám kemény kötésben furcsán mutat, továbbá az ábrák könnyen átütnek az általános 80g/m<sup>2</sup> fénymásolópapíron).
|
||||
A sablon magyar és angol nyelvű dokumentumok elkészítését is támogatja (ld. `\documentlang` parancs).
|
||||
|
||||
## Fordítás
|
||||
## Compilation
|
||||
|
||||
```bash
|
||||
# thesis.aux fájl generálása (PDF fájl még hibás hivatkozásokat fog tartalmazni)
|
||||
# Generate thesis.aux file (PDF file contains incorrect references yet)
|
||||
pdflatex thesis.tex
|
||||
# Irodalomjegyzék generálása
|
||||
# Generate bibliography
|
||||
bibtex thesis
|
||||
# Jelölésjegyzék generálása (ha szükséges)
|
||||
# Generate nomenclature (optional)
|
||||
makeindex -s nomencl.ist -t thesis.nlg -o thesis.nls thesis.nlo
|
||||
# Végleges PDF fájl generálása
|
||||
# Generate final PDF file
|
||||
pdflatex thesis.tex
|
||||
pdflatex thesis.tex
|
||||
```
|
||||
|
||||
**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.
|
||||
**Note:** in case the bibliography changes, executing `bibtex`, then `pdflatex` _twice_ is required to generate to correct references in the PDF output.
|
||||
|
||||
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.
|
||||
Compilation might be carried out through a preferred IDE (e.g. [TexStudio](https://www.texstudio.org/)), given the same commands should be executed.
|
||||
|
||||
## Fontosabb függőségi csomagok
|
||||
## Required packages (without completeness)
|
||||
|
||||
**Képkezelés:**
|
||||
* Minimális és maximális méret: [adjustbox](https://ctan.org/pkg/adjustbox)
|
||||
* Alábrák: [subfigure](https://ctan.org/pkg/subfigure)
|
||||
* Forgatás: [rotating](https://ctan.org/pkg/rotating)
|
||||
**Image handling:**
|
||||
|
||||
**Táblázatkezelés:**
|
||||
* 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 (sortörés): [makecell](https://ctan.org/pkg/makecell)
|
||||
* Minimal and maximal size: [adjustbox](https://ctan.org/pkg/adjustbox)
|
||||
* Subfigures: [subfigure](https://ctan.org/pkg/subfigure)
|
||||
* Rotation: [rotating](https://ctan.org/pkg/rotating)
|
||||
|
||||
**Felsorolások:**
|
||||
* Szoros térközű felsorolások: [paralist](https://ctan.org/pkg/paralist)
|
||||
**Table management:**
|
||||
|
||||
**Matematika és algoritmusok:**
|
||||
* Matematikai formulák: [amsmath](https://ctan.org/pkg/amsmath)
|
||||
* Matematikai definíciók: [amsthm](https://ctan.org/pkg/amsthm)
|
||||
* Matematikai szimbólumok: [amsfonts](https://ctan.org/pkg/amsfonts)
|
||||
* Algoritmusok: [algorithmic](https://ctan.org/pkg/algorithms)
|
||||
* Kódblokkok: [listingsutf8](https://ctan.org/pkg/listingsutf8)
|
||||
* 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)
|
||||
|
||||
**Egyebek:**
|
||||
* Teendők: [todonotes](https://ctan.org/pkg/todonotes)
|
||||
\pagebreak
|
||||
**Lists:**
|
||||
|
||||
## Előre definiált tételszerű bekezdések
|
||||
* Lists with narrow spacing: [paralist](https://ctan.org/pkg/paralist)
|
||||
|
||||
* *definition*: Definíció
|
||||
* *theorem*: Tétel
|
||||
* *remark*: Emlékeztető
|
||||
* *note*: Megjegyzés
|
||||
**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*
|
||||
|
||||
BIN
README.pdf
Normal file
BIN
README.pdf
Normal file
Binary file not shown.
59
README_en.md
59
README_en.md
@ -1,59 +0,0 @@
|
||||
# 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 sufficient modifications the template should be usable at other universities, too.
|
||||
|
||||
The template contains configuration both for single and double sided printing (see `twoside` option), by default it is set to the recommended single side format.
|
||||
The template supports producing both Hungarian and English theses, which can be easily controlled (see `\documentlang` command).
|
||||
|
||||
## Compilation
|
||||
|
||||
```bash
|
||||
# Generate thesis.aux file (PDF file contains incorrect references yet)
|
||||
pdflatex thesis.tex
|
||||
# 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.tex
|
||||
pdflatex thesis.tex
|
||||
```
|
||||
|
||||
**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*
|
||||
64
README_hu.md
Normal file
64
README_hu.md
Normal file
@ -0,0 +1,64 @@
|
||||
# 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 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 tartalmazza az egy és két oldalas nyomtatáshoz szükséges beállításokat is (ld. `twoside` paraméter), alapértelmezetten a javasolt egy oldalas nyomtatásra konfigurált. (Érdemes figyelembe venni, hogy 20-nál kevesebb lapszám kemény kötésben furcsán mutat, továbbá az ábrák könnyen átütnek az általános 80g/m<sup>2</sup> fénymásolópapíron).
|
||||
A sablon magyar és angol nyelvű dokumentumok elkészítését is támogatja (ld. `\documentlang` parancs).
|
||||
|
||||
## Fordítás
|
||||
|
||||
```bash
|
||||
# thesis.aux fájl generálása (PDF fájl még hibás hivatkozásokat fog tartalmazni)
|
||||
pdflatex thesis.tex
|
||||
# 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.tex
|
||||
pdflatex thesis.tex
|
||||
```
|
||||
|
||||
**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)
|
||||
* Alábrák: [subfigure](https://ctan.org/pkg/subfigure)
|
||||
* Forgatás: [rotating](https://ctan.org/pkg/rotating)
|
||||
|
||||
**Táblázatkezelés:**
|
||||
|
||||
* 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 (sortörés): [makecell](https://ctan.org/pkg/makecell)
|
||||
|
||||
**Felsorolások:**
|
||||
|
||||
* Szoros térközű felsorolások: [paralist](https://ctan.org/pkg/paralist)
|
||||
|
||||
**Matematika és algoritmusok:**
|
||||
|
||||
* Matematikai formulák: [amsmath](https://ctan.org/pkg/amsmath)
|
||||
* Matematikai definíciók: [amsthm](https://ctan.org/pkg/amsthm)
|
||||
* Matematikai szimbólumok: [amsfonts](https://ctan.org/pkg/amsfonts)
|
||||
* Algoritmusok: [algorithmic](https://ctan.org/pkg/algorithms)
|
||||
* Kódblokkok: [listingsutf8](https://ctan.org/pkg/listingsutf8)
|
||||
|
||||
**Egyebek:**
|
||||
|
||||
* Teendők: [todonotes](https://ctan.org/pkg/todonotes)
|
||||
|
||||
## Előre definiált tételszerű bekezdések
|
||||
|
||||
* *definition*: Definíció
|
||||
* *theorem*: Tétel
|
||||
* *remark*: Emlékeztető
|
||||
* *note*: Megjegyzés
|
||||
BIN
README_hu.pdf
Normal file
BIN
README_hu.pdf
Normal file
Binary file not shown.
@ -1,7 +1,7 @@
|
||||
%% MIT License
|
||||
%%
|
||||
%% Version 1.3, 2019/06/10
|
||||
%% Copyright (c) 2013-2019 Máté Cserép, Bálint Bognár
|
||||
%% Version 2.0, 2020/02/26
|
||||
%% Copyright (c) 2013-2020 Máté Cserép <mcserep@inf.elte.hu>, 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
|
||||
@ -20,9 +20,16 @@
|
||||
%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
%% OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
%% SOFTWARE.
|
||||
%%
|
||||
%% -----------------------------------------------------------------------------
|
||||
%%
|
||||
%% The original 1.x versions of the CTAN package were developed by
|
||||
%% Dániel Majoros, under the LaTeX Project Public License version 1.2.
|
||||
%% This updated work is a complete rewrite with no connection
|
||||
%% to the original package.
|
||||
|
||||
\NeedsTeXFormat{LaTeX2e}
|
||||
\ProvidesClass{elteikthesis}[2019/06/10 ELTE FI bachelor and master thesis template]
|
||||
\ProvidesClass{elteikthesis}[2020/02/26 ELTE FI bachelor and master thesis template]
|
||||
|
||||
% LaTeX programozói eszközök
|
||||
\RequirePackage{etoolbox}
|
||||
@ -99,8 +106,8 @@
|
||||
\newcommand{\lstcodelabel}{Forráskódjegyzék}
|
||||
\newcommand{\lstnomencl}{Jelölésjegyzék}
|
||||
\newcommand{\todolabel}{Teendők listája}
|
||||
|
||||
\newcommand{\declarationplaceholder}{Az eredeti szakdolgozati / diplomamunka témabjelentő helye.}
|
||||
|
||||
\newcommand{\declarationplaceholder}{Az eredeti szakdolgozati / diplomamunka témabejelentő helye.}
|
||||
}
|
||||
{ % Angol
|
||||
\newcommand{\authorlabel}{Author}
|
||||
@ -108,7 +115,7 @@
|
||||
\newcommand{\intsuplabel}{Internal supervisor}
|
||||
\newcommand{\extsuplabel}{External supervisor}
|
||||
|
||||
\newcommand{\deflabel}{Definiton}
|
||||
\newcommand{\deflabel}{Definition}
|
||||
\newcommand{\theolabel}{Theorem}
|
||||
\newcommand{\remlabel}{Remark}
|
||||
\newcommand{\notelabel}{Note}
|
||||
@ -116,13 +123,13 @@
|
||||
\newcommand{\codelabel}{Code}
|
||||
\newcommand{\alglabel}{Algorithm}
|
||||
|
||||
\newcommand{\biblabel}{Bibliograhpy}
|
||||
\newcommand{\biblabel}{Bibliography}
|
||||
\newcommand{\lstfigurelabel}{List of Figures}
|
||||
\newcommand{\lsttablelabel}{List of Tables}
|
||||
\newcommand{\lstcodelabel}{List of Codes}
|
||||
\newcommand{\lstnomencl}{List of Symbols}
|
||||
\newcommand{\todolabel}{Todo list}
|
||||
|
||||
|
||||
\newcommand{\declarationplaceholder}{This page should be the original Thesis Topic Declaration.}
|
||||
}
|
||||
}
|
||||
@ -516,9 +523,9 @@
|
||||
\thispagestyle{empty}
|
||||
\begin{center}
|
||||
\vspace*{\fill}
|
||||
|
||||
|
||||
{\large \declarationplaceholder}
|
||||
|
||||
|
||||
\vspace*{\fill}
|
||||
\end{center}
|
||||
|
||||
|
||||
BIN
thesis.pdf
BIN
thesis.pdf
Binary file not shown.
@ -9,7 +9,7 @@
|
||||
% Dolgozat metaadatai
|
||||
% Document's metadata
|
||||
\title{Dolgozat címe} % cím / title
|
||||
\date{2019} % védés éve / year of defense
|
||||
\date{2020} % védés éve / year of defense
|
||||
|
||||
% Szerző metaadatai
|
||||
% Author's metadata
|
||||
|
||||
Loading…
Reference in New Issue
Block a user