add author to acknowledgement

README.md

@@ -6,6 +6,7 @@ Easy Typst template for TUL documents. Begin by compiling `example.typ` and read
 
 It is recommended to use either:
 - The on-line Typst editor (https://typst.app/play/) - use some zip build from releases
+  (https://git.zumepro.cz/tul/tultemplate2/releases).
 - The `typst` CLI tool (available in Arch repos and Snap)
 
 On Linux, with the `typst` command available, you can just run:

example.typ

@@ -326,23 +326,38 @@ Zvýrazněné hodnoty jsou základní -- pokud vynecháte parametr, pak bude pou
 #line()
 - `title` (nadpis dokumentu)
   - Ve formátu `(<zkratka_jazyka>: "<nadpis>")`, například `(cs: "Můj nadpis")`
+  - Pro většinu dokumentů (kromě `other`) jsou vyžadovány verze _cs_ a _en_ (kvůli abstraktu).
 #line()
 - `author` (autor/autoři dokumentu)
   - Příklad: `"Pavel Novák"` nebo `"Petra Velká, Jindřich Peterka"`
 #line()
-- `author_gender` (rod autora v českém jazyce - není potřeba pro angličtinu)
-  - `"masculine"` - Mužský rod
-  - `"feminine"` - Ženský rod
-  - `"we"` - Množné číslo
+- `author_gender` (jazykový rod autora - není potřeba pro angličtinu, která má základní hodnotu)
+  - Pro vybraný jazyk _cs_:
+    - `"masculine"` - Mužský rod
+    - `"feminine"` - Ženský rod
+    - `"we"` - Množné číslo
+  - Pro vybraný jazyk _en_:
+    - *`"me"`* - První osoba jednotného čísla
+    - `"we"` - První osoba množného čísla
 #line()
-- `supervisor` (vedoucí práce)
-  - Příklad: `"prof. Jindřich Jindřich"`
+- `supervisor` (vedoucí práce) <arg_supervisor>
+  - V podobě textového řetězce, příklad: `"prof. Jindřich Jindřich"`
+  - Ve formátu `(name: "<jméno>", institute: "<institut>")` (toto lze využít například při DP)
 #line()
-- `programme` (studijní program autora)
+- `consultant` (konzultant práce)
+  - Stejně jako u #link(<arg_supervisor>, [`supervisor`])
+#line()
+- `programme` (studijní program) <arg_programme>
   - Ve formátu `(<zkratka_jazyka>: "<název_programu>")`
+  - Je vyžadován jazyk, který je vybrán pro celou šablonu -- tohle je pojistka, aby uživatel šablony
+    nevynechal vybraný jazyk
+#line()
+- `branch` (studijní obor)
+  - Stejně jako #link(<arg_programme>, [`programme`])
 #line()
 - `abstract` (abstrakt)
   - Ve formátu `(<zkratka_jazyka>: [<abstrakt>])`, například `(cs: [Můj *krásný* abstrakt.])`
+  - Dokumenty vyžadují _cs_ i _en_ abstrakt (kromě typu dokumentu `other`).
 #line()
 - `keywords` (klíčová slova zobrazovaná pod abstraktem)
   - Ve formátu `(<zkratka_jazyka>: ("slovo1", "slovo2", ...))`
@@ -388,6 +403,30 @@ Při dalších použití bude vypadat takto: #abbr("ZK").
   Tedy zkratku _nepřidáváte_ přímo do seznamu zkratek, ale elegantně jí používáte přímo v textu.
 ]
 
+== Přílohy
+
+V některých typech dokumentů budete chtít přidat přílohy. Přílohy se přikládají v různých podobách:
+
+- Jako odkaz (URL/URI adresa)
+- Zmínka externího souboru (například další soubor nahraný do systému)
+- Přiložený obsah (vygenerovaný Typstem v tomto dokumentu -- je tedy součástí tohoto kódu)
+- Externí PDF soubor přiložený jako obsah (jiný PDF dokument, vložený do příloh v kompletní
+  podobě -- to je dobré například do tisku, kde můžete přílohy vytisknout s dokumentem)
+
+#highlight[
+  Přílohy lze definovat *pouze na jednom* místě v dokumentu, aby se zabránilo omylnému opakování
+  příloh. Přílohy doporučujeme definovat *na konci* souboru pro přehlednost.
+]
+
+Zde je ukázka definice příloh (je také použita na konci tohoto ukázkového souboru):
+
+```typst
+#attachments(
+  attach_link("Zdrojový kód této šablony", "https://git.zumepro.cz/tul/tultemplate2"),
+  attach_content("Testovací obsah vygenerovaný Typstem", [Sem lze psát _stylovaný_ obsah.]),
+)
+```
+
 = Workflow a jak si zjednoduššit práci
 
 Tyhle věci používat _nemusíte_, aby vám šablona fungovala. Nicméně často jsou poměrně fajn.
@@ -450,3 +489,8 @@ Takhle si můžete předpřipravit délku odstavců a vyzkoušet si, jestli se r
 do požadavků. Pak můžete postupně přepisovat/vyplňovat.
 
 Funkce `todo` vám zároveň zabrání v tom, aby se text Lorem Ipsum vyskytl ve výsledném dokumentu.
+
+#attachments(
+  attach_link("Zdrojový kód této šablony", "https://git.zumepro.cz/tul/tultemplate2"),
+  attach_content("Testovací obsah vygenerovaný Typstem", [Sem lze psát _stylovaný_ obsah.]),
+)

template/attachments.typ

@@ -60,7 +60,8 @@
   }
 }
 
-#let attachments(attachments) = {
+#let attachments(..attachments) = {
+  let attachments = attachments.pos();
   assert_type_signature(
     attachments, "array[array[string | content]] | array[string | content]", "attachments"
   );
@@ -117,6 +118,9 @@
       return;
     }
     let data = eval(data);
+    if data == false {
+      return;
+    }
     heading(get_lang_item(language, "attachments"), numbering: none);
 
     // listing

template/classic/bp.typ

@@ -5,6 +5,7 @@
   assignment,
   disclaimer,
   abstract,
+  acknowledgement,
   toc,
   abbrlist,
   imagelist,
@@ -12,15 +13,15 @@
   bibliogr
 )
 #import "../attachments.typ": attachment_list
-#import "../utils.typ": is_none, assert_dict_has, assert_not_none
+#import "../utils.typ": is_none, assert_dict_has, assert_not_none, assert_type_signature
 
 #let bp(
   // general settings
   faculty_id, faculty_color, language, assignment_document, citation_file,
 
   // document info
-  title, author, author_gender, supervisor, consultant, study_programme, study_branch, abstract_content,
-  keywords,
+  title, author, author_gender, supervisor, consultant, study_programme, study_branch,
+  abstract_content, acknowledgement_content, keywords,
 
   content
 ) = {
@@ -38,20 +39,28 @@
   if not is_none(keywords) {
     assert_dict_has(force_langs, keywords, "keywords");
   }
+  assert_not_none(acknowledgement_content, "acknowledgement content");
   if language == "cs" {
     assert_not_none(author_gender, "author gender");
   }
 
-  mainpage(faculty_id, language, "bp", title, author, supervisor, consultant, study_programme, study_branch);
+  assert_type_signature(supervisor, "string | none", "supervisor");
+  assert_type_signature(consultant, "string | none", "consultant");
+
+  mainpage(
+    faculty_id, language, "bp", title, author, supervisor, consultant, study_programme,
+    study_branch,
+  );
   assignment(language, assignment_document);
   default_styling(false, faculty_color, {
     disclaimer(language, faculty_id, "bp", author, author_gender);
     abstract("cs", title, abstract_content, keywords);
     abstract("en", title, abstract_content, keywords);
+    acknowledgement(language, author, acknowledgement_content);
     toc(language);
-    abbrlist(language);
-    imagelist(language);
     tablelist(language);
+    imagelist(language);
+    abbrlist(language);
     pagebreak(weak: true);
     content;
     bibliogr(language, citation_file);

template/classic/classic.typ

@@ -12,7 +12,8 @@
   language, faculty_id, document_type, citation_file, assignment_document,
 
   // document info
-  title, author, author_gender, supervisor, consultant, study_programme, study_branch, abstract, keywords,
+  title, author, author_gender, supervisor, consultant, study_programme, study_branch, abstract,
+  acknowledgement, keywords,
 
   // content
   content,
@@ -26,13 +27,13 @@
   map_none(title, (v) => assert_dict_has((language,), v, "title"));
   map_none(study_programme, (v) => assert_dict_has((language,), v, "study programme"));
   map_none(study_branch, (v) => assert_dict_has((language,), v, "study branch"));
-
+  map_none(acknowledgement, (v) => assert_dict_has((language,), v, "acknowledgement content"));
 
   document_types.at(document_type)(
     faculty_id,
     faculty_color(faculty_id),
     language,
-    assignment_document,
+    map_none(assignment_document, (v) => "../../" + v),
     map_none(citation_file, (v) => "../../" + v),
     title,
     author,
@@ -42,6 +43,7 @@
     study_programme,
     study_branch,
     abstract,
+    acknowledgement,
     keywords,
     content,
   );

template/classic/common.typ

@@ -1,6 +1,6 @@
 #import "../theme.typ": faculty_logotype, tul_logomark, faculty_color
 #import "../lang.typ": get_lang_item
-#import "../utils.typ": is_none
+#import "../utils.typ": is_none, assert_dict_has
 
 #let base_font = "Inter";
 #let mono_font = "Noto Sans Mono";
@@ -90,7 +90,30 @@
   );
 }
 
-//  DOCUMENT INFO
+// DOCUMENT INFO
+
+#let person_info(record, item_name) = {
+  if is_none(record) {
+    none
+  } else if type(record) == str {
+    record
+  } else if type(record) == dictionary {
+    if "name" in record {
+      record.at("name");
+      if "institute" in record {
+        text("\n    " + record.at("institute"), style: "italic")
+      }
+    } else {
+      let panic_message = (
+        item_name + " name is required (or try not specifying " + item_name + " at all)"
+      );
+      panic(panic_message);
+    }
+  } else {
+    let panic_message = "invalid " + item_name + " - expected a string or a dictionary";
+    panic(panic_message);
+  }
+}
 
 #let info(
   faculty_id,
@@ -100,6 +123,7 @@
 ) = {
   let info_name_value_padding = 5em;
   let info_name_min_width = 10em;
+  let gutter = .7em;
 
   // document type
   if type(document_type) != type(none) {
@@ -120,8 +144,8 @@
     ("study_programme", study_programme, false),
     ("study_branch", study_branch, false),
     ("author", author, true),
-    ("supervisor", supervisor, false),
-    ("consultant", consultant, false),
+    ("supervisor", person_info(supervisor, "supervisor"), false),
+    ("consultant", person_info(consultant, "consultant"), false),
   )
   context {
     let max_field_name_width = calc.max(..info_fields.map((v) => {
@@ -133,7 +157,7 @@
     }), info_name_min_width.to-absolute());
     grid(
       columns: 2,
-      gutter: .5em,
+      gutter: gutter,
       ..info_fields.filter((v) => { type(v.at(1)) != type(none) }).map((v) => {
         (
           align(top, block(
@@ -145,7 +169,7 @@
       }).flatten(),
     );
     v(1em);
-    h(max_field_name_width + info_name_value_padding);
+    h(max_field_name_width + info_name_value_padding + gutter);
     text(get_lang_item(language, "city") + " " + str(datetime.today().year()), font: base_font);
   }
 }
@@ -220,6 +244,18 @@
   );
 }
 
+// ACKNOWLEDGEMENT PAGE
+
+#let acknowledgement(language, author, content) = {
+  if is_none(content) {
+    return;
+  }
+  heading(get_lang_item(language, "acknowledgement"), numbering: none, outlined: false);
+  par(content.at(language));
+  v(2em);
+  align(right, author);
+}
+
 // ABSTRACT
 
 #let abstract(language, title, content, keywords) = {

template/classic/other.typ

@@ -18,7 +18,8 @@
   faculty_id, faculty_color, language, assignment_document, citation_file,
 
   // document info
-  title, author, _, supervisor, consultant, study_programme, study_branch, abstract_content, keywords,
+  title, author, _, supervisor, consultant, study_programme, study_branch, abstract_content,
+  _, keywords,
 
   content
 ) = {
@@ -28,9 +29,9 @@
   mainpage(faculty_id, language, none, title, author, supervisor, consultant, study_programme, study_branch);
   default_styling(true, faculty_color, {
     toc(language);
-    abbrlist(language);
-    imagelist(language);
     tablelist(language);
+    imagelist(language);
+    abbrlist(language);
     pagebreak(to: "even", weak: true);
     content;
     bibliography(citation_file, style: "../tul_citace.csl");

template/lang.json

@@ -36,6 +36,7 @@
 		"date": "[day]. [month]. [year]",
 
 		"abstract": "Abstrakt",
+		"acknowledgement": "Poděkování",
 		"keywords": "Klíčová slova",
 		"abbrs": "Seznam zkratek",
 		"image_list": "Seznam obrázků",
@@ -74,6 +75,7 @@
 		"date": "[year]-[month]-[day]",
 
 		"abstract": "Abstract",
+		"acknowledgement": "Acknowledgement",
 		"keywords": "Keywords",
 		"abbrs": "List of abbreviations",
 		"image_list": "List of images",

template/template.typ

@@ -30,7 +30,9 @@
 // - author (str): The name of the document's author.
 // - author_gender (str): The gender of the document's author. Needed only for the `cs` language.
 // - supervisor (str): The name of the document's supervisor.
+// - consultant (str): The name of the document's consultant.
 // - programme (dictionary): Study programme.
+// - branch (disctionary): Study branch
 // - abstract (dictionary): The abstract.
 // - keywords (dictionary): The abstract keywords.
 // - assignment (str): Filepath of the assignment document/page.
@@ -43,8 +45,8 @@
   style: "classic", faculty: "tul", lang: "cs", document: "other",
 
   // document info
-  title: none, keywords: none, abstract: none, author: none, author_gender: none,
-  supervisor: none, consultant: none, programme: none, branch: none,
+  title: none, keywords: none, abstract: none, acknowledgement: none, author: none,
+  author_gender: none, supervisor: none, consultant: none, programme: none, branch: none,
 
   // links
   assignment: none, citations: "citations.bib",
@@ -64,10 +66,17 @@
   assert_type_signature(
     abstract, "dictionary[string : string | content] | none", "abstract argument"
   );
+  assert_type_signature(
+    acknowledgement, "dictionary[string : string] | none", "acknowledgement content"
+  );
   assert_type_signature(author, "string | none", "author argument");
   assert_type_signature(author_gender, "string | none", "author gender argument");
-  assert_type_signature(supervisor, "string | none", "supervisor argument");
-  assert_type_signature(consultant, "string | none", "consultant argument");
+  assert_type_signature(
+    supervisor, "string | dictionary[string : string] | none", "supervisor argument"
+  );
+  assert_type_signature(
+    consultant, "string | dictionary[string : string] | none", "consultant argument"
+  );
   assert_type_signature(
     programme, "dictionary[string : string] | none", "study programme argument"
   );
@@ -91,7 +100,7 @@
   templates.at(style)(
     lang, faculty, document, citations, assignment,
     title, author, author_gender, supervisor, consultant,
-    programme, branch, abstract, keywords, content
+    programme, branch, abstract, acknowledgement, keywords, content
   );
 
   import "prototyping.typ": assert_release_ready