simple-cvut-thesis:0.1.0

[firu11]

I am submitting

• a new package
• an update for a package

Description:

This package is a simple template for ČVUT (Czech Technical University in Prague) students.
It has a neat front page with the university logo, table of contents and citations. Students can use it to have a great starting point for their thesis or term papers.

I have read and followed the submission guidelines and, in particular, I

• selected a name that isn't the most obvious or canonical name for what the package does
• added a typst.toml file with all required keys
• added a README.md with documentation for my package
• have chosen a license and added a LICENSE file or linked one in my README.md
• tested my package locally on my system and it worked
• excluded PDFs or README images, if any, but not the LICENSE

• ensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.

[elegaanz]

Thank you for making this template. The way you decided to structure it is not really conventional. What you would normally do is to have a "template" function in lib.typ that takes some content (and some other parameters, here the thesis title for example), display some common content (the title page for example), configures the styles of the document using show and set rules, and finally renders the provided content using that styling. This is a bit less flexible than letting the user edit everything, but it also lets them focus on their content without worrying about having to understand the provided style nor breaking it by mistake. They can still override your show rules if they need to, which gives enough flexibility in general. Could you refactor your template to follow this pattern please?

Also, can you double check that you are allowed to distribute the university logo, and if so can you please state under which terms it can be used in your README, if the university has any specific rules?

Thank you :)

[firu11]

Hi,
well yeah, I chose this approach, because I expect the user to want to overwrite the template a bit. Since I did not define some "rules", rather prepared the document as a whole, I wanted the user to be able to modify it fully. I get your point though. I'll try to refactor it and maybe submit it, but I don't know if the "conventional approach" will suit this use-case well.

Regarding the logo, I even added it to the bibliography: https://github.com/typst/packages/pull/3715/files#diff-8d53010fa95fd19d53aa7f6f73fc97a505b3665d7a3dbcce4ddc972dbd1cce78R1-R4
It's from Wikipedia where it states the "Attribution-ShareAlike 3.0 Unported" licence. I'll add it to the readme.

Thank you for looking into this though!