Conversation
|
Can you please copy all the files here instead of making a submodule? |
|
Sorry, it seems that it was cached as such. Im relativ new to using gitHub. It should be fixed now (after my understanding). |
elegaanz
left a comment
There was a problem hiding this comment.
I can now see and review your files, thank you for fixing that :) Here is a first round of comments, more may come once you have re-organized your package as requested below.
| @@ -0,0 +1,11 @@ | |||
| [package] | |||
| name = "simple-thesis-ger-HOST" | |||
There was a problem hiding this comment.
Package names should be all lower case. Can you replace HOST by host here please? Don't forget to also rename the directory.
| @@ -0,0 +1,11 @@ | |||
| [package] | |||
| name = "simple-thesis-ger-HOST" | |||
| version = "1.0c" | |||
There was a problem hiding this comment.
Version numbers in Typst follow the semantic versioning standard, so they should be of the form x.y.z. Can you fix that please? Also note that your package should have a sub-directory per-version, which is missing here (i.e if you pick 1.0.0 as a version number, it should be in packages/preview/simple-thesis-ger-host/1.0.0 and not just packages/preview/simple-thesis-ger-host).
There was a problem hiding this comment.
Unless it is a placeholder, the image here seems to be missing, it shows a black rectangle for me.
There was a problem hiding this comment.
Yes it is a placeholder, because im not sure i have permission to distibute the originall logo.
There was a problem hiding this comment.
Okay, no problem, you can keep it as is then :)
| @@ -0,0 +1,13 @@ | |||
| ## Purpose: | |||
| A simple, clean Thesis Templete. That hasa wide functionality, | |||
There was a problem hiding this comment.
Typos:
| A simple, clean Thesis Templete. That hasa wide functionality, | |
| A simple, clean thesis template that has wide functionality. |
I'm also not sure about "wide" as an adjective to qualify "functionality" but my English is not necessarily the best, so feel free to keep it as is.
| A simple, clean Thesis Templete. That hasa wide functionality, | ||
|
|
||
| ## How to Start: | ||
| Simply open the 0_main.typ file. |
There was a problem hiding this comment.
This won't work: if you want to provide a template with some default content, you should put it in a dedicated sub-directory and configure that in your manifest. I would recommend reading this section of our docs if you need more info. You can also have a look at the structure of already-existing packages.
All styling and logic that you don't expect users to modify should also be extracted in their own file, the entrypoint of the package (different from the template's entrypoint, which is the file to preview and compiler by default when creating a project from your template).
Let me know if you have questions or need a bit more guidance with that.
There was a problem hiding this comment.
i was not quit shure what was meant. i changed now a few things: the readme explanation (added init command) and put the content in an extra folder. Like in the doku recommandet, and done the test. ( i overread it the first time i was there or misunderstood...
There was a problem hiding this comment.
The folder name should be all lower case too. If you need help fixing the other errors/warnings reported by the bot please let me know.
By the way, the files outside of the 1.0.1 folder should be removed.
Also, the way you structured your project will still not work (but it's getting in the right direction). You need an entrypoint for your package (which should not be the same file as the template entrypoint). This file should expose the default styling (wrapped in a function, so that people can do show: thesis-template-function in their own document) and any useful function you can think of. The template should only contain some placeholder content.
There was a problem hiding this comment.
thats odd because the folder is all lower case (by me) and there are no files outside from 1.0.1. but i hope i fixed it now. (with next push)
There was a problem hiding this comment.
Can you delete this file please?
…start, delete pdf
|
I changed now everything (and afterwards the jpg with png). but the bot is complaining because of the changed folder name (all lowercase like wished) is this a problem and i have to make a new pull request with the new folder name? |
|
So i changed the entry-point and extractet everything from the main except the glossarium import because i found no (clean/simple) way to use the command print-glossary(entry-list) in the main (never worked correctly). I hope i understand the entry-point correctly and done everything correctly as wished ( it is working by me...) Short: Everything should be fixed |
elegaanz
left a comment
There was a problem hiding this comment.
You're getting to the right direction, but there are still small improvements to be made to have a nice to use template. I left a few comments to explain what would need to change. Feel free to ask questions if you don't understand what I mean.
| title = {Startseite - {{Hochschule Stralsund}}}, | ||
| urldate = {2026-01-29}, | ||
| howpublished = {https://www.hochschule-stralsund.de/}, | ||
| file = {C:\Users\elias\Zotero\storage\L7T46NZB\www.hochschule-stralsund.de.html} |
There was a problem hiding this comment.
I didn't notice at first, but I think it would be better to have a placeholder file that is not tied to your personal setup. Can you remove that file = … line, please?
There was a problem hiding this comment.
If you don't expect people using your template to modify the layout of that page substantially, I think this should be part of the template (i.e in the thesis function). The varying parts (title of the work, author and supervisors names, etc.) could be given by the user as parameters in 0_main.typ like so:
#show: thesis.with(title: [My groundbreaking thesis], author: [Jane Doe])| @@ -0,0 +1,48 @@ | |||
| //Imports | |||
| #import "@preview/simple-thesis-ger-host:1.0.1": thesis // import "header" everything what is defined globally, except glossarium because its not working than (print-glossary funktion is missing) | |||
There was a problem hiding this comment.
You don't use the thesis function anywhere. I think you should introduce a #show: thesis call to apply the styling it defines, and remove any duplicate styling such as the #set page(margin: …) line.
| #register-glossary(entry-list) | ||
| #show: make-glossary |
There was a problem hiding this comment.
If you put that in header.typ inside of the thesis function (not outside of it), before the final body, glossarium should be able to do its job. Can you try that if you didn't already? If there is any error in particular, I can give you pointers to solve it. If it still doesn't work and you don't want to spend more time debugging it, it's also fine to import and configure glossarium directly in this file.
| // ==================== | ||
| // Deckblatt | ||
| // ==================== | ||
| #include "./chapter/TitlePage.typ" | ||
|
|
||
| #set page(margin: (top: 2.5cm, bottom: 2.5cm, left: 3cm, right: 2.5cm)) | ||
|
|
||
|
|
||
| // Inhaltsverzeichnis | ||
| #pagebreak() | ||
| #set heading(numbering: "1.") | ||
| #set page(numbering: "I") | ||
| #outline(title: "Inhaltsverzeichnis ") | ||
|
|
||
| #outline( title: "Abbildungsverzeichnis", target: figure.where(kind: image)) | ||
|
|
||
| //Start Real Numbering | ||
| #set page(numbering: "1") | ||
| #counter(page).update(1) |
There was a problem hiding this comment.
I think all this logic could go in your thesis function as well. The idea is to only have the actual content in this file (and chapter files you include here), and as much logic and styling in header.typ
I am submitting
- a new package
- an update for a package
it is simple and clean with all neccessary features for a good thesis the ones i found were very complicatet or importet a lot extra stuff. And i find it sometimes intransparent how they made there title packe (some extra packages sometimes). Or some important features where missing. For Example: Glossar, Bibliography, Header Numbers also for the table of image and the Bibliography. Page Number starts at 1 after the Titlepage and the table of contents. Aswell as they used standard (englisch names) for the Bibliography. or have a unnessesary complex Layout (color etc.).This one is short and transparent/flexible. If someone want to change some minor things they can find the solution by simple look at the code and how it is done at another point in the template.
SHORT: A lot of features, easy to change
I have read and followed the submission guidelines and, in particular, I
typst.tomlfile with all required keysREADME.mdwith documentation for my packageLICENSEfile or linked one in myREADME.mdexcluded PDFs or README images, if any, but not the LICENSE