4 Commits

Author SHA1 Message Date
2787bed48d fix Matěj damage 2025-10-03 11:09:23 +02:00
a691d84e1b implement attachments 2025-10-03 11:07:22 +02:00
Matej-Zucha-TUL
a0c75deba0 Change example document signature to reflect reality better 2025-10-03 09:26:49 +02:00
Matej-Zucha-TUL
1a7418d2cd Add optional consultant parameter 2025-10-03 09:25:37 +02:00
7 changed files with 203 additions and 18 deletions

167
template/attachments.typ Normal file
View File

@@ -0,0 +1,167 @@
#import "utils.typ": assert_type_signature, is_none
#import "lang.typ": get_lang_item
#let attachment_data = state("attachment_data");
#let attach_link(name, link) = {
assert_type_signature(link, "string", "attach link argument");
assert_type_signature(name, "string", "attach link name argument");
("link", link, name)
}
#let attach_content(name, inner_content) = {
assert_type_signature(inner_content, "content", "attach content argument");
assert_type_signature(name, "string", "attach content name argument");
("content", inner_content, name)
}
#let attach_pdf(name, filepath) = {
assert_type_signature(filepath, "string", "attach pdf argument");
assert_type_signature(name, "string", "attach pdf name argument");
("pdf", filepath, name)
}
#let attach_file_reference(name, filename) = {
assert_type_signature(filename, "string", "attach file reference filename argument");
assert_type_signature(name, "string", "attach file reference name argument");
("ref", filename, name)
}
#let make_content_anchor(idx) = {
"attachment_" + str(idx + 1)
}
#let generate_attachment_content(attachment, idx) = {
let attachment_type = attachment.at(0);
if attachment_type == "content" {
let anchor = make_content_anchor(idx);
[#metadata(attachment.at(1)) #label(anchor)];
}
}
#let generate_attachment_info(attachment, idx) = {
let attachment_type = attachment.at(0);
if type(attachment_type) != str {
panic("invalid attachment - wrap the attach using: attach_content, attach_pdf, ...");
}
if attachment_type == "content" {
let anchor = make_content_anchor(idx);
"(\"content\",\"" + anchor + "\",\"" + attachment.at(2) + "\")"
} else if attachment_type == "pdf" {
"(\"pdf\",\"" + attachment.at(1) + "\",\"" + attachment.at(2) + "\")"
} else if (
attachment_type == "pdf" or
attachment_type == "link" or
attachment_type == "ref"
) {
"(" + attachment.map((v) => { "\"" + v + "\"" }).join(",") + ",)"
} else {
panic("unknown attachment type '" + attachment_type + "'");
}
}
#let attachments(attachments) = {
assert_type_signature(
attachments, "array[array[string | content]] | array[string | content]", "attachments"
);
context {
if not is_none(attachment_data.get()) {
panic("re-definition of attachments - attachments must only be defined once");
}
if attachments.len() == 0 {
attachment_data.update("false");
} else {
attachment_data.update({
"(" + if type(attachments) == array and type(attachments.at(0)) == array {
for (idx, attachment) in attachments.enumerate() {
(generate_attachment_info(attachment, idx),)
}.join(", ")
} else {
generate_attachment_info(attachments, 0)
} + ",)"
})
if type(attachments) == array and type(attachments.at(0)) == array {
for (idx, attachment) in attachments.enumerate() {
generate_attachment_content(attachment, idx);
}
} else {
generate_attachment_content(attachments, 0);
}
}
}
}
#let list_entry(language, entry, is_embedded) = {
let entry_type = entry.at(0);
entry.at(2);
if entry_type == "link" {
": ";
link(entry.at(1));
} else if entry_type == "ref" {
": soubor ";
raw(entry.at(1));
}
if is_embedded {
text(
" (" + get_lang_item(language, "attached_bellow") + ")",
style: "italic",
fill: black.lighten(50%),
);
}
}
#let attachment_list(language) = {
context {
let data = attachment_data.get();
if is_none(data) {
return;
}
let data = eval(data);
heading(get_lang_item(language, "attachments"), numbering: none);
// listing
let has_embedded = false;
let enum_items = ();
for attachment in data {
let attachment_type = attachment.at(0);
let is_embedded = false;
if attachment_type == "content" or attachment_type == "pdf" {
has_embedded = true;
is_embedded = true;
}
enum_items.push(list_entry(language, attachment, is_embedded));
}
enum(..enum_items.map((v) => { enum.item(v) }), spacing: 1em);
if has_embedded {
pagebreak(weak: true);
}
// embedded
set page(footer: none);
for (idx, attachment) in data.enumerate() {
let attachment_type = attachment.at(0);
if attachment_type == "content" {
heading(
level: 2,
get_lang_item(language, "attachment") + " " + str(idx + 1),
numbering: none,
outlined: false,
);
query(label(attachment.at(1))).at(0).value;
} else if attachment_type == "pdf" {
import "@preview/muchpdf:0.1.1": muchpdf
page(place(center + horizon, heading(
level: 2,
get_lang_item(language, "attachment") + " " +
str(idx + 1) + " " +
get_lang_item(language, "next_page_attachment"),
numbering: none,
outlined: false,
)), margin: 0em);
set page(margin: 0em);
muchpdf(read("../" + attachment.at(1), encoding: none), width: 100%);
}
}
}
}

View File

@@ -11,6 +11,7 @@
tablelist, tablelist,
bibliogr 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
#let bp( #let bp(
@@ -18,7 +19,7 @@
faculty_id, faculty_color, language, assignment_document, citation_file, faculty_id, faculty_color, language, assignment_document, citation_file,
// document info // document info
title, author, author_gender, supervisor, study_programme, study_branch, abstract_content, title, author, author_gender, supervisor, consultant, study_programme, study_branch, abstract_content,
keywords, keywords,
content content
@@ -41,7 +42,7 @@
assert_not_none(author_gender, "author gender"); assert_not_none(author_gender, "author gender");
} }
mainpage(faculty_id, language, "bp", title, author, supervisor, study_programme, study_branch); mainpage(faculty_id, language, "bp", title, author, supervisor, consultant, study_programme, study_branch);
assignment(language, assignment_document); assignment(language, assignment_document);
default_styling(false, faculty_color, { default_styling(false, faculty_color, {
disclaimer(language, faculty_id, "bp", author, author_gender); disclaimer(language, faculty_id, "bp", author, author_gender);
@@ -52,7 +53,8 @@
imagelist(language); imagelist(language);
tablelist(language); tablelist(language);
pagebreak(weak: true); pagebreak(weak: true);
content content;
bibliogr(language, citation_file); bibliogr(language, citation_file);
attachment_list(language);
}); });
} }

View File

@@ -12,7 +12,7 @@
language, faculty_id, document_type, citation_file, assignment_document, language, faculty_id, document_type, citation_file, assignment_document,
// document info // document info
title, author, author_gender, supervisor, study_programme, study_branch, abstract, keywords, title, author, author_gender, supervisor, consultant, study_programme, study_branch, abstract, keywords,
// content // content
content, content,
@@ -38,6 +38,7 @@
author, author,
author_gender, author_gender,
supervisor, supervisor,
consultant,
study_programme, study_programme,
study_branch, study_branch,
abstract, abstract,

View File

@@ -96,7 +96,7 @@
faculty_id, faculty_id,
language, language,
document_type, document_type,
title, author, supervisor, study_programme, study_branch, title, author, supervisor, consultant, study_programme, study_branch,
) = { ) = {
let info_name_value_padding = 5em; let info_name_value_padding = 5em;
let info_name_min_width = 10em; let info_name_min_width = 10em;
@@ -121,6 +121,7 @@
("study_branch", study_branch, false), ("study_branch", study_branch, false),
("author", author, true), ("author", author, true),
("supervisor", supervisor, false), ("supervisor", supervisor, false),
("consultant", consultant, false),
) )
context { context {
let max_field_name_width = calc.max(..info_fields.map((v) => { let max_field_name_width = calc.max(..info_fields.map((v) => {
@@ -155,13 +156,13 @@
faculty_id, faculty_id,
language, language,
document_type, document_type,
title, author, supervisor, study_programme, study_branch title, author, supervisor, consultant, study_programme, study_branch
) = { ) = {
import "../utils.typ": has_all_none, map_none import "../utils.typ": has_all_none, map_none
let nonetype = type(none); let nonetype = type(none);
page({ page({
if has_all_none(( if has_all_none((
document_type, title, author, supervisor, study_programme, document_type, title, author, supervisor, consultant, study_programme,
)) { )) {
place(center + horizon, align(left, faculty_logotype(faculty_id, language))); place(center + horizon, align(left, faculty_logotype(faculty_id, language)));
} else { } else {
@@ -169,7 +170,7 @@
align({ align({
info( info(
faculty_id, language, document_type, map_none(title, (v) => v.at(language)), faculty_id, language, document_type, map_none(title, (v) => v.at(language)),
author, supervisor, map_none(study_programme, (v) => v.at(language)), author, supervisor, consultant, map_none(study_programme, (v) => v.at(language)),
map_none(study_branch, (v) => v.at(language)), map_none(study_branch, (v) => v.at(language)),
); );
v(5em); v(5em);
@@ -250,7 +251,7 @@
stack( stack(
dir: ltr, dir: ltr,
text(numbering( text(numbering(
"1. 1", "1.1",
counter(heading).at(element.location()).at(0), counter(heading).at(element.location()).at(0),
counter(selector).at(element.location()).at(0), counter(selector).at(element.location()).at(0),
)), )),
@@ -262,7 +263,7 @@
), ),
) )
} }
heading(title, numbering: none, outlined: false); heading(title, numbering: none);
for el in query(figure.where(kind: selector)) { for el in query(figure.where(kind: selector)) {
if is_none(el.caption) { if is_none(el.caption) {
continue; continue;

View File

@@ -10,6 +10,7 @@
imagelist, imagelist,
tablelist, tablelist,
) )
#import "../attachments.typ": attachment_list
#import "../utils.typ": is_none, assert_not_none, assert_dict_has, assert_in_arr #import "../utils.typ": is_none, assert_not_none, assert_dict_has, assert_in_arr
#let other( #let other(
@@ -17,23 +18,22 @@
faculty_id, faculty_color, language, assignment_document, citation_file, faculty_id, faculty_color, language, assignment_document, citation_file,
// document info // document info
title, author, _, supervisor, study_programme, study_branch, abstract_content, keywords, title, author, _, supervisor, consultant, study_programme, study_branch, abstract_content, keywords,
content content
) = { ) = {
assert_not_none(title, "title"); assert_not_none(title, "title");
assert_dict_has((language,), title, "title"); assert_dict_has((language,), title, "title");
mainpage(faculty_id, language, none, title, author, supervisor, study_programme, study_branch); mainpage(faculty_id, language, none, title, author, supervisor, consultant, study_programme, study_branch);
default_styling(true, faculty_color, { default_styling(true, faculty_color, {
toc(language); toc(language);
abbrlist(language); abbrlist(language);
imagelist(language); imagelist(language);
tablelist(language); tablelist(language);
pagebreak(to: "even", weak: true); pagebreak(to: "even", weak: true);
content content;
// bibliography
bibliography(citation_file, style: "../tul_citace.csl"); bibliography(citation_file, style: "../tul_citace.csl");
attachment_list(language);
}); });
} }

View File

@@ -3,6 +3,7 @@
"author": "Autor", "author": "Autor",
"authors": "Autoři", "authors": "Autoři",
"supervisor": "Vedoucí práce", "supervisor": "Vedoucí práce",
"consultant": "Konzultant práce",
"study_programme": "Studijní program", "study_programme": "Studijní program",
"study_branch": "Studijní obor", "study_branch": "Studijní obor",
@@ -39,6 +40,10 @@
"abbrs": "Seznam zkratek", "abbrs": "Seznam zkratek",
"image_list": "Seznam obrázků", "image_list": "Seznam obrázků",
"table_list": "Seznam tabulek", "table_list": "Seznam tabulek",
"attachments": "Přílohy",
"attachment": "Příloha",
"next_page_attachment": "začíná na další straně",
"attached_bellow": "dále přiloženo",
"place_assignment": "Sem vložte zadání" "place_assignment": "Sem vložte zadání"
}, },
@@ -47,6 +52,7 @@
"author": "Author", "author": "Author",
"authors": "Authors", "authors": "Authors",
"supervisor": "Supervisor", "supervisor": "Supervisor",
"consultant": "Consultant",
"study_programme": "Study programme", "study_programme": "Study programme",
"study_branch": "Study branch", "study_branch": "Study branch",
@@ -72,6 +78,10 @@
"abbrs": "List of abbreviations", "abbrs": "List of abbreviations",
"image_list": "List of images", "image_list": "List of images",
"table_list": "List of tables", "table_list": "List of tables",
"attachments": "Attachments",
"attachment": "Attachment",
"next_page_attachment": "begins on the next page",
"attached_bellow": "attached bellow",
"place_assignment": "Insert your assignment here" "place_assignment": "Insert your assignment here"
} }

View File

@@ -7,6 +7,9 @@
// Git: https://git.zumepro.cz/tul/tultemplate2 // Git: https://git.zumepro.cz/tul/tultemplate2
#import "prototyping.typ": todo, profile #import "prototyping.typ": todo, profile
#import "attachments.typ": (
attachments, attach_content, attach_pdf, attach_link, attach_file_reference
)
// TUL Template 2 // TUL Template 2
// //
@@ -41,7 +44,7 @@
// document info // document info
title: none, keywords: none, abstract: none, author: none, author_gender: none, title: none, keywords: none, abstract: none, author: none, author_gender: none,
supervisor: none, programme: none, branch: none, supervisor: none, consultant: none, programme: none, branch: none,
// links // links
assignment: none, citations: "citations.bib", assignment: none, citations: "citations.bib",
@@ -64,6 +67,7 @@
assert_type_signature(author, "string | none", "author argument"); assert_type_signature(author, "string | none", "author argument");
assert_type_signature(author_gender, "string | none", "author gender argument"); assert_type_signature(author_gender, "string | none", "author gender argument");
assert_type_signature(supervisor, "string | none", "supervisor argument"); assert_type_signature(supervisor, "string | none", "supervisor argument");
assert_type_signature(consultant, "string | none", "consultant argument");
assert_type_signature( assert_type_signature(
programme, "dictionary[string : string] | none", "study programme argument" programme, "dictionary[string : string] | none", "study programme argument"
); );
@@ -86,8 +90,8 @@
// template call // template call
templates.at(style)( templates.at(style)(
lang, faculty, document, citations, assignment, lang, faculty, document, citations, assignment,
title, author, author_gender, supervisor, programme, branch, abstract, keywords, title, author, author_gender, supervisor, consultant,
content programme, branch, abstract, keywords, content
); );
import "prototyping.typ": assert_release_ready import "prototyping.typ": assert_release_ready