Lõputöö Generaator

VIKK (Viljandi Kutseõppekeskus) formaadis lõputöö generaator Pandoc ja LaTeX abil. Kirjuta oma lõputöö Markdownis, genereeri PDF ja DOCX automaatselt.

• Markdown → PDF/DOCX - Kirjuta lihtsas Markdown formaadis
• VIKK formaat - Vastab kooli vorminõuetele (Times New Roman, veerised, reavahe)
• Automaatne sisukord - Genereeritakse automaatselt
• Viited ja bibliograafia - BibTeX tugi, autor-aasta viitamisstiil
• Ristiviited - Viita peatükkidele, joonistele ja tabelitele
• Koodiplokkide süntaksi esiletõstmine - Toetab kõiki levinumaid keeli

Paigalda järgmised tööriistad:

# Homebrew abil
brew install pandoc
brew install pandoc-crossref
brew install --cask mactex  # või basictex väiksema versiooni jaoks

sudo apt update
sudo apt install pandoc pandoc-citeproc texlive-xetex texlive-fonts-recommended
# pandoc-crossref tuleb paigaldada eraldi: https://github.com/lierdakil/pandoc-crossref/releases

1. Paigalda Pandoc
2. Paigalda MiKTeX
3. Paigalda pandoc-crossref

Kopeeri see kaust oma projekti kausta:

# Klooni see repo
git clone https://github.com/henno/loputoo-generaator.git

# Kopeeri oma projekti
cp -r loputoo-generaator my-project/docs/loputoo

cd my-project
git submodule add https://github.com/henno/loputoo-generaator.git docs/loputoo

Hoia lõputöö eraldi kaustana oma projekti kõrval:

my-project/
├── src/
├── tests/
└── README.md

my-project-thesis/        # See repo
├── loputoo.md
├── meta.yaml
└── ...

Muuda meta.yaml failis oma lõputöö andmed:

title: "Minu lõputöö pealkiri"
author: "Minu Nimi"
program: "Noorem tarkvaraarendaja"
advisor: "Juhendaja Nimi"
year: "2026"

Muuda loputoo.md faili. Kasuta näidisfaili mallina.

Lisa kasutatud allikad kirjandus.bib faili BibTeX formaadis.

# macOS/Linux
./build.sh

# Windows PowerShell
./build.ps1

Väljundfailid:

• loputoo.pdf - PDF versioon
• loputoo.docx - Word versioon

loputoo-generaator/
├── loputoo.md           # ← SINU LÕPUTÖÖ SISU
├── meta.yaml            # ← SINU METAANDMED
├── kirjandus.bib        # ← SINU ALLIKAD
├── images/              # ← SINU PILDID
│   └── .gitkeep
├── template.tex         # LaTeX mall (tavaliselt ei muuda)
├── style.csl            # Viitamisstiil (tavaliselt ei muuda)
├── filters/
│   └── vikk-structure.lua
├── build.sh             # Ehitusskript (macOS/Linux)
├── build.ps1            # Ehitusskript (Windows)
└── README.md

# Peatükk {#sec:label}           <!-- 1. Peatükk -->
## Alapeatükk                     <!-- 1.1 Alapeatükk -->
### Alampeatükk                   <!-- 1.1.1 Alampeatükk -->

Nummerdamata peatükid (sissejuhatus, kokkuvõte):

# Sissejuhatus {#sec:sissejuhatus}
# Kokkuvõte {#sec:kokkuvote}
# Summary {.unnumbered}

Üks allikas: [@raamat2024]
Mitu allikat: [@allikas1; @allikas2]
Lehekülg: [@raamat2024, lk 15]

![Pildi pealkiri](images/pilt.png){#fig:label width=80%}

Viitamine: vaata @fig:label

| Veerg 1 | Veerg 2 |
|---------|---------|
| Andmed  | 123     |

: Tabeli pealkiri {#tbl:label}

Viitamine: vaata @tbl:label

```javascript
const x = 42
console.log(x)
```

Inline kood: `npm install`

Vaata peatükki @sec:peatukk1
Vaata joonist @fig:diagramm
Vaata tabelit @tbl:andmed

\appendix

# Esimene lisa {#sec:lisa-a}
<!-- Nummerdatakse: Lisa A -->

# Teine lisa {#sec:lisa-b}
<!-- Nummerdatakse: Lisa B -->

XeLaTeX pole PATH-is. Lisa see:

# macOS (TeX Live)
export PATH="/usr/local/texlive/2024/bin/universal-darwin:$PATH"

# Linux
export PATH="/usr/local/texlive/2024/bin/x86_64-linux:$PATH"

Paigalda pandoc-crossref:

• macOS: brew install pandoc-crossref
• Linux: Laadi alla GitHubist

• macOS: Font on tavaliselt olemas
• Linux: sudo apt install ttf-mscorefonts-installer
• Või muuda template.tex failis font

1. Kontrolli, et kirjandus.bib failis on vastav kirje
2. Kontrolli, et võti ühtib: [@minuvõti] → @article{minuvõti, ...}
3. Käivita build uuesti (mõnikord on vaja 2 korda)

See on parandatud template.tex failis \sloppy käsuga bibliograafia jaoks.

Muuda template.tex failis:

\usepackage[a4paper,left=3cm,right=1.5cm,top=2cm,bottom=2cm]{geometry}

Muuda template.tex failis:

\setmainfont{Times New Roman}  % Asenda oma fondiga

Asenda style.csl fail mõne teise CSL stiiliga Zotero Style Repository lehelt.

MIT License - kasuta vabalt oma projektides.