initial commit

This commit is contained in:
2025-12-08 00:15:14 +01:00
commit 35207ec541
4 changed files with 351 additions and 0 deletions

3
.gitignore vendored Normal file
View File

@@ -0,0 +1,3 @@
/*.zip
/template/
/*.pdf

13
Makefile Normal file
View File

@@ -0,0 +1,13 @@
presentation.pdf: presentation.typ template
typst compile --font-path template/fonts $< $@
.INTERMEDIATE: tultemplate2_minimal.zip
tultemplate2_minimal.zip:
wget https://tulsablona.zumepro.cz/tultemplate2_minimal.zip
template: tultemplate2_minimal.zip
unzip $<
.PHONY: clean
clean:
rm -rf template *.pdf *.zip

7
citations.bib Normal file
View File

@@ -0,0 +1,7 @@
@misc{bibtex,
author = "{Wikipedia contributors}",
title = "BibTeX --- {Wikipedia}{,} The Free Encyclopedia",
year = "2025",
url = "https://en.wikipedia.org/w/index.php?title=BibTeX&oldid=1309039867",
urldate = {2025-09-24},
}

328
presentation.typ Normal file
View File

@@ -0,0 +1,328 @@
#import "template/template.typ": *
#show: tultemplate2.with(
style: "classic",
faculty: "fm",
lang: "cs",
document: "presentation",
author: [Ondřej Mekina, Michal Procházka, Matěj Žucha],
title: (
cs: [Představení TUL Typst šablony],
),
presentation: (
append_thanks: true,
wide: true,
first_heading_is_fullpage: true,
),
citations: "citations.bib",
)
#profile("release")
#import "template/theme.typ": faculty_color
= Úvod // Matěj
== Proč šablona vznikla a její hlavní přednosti
- Zjednodušení tvorby textových prací
- Psaní obsahu místo boje s formátováním
- Streamlined workflow
- Podobné jako Overleaf zlepšující práci s LaTeXem
- Online editor od tvůrců Typstu
- Méně omezení než např. zmíněný Overleaf
- Uniformnost a správnost dokumentů
- TUL design manuál, ISO 690, interní TUL směrnice
== Cílové publikum // Ondra
Studenti a zaměstnanci #text(font: "TUL Mono", size: .9em)[TUL&], kteří chtějí psát #highlight[bakalářské a diplomové práce, projekty, semestrální práce, prezentace].
#line(stroke: (dash: "dashed"))
- Typografové začátečníci
- Často přechod z Microsoft Word (není to tak těžké)
- Typst je jednoduchý na použití a nabízí pěkný editor
- Typografové pokročilí -- Například uživatelé LaTeXu
- Typst je rychlý a disponuje možností živého náhledu
- Možnost skriptování
- Robustnější sázení
- Datové typy
- Velký výběr layout funkcí
- Automatizace (například přizpůsobení jazyku)
== Jak začít se šablonou
Přehled nejběžnějšího postupu při tvorbě dokumentu s touto šablonou:
#v(2em)
#let color_typst = rgb("#239dad")
#let color_tul = faculty_color("tul")
#import "@preview/fletcher:0.5.8" as fletcher: diagram, node, edge
#figure(
align(center, text(diagram(
node-stroke: 1pt,
spacing: 7em,
node((0,0), text([Generátor], white), corner-radius: .5em, inset: 1em, fill: color_tul, stroke: none),
edge("--|>", [Stáhnout]),
node((1,0), [Archiv se šablonou \ a vzorovým dokumentem], stroke: gray, shape: fletcher.shapes.chevron),
edge("--|>", [Rozbalit]),
node((2,0), text([Online Typst editor], white), inset: 1em, fill: color_typst, stroke: none),
edge("--|>"),
node((2,0.6), [Hotový PDF soubor \ připravený do tisku], stroke: none),
), size: .75em)),
)
#v(2em)
+ Vygenerujete si v generátoru šablonu s dokumentem s předvyplněnými údaji
+ Archiv vložíte do online Typst editoru
+ Upravujete přímo v editoru -- informace lze upravit proklikem
= Generátor // Michal
== Generátor
#v(7em)
#align(center, [
#text(30pt)[https://tulsablona.zumepro.cz/generate]
])
= Jak rozchodit šablonu v online editoru // Matěj
== Ukázka základního použití editoru
- Oproti Wordu dvě hlavní okna - zdrojový text a náhledové PDF
- Mezi pohledy lze snadno přecházet pomocí prokliků
- Není potřeba soubor ukládat - Typst po každém úhozu znovu generuje celý dokument (ano, opravdu je to tak rychlé)
- Vychytávky - VIM mód, relativní číslování řádků, lišta nástrojů
== Šablona - první krůčky
- Odstavce - stejně jako v LaTeXu - 1 _n_ prázných řádků
- Nadpisy - pomocí 1 3 symbolů "rovná se" neboli "="
- Kapitoly - automaticky podle nadpisů různých úrovní
- Obsah - automaticky generovaný
- Číslování stran - ...myslím, že tomu začínáte rozumět
= Základy psaní dokumentů // Ondra
== Stylování textu
- Text lze stylovat syntaxí podobné Markdownu
#v(4em)
#align(center, {
```typst
*tučný text*
_text kurzívou_
#highlight[zvýrazněný text]
```
[Ukázka: *tučný text*, _text kurzívou_, #highlight[zvýrazněný text]]
})
== Základní funkce
- Zkratky se používají přímo v textu
```typst
Jazyk #abbr("MD", "Markdown") je skvělý na psaní poznámek.
```
- Obrázky se vkládají pomocí složení funkce `figure` (aby byl obrázek zalistován) a `image`.
- Tabulky je také potřeba zabalit do funkce `figure`.
= Odkazy a citace
== Vnitřní odkazy a kotvy // Matěj
- Hodí se, když chceme odkázat na předchozí obrázek, kapitolu či stranu
- Kotvu vytvoříme pomocí špičatých závorek - _\<kotva>_
- Slouží dle názvu k ukotvení a pojmenování nějaké části dokumentu
- Odkážeme se na ni pomocí zavináče a jejího jména - _\@kotva_
- Toto vytvoří na místě klikatelný odkaz na kotvu
== Citace a bibliografie
- BibTeX@bibtex - datová struktura z obyčejného textu
- Hlavní výhody - přenositelnost, oddělení dat a formátu
- Přípona .bib
- Všechny hlavní citační nástroje BibTeX podporují
- Citace.com, Zotero, Google Scholar i Wikipedie :)
- Z generátoru se přidal soubor _citations.bib_
- Ten můžeme buď nahradit, nebo do něj doplňovat
```bibtex
@misc{typst,
author = "Wikidata",
title = "Q117858460 --- Wikidata{,} ",
year = "2025",
url = "https://www.wikidata.org/w/index.php?title=Q117858460&oldid=2404700455",
urldate = {2025-09-24},
}
```
== Použití citací v šabloně
#enum(
numbering: "a)",
[Stažení BibTeX souboru do PC a nahrání do Typst editoru],
[Zkopírování BibTeX citace do _citations.bib_],
)
- Poté se používají stejně jako kotvy - vložení citace pomocí zavináče a názvu citace v BibTeXu
- Jednodušší způsob - tlačítko v nástrojové liště
= Pokročilé funkce // Ondra
== Prototypování
- Dokument je možné prototypovat pomocí funkce #highlight[`todo`].
- Funkci `todo` lze například spojit s funkcí #highlight[`lorem`], abyste si načrtli délku odstavce.
- Ukázka níže vygeneruje 67 ukázkových slov "Lorem ipsum" a silně je zvýrazní (parametr `accent`).
#v(5em)
#align(center, ```typst
#todo(lorem(67), accent: true)
```)
== Specifické použití
- Matematika
- Kód
- Chemie
- ...
Další informace jsou v ukázkových dokumentech.
== Balíčky
- Pokud nějaká funkce není přímo v Typstu -- možná bude mít nějaký balíček.
- Balíčky lze najít na https://typst.app/universe/search/?kind=packages
== Další funkce šablony a příklady
- Dokument, který vám vygeneruje generátor, obsahuje spoustu příkladů a návodů na různé funkce.
- Pokud dokument přepíšete, nebo budete hledat aktuální informace -- podívejte se na web šablony: https://tulsablona.zumepro.cz
#v(3em)
#import "@preview/tiaoma:0.3.0": qrcode
#align(center, qrcode("https://tulsablona.zumepro.cz/cs/", width: 20%, options: (
fg-color: faculty_color("fm"),
)))
== Přílohy // Michal
- Do dokumentu lze vložit několik druhů příloh.
- Přílohy se zobrazí vždy na konci dokumentu.
#v(6em)
#align(center, ```typst
#attachments(
// ...
)
```)
== Přílohy - webový odkaz
#v(5em)
#align(center, ```typst
#attachments(
attach_link("Zdrojový kód programu", "https://git.zumepro.cz/")
)
```)
#v(3em)
#align(center, [
Zdrojový kód programu: https://git.zumepro.cz/
])
== Přílohy - textový obsah
#v(3em)
#align(center, ```typst
#attachments(
attach_content("Nějaké další poznámky", [
Tento textový obsah lze _stylovat_,
stejně jako normální text práce.
])
)
```)
#v(3em)
#align(center, [
Nějaké další poznámky #text(fill: luma(50%))[_(dále přiloženo)_]
])
== Přílohy - vložení PDF
#v(5em)
#align(center, ```typst
#attachments(
attach_pdf("Manuál k použití programu", "manual.pdf")
)
```)
#v(3em)
#align(center, [
Manuál k použití programu #text(fill: luma(50%))[_(dále přiloženo)_]
])
== Přílohy - reference na soubor
#v(5em)
#align(center, ```typst
#attachments(
attach_file_reference("Výsledný program", "program.tar.xz")
)
```)
#v(3em)
#align(center, [
Výsledný program: soubor `program.tar.xz`
])
== Export a stažení PDF // Matěj
- Kontrola před odevzdáním - dokončit všechna TODO
- Přepnout profile na _release_
- Export PDF - tlačítko v nástrojové liště
- Stažení vyexportovaného souboru do PC
- Nezapomeňte k souboru přiložit všechny externí přílohy
= Troubleshooting // Ondra
== Máte problém nebo návrh?
+ Aktualizujte šablonu -- možná jsme problém vyřešili
+ Aktualizujte i hlavičku -- třeba jste někde něco smazali
+ Kontaktujte nás!
- Kontakt na nás můžete najít na webu šablony nebo v generátoru.
== Pomožte nám zlepšit šablonu
S čím potřebujeme pomoct neustále?
- Hlášení chyb
- Ukázky vašich dokumentů
- Návrhy na další funkce a vylepšení dokumentace
- Využití pro jiné fakulty
- Dalších typy dokumentů od studentů / absolventů / zaměstnanců
#line(stroke: (dash: "dashed"))
Chcete pomoct přímo s vývojem šablony?
Rádi vás zapojíme do vývoje:
- Webových stránek šablony
- Generátoru šablony
- Implementace šablony v Typstu