mirror of
https://github.com/Relintai/elteikthesis.git
synced 2024-11-17 07:47:18 +01:00
Merge remote-tracking branch 'origin/ctan'
# Conflicts: # .github/workflows/ci.yml # README.md # README_en.md # elteikthesis.cls # elteikthesis.tex # samples_en/impl.tex # thesis_hu.pdf
This commit is contained in:
Máté Cserép
commit
08f589a831
9
LICENSE
9
LICENSE
@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2013-2021 Máté Cserép <mcserep@inf.elte.hu>, Bálint Bognár
|
||||
Copyright (c) 2013-2022 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 or later.
|
||||
This updated work is a complete rewrite with no connection
|
||||
to the original package.
|
||||
|
||||
98
README.md
98
README.md
@ -1,73 +1,75 @@
|
||||
|
||||
[](https://github.com/mcserep/elteikthesis/actions/workflows/ci.yml)
|
||||
|
||||
See [English version](README_en.md).
|
||||
See [Hungarian version](README_hu.md).
|
||||
|
||||
# ELTE IK szakdolgozat és diplomamunka sablon
|
||||
# ELTE FI bachelor and master thesis template
|
||||
|
||||
A [thesis_hu.tex](thesis_hu.tex) és a belőle előálló [thesis_hu.pdf](thesis_hu.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 [elteikthesis_en.tex](elteikthesis_en.tex) and the produced [elteikthesis_en.pdf](elteikthesis_en.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 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).
|
||||
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).
|
||||
|
||||
## Fordítás
|
||||
## Compilation
|
||||
|
||||
```bash
|
||||
# thesis_hu.aux fájl generálása (PDF fájl még hibás hivatkozásokat fog tartalmazni)
|
||||
pdflatex thesis_hu.tex
|
||||
# Irodalomjegyzék generálása
|
||||
bibtex thesis_hu
|
||||
# Jelölésjegyzék generálása (ha szükséges)
|
||||
makeindex -s nomencl.ist -t thesis_hu.nlg -o thesis_hu.nls thesis_hu.nlo
|
||||
# Végleges PDF fájl generálása
|
||||
pdflatex thesis_hu.tex
|
||||
pdflatex thesis_hu.tex
|
||||
# Generate elteikthesis_en.aux file
|
||||
# (PDF file contains incorrect references yet)
|
||||
pdflatex elteikthesis_en.tex
|
||||
# Generate bibliography
|
||||
bibtex elteikthesis_en
|
||||
# Generate nomenclature (optional)
|
||||
makeindex -s nomencl.ist -t elteikthesis_en.nlg \
|
||||
-o elteikthesis_en.nls elteikthesis_en.nlo
|
||||
# Generate final PDF file
|
||||
pdflatex elteikthesis_en.tex
|
||||
pdflatex elteikthesis_en.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.
|
||||
|
||||
## Kódblokkok szintaxis kiemelése
|
||||
## Syntax highlighting of code blocks
|
||||
|
||||
A *minted* csomag támogatott a forráskódok szedésére és szintaxis kiemelésére. Használatához szükséges a Python interpreter és a `Pygments` csomag telepítése.
|
||||
Lásd a `minted-integration.tex` fájlt példaként és ezt a [dokumentációt](https://www.overleaf.com/learn/latex/Code_Highlighting_with_minted).
|
||||
The minted package is also supported for syntax highlighting. For its usage the Python interpreter and the `Pygments` package must be installed as a prerequisite.
|
||||
See the `elteikthesis_minted.tex` file for example and this [documentation](https://www.overleaf.com/learn/latex/Code_Highlighting_with_minted).
|
||||
|
||||
## Fontosabb függőségi csomagok
|
||||
## Required packages (without completeness)
|
||||
|
||||
**Képkezelés:**
|
||||
**Image handling:**
|
||||
|
||||
* Minimális és maximális méret: [adjustbox](https://ctan.org/pkg/adjustbox)
|
||||
* Alábrák: [subcaption](https://ctan.org/pkg/subcaption)
|
||||
* Forgatás: [rotating](https://ctan.org/pkg/rotating)
|
||||
* Minimal and maximal size: [adjustbox](https://ctan.org/pkg/adjustbox)
|
||||
* Subfigures: [subcaption](https://ctan.org/pkg/subcaption)
|
||||
* Rotation: [rotating](https://ctan.org/pkg/rotating)
|
||||
|
||||
**Táblázatkezelés:**
|
||||
**Table management:**
|
||||
|
||||
* 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)
|
||||
* 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)
|
||||
|
||||
**Felsorolások:**
|
||||
**Lists:**
|
||||
|
||||
* Szoros térközű felsorolások: [paralist](https://ctan.org/pkg/paralist)
|
||||
* Lists with narrow spacing: [paralist](https://ctan.org/pkg/paralist)
|
||||
|
||||
**Matematika és algoritmusok:**
|
||||
**Mathematical formulas and algorithms:**
|
||||
|
||||
* 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: [algpseudocode](https://www.ctan.org/pkg/algorithmicx)
|
||||
* Kódblokkok: [listingsutf8](https://ctan.org/pkg/listingsutf8), [minted](https://ctan.org/pkg/minted)
|
||||
* 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: [algpseudocode](https://www.ctan.org/pkg/algorithmicx)
|
||||
* Code blocks: [listingsutf8](https://ctan.org/pkg/listingsutf8), [minted](https://ctan.org/pkg/minted)
|
||||
|
||||
**Egyebek:**
|
||||
**Miscellaneous:**
|
||||
|
||||
* Teendők: [todonotes](https://ctan.org/pkg/todonotes)
|
||||
* Todos: [todonotes](https://ctan.org/pkg/todonotes)
|
||||
|
||||
## Előre definiált tételszerű bekezdések
|
||||
## Predefined theorem-like environments
|
||||
|
||||
* *definition*: Definíció
|
||||
* *theorem*: Tétel
|
||||
* *remark*: Emlékeztető
|
||||
* *note*: Megjegyzés
|
||||
* *definition*
|
||||
* *theorem*
|
||||
* *remark*
|
||||
* *note*
|
||||
|
||||
BIN
README.pdf
Normal file
BIN
README.pdf
Normal file
Binary file not shown.
69
README_en.md
69
README_en.md
@ -1,69 +0,0 @@
|
||||
# ELTE FI bachelor and master thesis template
|
||||
|
||||
The [thesis_en.tex](thesis_en.tex) and the produced [thesis_en.pdf](thesis_en.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_en.aux file (PDF file contains incorrect references yet)
|
||||
pdflatex thesis_en.tex
|
||||
# Generate bibliography
|
||||
bibtex thesis_en
|
||||
# Generate nomenclature (optional)
|
||||
makeindex -s nomencl.ist -t thesis_en.nlg -o thesis_en.nls thesis_en.nlo
|
||||
# Generate final PDF file
|
||||
pdflatex thesis_en.tex
|
||||
pdflatex thesis_en.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.
|
||||
|
||||
## Syntax highlighting of code blocks
|
||||
|
||||
The minted package is also supported for syntax highlighting. For its usage the Python interpreter and the `Pygments` package must be installed as a prerequisite.
|
||||
See the `minted-integration.tex` file for example and this [documentation](https://www.overleaf.com/learn/latex/Code_Highlighting_with_minted).
|
||||
|
||||
## Required packages (without completeness)
|
||||
|
||||
**Image handling:**
|
||||
|
||||
* Minimal and maximal size: [adjustbox](https://ctan.org/pkg/adjustbox)
|
||||
* Subfigures: [subcaption](https://ctan.org/pkg/subcaption)
|
||||
* 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: [algpseudocode](https://www.ctan.org/pkg/algorithmicx)
|
||||
* Code blocks: [listingsutf8](https://ctan.org/pkg/listingsutf8), [minted](https://ctan.org/pkg/minted)
|
||||
|
||||
**Miscellaneous:**
|
||||
|
||||
* Todos: [todonotes](https://ctan.org/pkg/todonotes)
|
||||
|
||||
## Predefined theorem-like environments
|
||||
|
||||
* *definition*
|
||||
* *theorem*
|
||||
* *remark*
|
||||
* *note*
|
||||
71
README_hu.md
Normal file
71
README_hu.md
Normal file
@ -0,0 +1,71 @@
|
||||
# ELTE IK szakdolgozat és diplomamunka sablon
|
||||
|
||||
A [elteikthesis_hu.tex](elteikthesis_hu.tex) és a belőle előálló [elteikthesis_hu.pdf](elteikhesis_hu.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
|
||||
# elteikthesis_hu.aux fájl generálása
|
||||
# (PDF fájl még hibás hivatkozásokat fog tartalmazni)
|
||||
pdflatex elteikthesis_hu.tex
|
||||
# Irodalomjegyzék generálása
|
||||
bibtex elteikthesis_hu
|
||||
# Jelölésjegyzék generálása (ha szükséges)
|
||||
makeindex -s nomencl.ist -t elteikthesis_hu.nlg \
|
||||
-o elteikthesis_hu.nls elteikthesis_hu.nlo
|
||||
# Végleges PDF fájl generálása
|
||||
pdflatex elteikthesis_hu.tex
|
||||
pdflatex elteikthesis_hu.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.
|
||||
|
||||
## Kódblokkok szintaxis kiemelése
|
||||
|
||||
A *minted* csomag támogatott a forráskódok szedésére és szintaxis kiemelésére. Használatához szükséges a Python interpreter és a `Pygments` csomag telepítése.
|
||||
Lásd az `elteikthesis_minted.tex` fájlt példaként és ezt a [dokumentációt](https://www.overleaf.com/learn/latex/Code_Highlighting_with_minted).
|
||||
|
||||
## 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: [subcaption](https://ctan.org/pkg/subcaption)
|
||||
* 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: [algpseudocode](https://www.ctan.org/pkg/algorithmicx)
|
||||
* Kódblokkok: [listingsutf8](https://ctan.org/pkg/listingsutf8), [minted](https://ctan.org/pkg/minted)
|
||||
|
||||
**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 2.2, 2021/09/20
|
||||
%% Copyright (c) 2013-2021 Máté Cserép <mcserep@inf.elte.hu>, Bálint Bognár
|
||||
%% Version 2.3, 2022/04/30
|
||||
%% Copyright (c) 2013-2022 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 or later.
|
||||
%% This updated work is a complete rewrite with no connection
|
||||
%% to the original package.
|
||||
|
||||
\NeedsTeXFormat{LaTeX2e}
|
||||
\ProvidesClass{elteikthesis}[2021/09/20 ELTE FI bachelor and master thesis template]
|
||||
\ProvidesClass{elteikthesis}[2022/04/30 ELTE FI bachelor and master thesis template]
|
||||
|
||||
% LaTeX programming tools
|
||||
\RequirePackage{etoolbox}
|
||||
|
||||
Binary file not shown.
@ -5,7 +5,7 @@
|
||||
%twoside, % Double sided format
|
||||
%draft, % Quicker draft compilation without rendering images
|
||||
%final, % Set final to hide todos
|
||||
]{elteikthesis}[2021/09/20]
|
||||
]{elteikthesis}[2022/04/30]
|
||||
|
||||
% The minted package is also supported for source highlighting
|
||||
% See minted-intregration.tex for example
|
||||
@ -33,7 +33,7 @@
|
||||
\logo{elte_cimer_szines} % logo
|
||||
|
||||
% Add bibliography file
|
||||
\addbibresource{thesis.bib}
|
||||
\addbibresource{elteikthesis.bib}
|
||||
|
||||
% The document
|
||||
\begin{document}
|
||||
Binary file not shown.
@ -5,7 +5,7 @@
|
||||
%twoside, % Double sided format
|
||||
%draft, % Quicker draft compilation without rendering images
|
||||
%final, % Set final to hide todos
|
||||
]{elteikthesis}[2021/09/20]
|
||||
]{elteikthesis}[2022/04/30]
|
||||
|
||||
% The minted package is also supported for source highlighting
|
||||
% See minted-intregration.tex for example
|
||||
@ -33,7 +33,7 @@
|
||||
\logo{elte_cimer_szines} % logo
|
||||
|
||||
% Add bibliography file
|
||||
\addbibresource{thesis.bib}
|
||||
\addbibresource{elteikthesis.bib}
|
||||
|
||||
% The document
|
||||
\begin{document}
|
||||
BIN
elteikthesis_minted.pdf
Normal file
BIN
elteikthesis_minted.pdf
Normal file
Binary file not shown.
@ -1,11 +1,11 @@
|
||||
\documentclass{elteikthesis}[2021/09/20]
|
||||
\documentclass{elteikthesis}[2022/04/30]
|
||||
|
||||
\usepackage[newfloat]{minted}
|
||||
|
||||
\begin{document}
|
||||
\documentlang{magyar}
|
||||
\documentlang{english}
|
||||
|
||||
\chapter{Minted forráskód}
|
||||
\chapter{Minted source code example}
|
||||
\label{ch:chapter}
|
||||
|
||||
\begin{listing}[H]
|
||||
Binary file not shown.
Loading…
Reference in New Issue
Block a user