|
|
# Používateľská dokumentácia pre nástroj IT4KT Builder
|
|
|
|
|
|
## Nový kurz
|
|
|
|
|
|
1. Stiahnite [príklad kurzu](https://sputnik.kpi.fei.tuke.sk/pypi/it4kt-builder/example-course.tar.gz).
|
|
|
2. Upravte konfiguráciu v súbore `it4kt.yml`.
|
|
|
3. Upravujte obsah kurzu v adresári `content`.
|
|
|
4. [Nastavte zverejňovanie](Zverejňovanie).
|
|
|
|
|
|
|
|
|
## Spustenie
|
|
|
|
|
|
Adresár kurzu obsahuje skripty `build.sh` a `build.bat`, ktoré zabezpečujú stiahnutie všetkých potrebných nástrojov a spustenie Buildera. Jedinou závislosťou je [Python verzie ≥3.6](https://www.python.org/downloads/).
|
|
|
|
|
|
Builder a jeho závislosti sú inštalované do podadresára `pyvenv` v adresári kurzu. V prípade problémov so spustením, skúste odstrániť adresár `pyvenv`.
|
|
|
|
|
|
|
|
|
## Štruktúra kurzu
|
|
|
|
|
|
Všetok obsah kurzu sa nachádza v adresári `content`.
|
|
|
|
|
|
Materiály kurzu sú zložené zo stránok, ktoré sú usporiadané do priečinkov. **Priečinok** je zbierkou stránok rovnakého typu a je uložený ako podadresár adresára `content`. Zoznam priečinkov a stránok, nezaradených do priečinkov je uvedený v konfiguračnom súbore `it4kt.yml`. Napríklad
|
|
|
|
|
|
```yaml
|
|
|
pages:
|
|
|
- index.md
|
|
|
- info.xml
|
|
|
type: subject_info
|
|
|
folders:
|
|
|
- path: lectures
|
|
|
title: Prednášky
|
|
|
- path: labs
|
|
|
title: Cvičenia
|
|
|
type: scenario
|
|
|
- path: assignments
|
|
|
title: Zadania
|
|
|
```
|
|
|
|
|
|
Pri priečinkoch je nutné zadať názov, ktorý sa zobrazí v menu kurzu. Je možné uviesť aj typ stránky. Podporované sú tieto typy:
|
|
|
|
|
|
- **page** — všeobecná stránka bez predpísanej štruktúry (štandardný typ)
|
|
|
- **scenario** — scenár cvičenia členený do krokov
|
|
|
- **subject_info** — [informácie o predmete v formáte XML](https://git.kpi.fei.tuke.sk/it4kt/it4kt/wikis/subject-info)
|
|
|
|
|
|
|
|
|
## Ďalšia dokumentácia
|
|
|
|
|
|
- [Použitie syntaxe Markdown](markdown)
|
|
|
- [Rozširovanie jazyka KPImark](rozširovanie-kpimarku) |
|
|
\ No newline at end of file |