Parcourir la source

Updated README v3

xnecas il y a 3 semaines
Parent
commit
c4bb2af88d
1 fichiers modifiés avec 25 ajouts et 58 suppressions
  1. 25 58
      README.md

+ 25 - 58
README.md

@@ -1,12 +1,11 @@
 # UNIZA Beamer – prezentačná šablóna
 
-LaTeXová šablóna pre tvorbu prezentácií v **Beameri** s vlastnými rozloženiami slajdov, typografiou, farbami, pätou, logom organizácie a pomocnými príkazmi na vkladanie tabuliek, obrázkov a zdrojového kódu.
+LaTeXová šablóna pre tvorbu prezentácií v  prostredí **Beamer** s vlastnými rozloženiami slajdov, typografiou, farbami, pätou, logom organizácie a pomocnými príkazmi na vkladanie tabuliek, obrázkov a zdrojového kódu.
 
-Súbor `main.tex` slúži ako ukážková prezentácia a zároveň ako praktický katalóg dostupných príkazov. Vlastné makrá a vzhľad sú oddelené do modulov, takže obsah prezentácie možno upravovať bez potreby meniť všetky súčasti šablóny.
+Súbor `main.tex` slúži ako demo prezentácia a zároveň ako praktický katalóg dostupných príkazov.
 
 ## Obsah
 
-- [Štruktúra projektu](#štruktúra-projektu)
 - [Ako zmeniť organizáciu, farby a logo](#ako-zmeniť-organizáciu-farby-a-logo)
 - [Čo obsahujú jednotlivé súbory](#čo-obsahujú-jednotlivé-súbory)
 - [Príkazy na tvorbu slajdov](#príkazy-na-tvorbu-slajdov)
@@ -14,49 +13,29 @@ Súbor `main.tex` slúži ako ukážková prezentácia a zároveň ako praktick
 - [Riešenie bežných problémov](#riešenie-bežných-problémov)
 - [Atribúcia a licencia](#atribúcia-a-licencia)
 
-## Štruktúra projektu
-
-```text
-.
-├── main.tex
-├── uni.sty
-├── styles/
-│   ├── colors.sty
-│   ├── contents.sty
-│   ├── fonts.sty
-│   ├── footer.sty
-│   ├── lists.sty
-│   ├── slides.sty
-│   └── titles.sty
-├── organisation/
-│   ├── info.sty
-│   ├── feit-uniza/
-│   │   ├── info.sty
-│   │   └── logo-footer.png
-│   ├── kris-feit-uniza/
-│   │   ├── info.sty
-│   │   └── logo-footer.png
-│   └── uniza/
-│       ├── info.sty
-│       └── logo-footer.pdf
-└── snippets/
-    ├── maximum.py
-    ├── mean-func.py
-    └── mean.py
-```
 
-**Dôležité:** cesty k modulom, logám a ukážkovým zdrojovým súborom sú relatívne ku koreňovému priečinku projektu. Pri kompilácii preto pracujte v priečinku, v ktorom sa nachádza `main.tex`, a zachovajte názvy a štruktúru priečinkov.
+### 1. Kompilácia online cez Overleaf (odporúčaná možnosť)
+
+Prezentáciu môžete skompilovať priamo v prehliadači bez lokálnej inštalácie LaTeXu, Pythonu alebo Pygments.
+
+1. Stiahnite ZIP archív `Uni_Presentation_Template_with_README.zip` z repozitára alebo miesta, kde je šablóna zverejnená. Archív nerozbaľujte.
+2. Prihláste sa do [Overleafu](https://www.overleaf.com/) a na stránke projektov zvoľte **New Project → Upload Project**.
+3. Nahrajte ZIP archív. Overleaf rozbalí súbory a zachová priečinky ako `styles/`, `organisation/` a `snippets/`.
+4. Otvorte nastavenia projektu a skontrolujte, že ako hlavný dokument (*Main document*) je zvolený `main.tex`. Ako kompilátor zvoľte `pdfLaTeX`, ak už nie je vybraný automaticky.
+5. Kliknite na **Recompile**. Po úspešnej kompilácii si hotový súbor stiahnete cez **Download PDF**.
 
-## Ako prezentáciu skompilovať
+Šablóna používa balík `minted` na zvýrazňovanie zdrojového kódu. Overleaf ho podporuje bez toho, aby ste si na svojom počítači museli inštalovať Python alebo Pygments. Ak sa kompilácia nepodarí, najprv skontrolujte, či je ako hlavný dokument nastavený `main.tex`, a pozrite si prvú chybu v logu kompilácie.
 
-### Potrebné nástroje
+Užitočné návody: [nahratie ZIP projektu do Overleafu](https://www.overleaf.com/learn/latex/Kb/Uploading_a_project) a [zvýrazňovanie kódu pomocou `minted`](https://www.overleaf.com/learn/latex/Code_Highlighting_with_minted).
+
+### 2. Potrebné nástroje pri lokálnej kompilácii
 
 - LaTeX distribúcia, napríklad TeX Live alebo MiKTeX.
 - Trieda `beamer` a balíky používané šablónou, vrátane `graphicx`, `booktabs`, `amsmath`, `minted`, `caption`, `calc`, `adjustbox` a `multicol`.
 - Python a balík **Pygments**, ktorý používa `minted` na zvýrazňovanie syntaxe kódu.
-- Povolené spúšťanie externých príkazov v LaTeXu (*shell escape*), pretože `minted` spúšťa Pygments.
+- Povolené spúšťanie externých príkazov v LaTeXu (*shell escape*), pretože `minted` spúšťa pomocné nástroje na zvýrazňovanie syntaxe.
 
-### Kompilácia pomocou `latexmk`
+### 3. Lokálna kompilácia pomocou `latexmk`
 
 V koreňovom priečinku projektu spustite:
 
@@ -71,16 +50,16 @@ pdflatex -shell-escape main.tex
 pdflatex -shell-escape main.tex
 ```
 
-Druhé spustenie pomáha aktualizovať odkazy, obsah a celkový počet slajdov. V online editore, napríklad Overleaf, vyberte kompatibilný LaTeX kompilátor a povoľte nastavenia potrebné pre `minted`, ak ich editor vyžaduje.
+Druhé spustenie pomáha aktualizovať odkazy, obsah a celkový počet slajdov. Pri lokálnej kompilácii sa uistite, že máte správne nainštalované balíky a povolený *shell escape*.
 
 Výstupom je súbor `main.pdf`.
 
 ## Ako zmeniť organizáciu, farby a logo
 
-Výber organizačného profilu sa robí v jedinom centrálnom súbore: **`organisation/info.sty`**. Tento súbor aktuálne obsahuje:
+Výber organizačného profilu sa robí v jednom centrálnom súbore: **`organisation/info.sty`**. Tento súbor aktuálne obsahuje:
 
 ```latex
-\input{organisation/kris-feit-uniza/info.sty}
+\input{organisation/uniza/info.sty}
 ```
 
 Tým sa aktivuje profil `uniza`. Na prepnutie na inú z pripravených organizácií zmeňte tento jeden riadok.
@@ -90,7 +69,7 @@ Tým sa aktivuje profil `uniza`. Na prepnutie na inú z pripravených organizác
 V súbore `organisation/info.sty` nahraďte riadok:
 
 ```latex
-\input{organisation/kris-feit-uniza/info.sty}
+\input{organisation/uniza/info.sty}
 ```
 
 riadkom:
@@ -132,7 +111,6 @@ Farby možno definovať aj pomocou RGB, napríklad:
 \colorlet{colorFooterBg}{myBlue}
 ```
 
-Hodnoty RGB sú tri celé čísla od `0` do `255`. Pri zmene farieb je praktické ponechať názvy významových premenných (`colorBg`, `colorText` a podobne) a meniť iba ich priradenia. Tak sa úprava automaticky prejaví v moduloch, ktoré tieto premenné používajú.
 
 ### Vytvorenie vlastného profilu organizácie
 
@@ -233,17 +211,10 @@ Definuje formát titulkov bežných slajdov a označenie pokračovania viacstran
 
 Centrálny prepínač organizácie. Načítava jeden konkrétny profil, ktorý obsahuje farby a cestu k logu. Toto je prvé miesto, ktoré treba upraviť pri zmene organizačnej témy.
 
-#### `organisation/feit-uniza/info.sty`
-
-Farebný profil Fakulty elektrotechniky a informačných technológií UNIZA. V aktuálnych definíciách používa oranžovú farbu päty (`feitOrange`, RGB `244,119,35`) a tmavooranžovú zvýrazňovaciu farbu (`darkOrange`, RGB `228,92,18`). Načítava `organisation/feit-uniza/logo-footer.png`.
-
-#### `organisation/kris-feit-uniza/info.sty`
-
-Profil KRIS FEIT UNIZA. Aktuálne používa tyrkysovú farbu `krisCyan` (RGB `18,102,113`) pre zvýraznenie aj pozadie päty a načítava `organisation/kris-feit-uniza/logo-footer.png`. Tento profil je predvolene aktívny cez `organisation/info.sty`.
-
-#### `organisation/uniza/info.sty`
-
-Všeobecný profil Univerzity Žilina. Definuje modré odtiene, používa `unizaBlue` (RGB `0,45,113`) pre pätu a `darkbBlue` (RGB `24,47,105`) pre zvýraznenie. Načítava vektorové logo `organisation/uniza/logo-footer.pdf`.
+Aktuálne podporované témy:
+1. UNIZA,
+2. FEIT-UNIZA,
+3. KRIS-FEIT-UNIZA.
 
 #### Súbory `logo-footer.*`
 
@@ -253,10 +224,6 @@ Grafické súbory loga, ktoré sa umiestňujú do päty. Každý profil odkazuje
 
 Obsahuje samostatné ukážky Pythonu, ktoré v `main.tex` vkladá makro `\code`. Udržiavanie kódu v osobitných súboroch zjednodušuje jeho úpravu a umožňuje zachovať zvýrazňovanie syntaxe.
 
-- `mean.py` – stručný výpočet aritmetického priemeru hodnôt `[2, 4, 6, 8]`.
-- `mean-func.py` – ukážka výpočtu priemeru pomocou funkcie `calculate_mean`.
-- `maximum.py` – funkcia `find_maximum`, ktorá hľadá najväčšiu hodnotu v zozname.
-
 Pri príkaze `\code` použite cestu k súboru relatívnu ku koreňu projektu, napríklad `snippets/mean.py`.
 
 ## Príkazy na tvorbu slajdov