elteikthesis/README.md

74 lines
3.5 KiB
Markdown
Raw Normal View History

2020-07-24 08:35:32 +02:00
![CI status](https://github.com/mcserep/elteikthesis/workflows/Build%20LaTeX%20document/badge.svg)
See [English version](README_en.md).
2018-06-06 17:54:47 +02:00
# ELTE IK szakdolgozat és diplomamunka sablon
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.
2018-06-07 07:29:49 +02:00
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_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
```
**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.
2021-09-20 15:01:13 +02:00
## 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 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).
2021-09-20 15:01:13 +02:00
## Fontosabb függőségi csomagok
**Képkezelés:**
* Minimális és maximális méret: [adjustbox](https://ctan.org/pkg/adjustbox)
2021-09-20 15:01:13 +02:00
* 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)
2018-06-07 07:29:49 +02:00
**Felsorolások:**
2018-06-07 07:29:49 +02:00
* 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)
2021-09-20 15:01:13 +02:00
* 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)
2018-06-07 07:29:49 +02:00
## Előre definiált tételszerű bekezdések
2018-06-07 07:29:49 +02:00
* *definition*: Definíció
* *theorem*: Tétel
* *remark*: Emlékeztető
* *note*: Megjegyzés