stu-bachelor-thesis:0.1.0#4577
Conversation
| @@ -0,0 +1,329 @@ | |||
| # 使用说明 | |||
|
|
|||
| 有问题需要提问时，请在提问前***完整阅读使用说明***。 | |||
There was a problem hiding this comment.
It is not mandatory, but it is generally appreciated to have at least one sentence in English at the beginning of the README to give an idea of what the package is about to the whole Typst community, even if the target audience is more specific than that and doesn't necessarily speak English.
|
|
||
| 直接下载打包好的程序包，解压后如下图所示： | ||
|
|
||
|  |
There was a problem hiding this comment.
The goal of image alternative texts (the part between square braces) is to give an idea of what the image shows, for people using screen readers or with slow/limited internet connections. I don't speak Chinese so I can't tell for sure, but from what I understand, the current description doesn't really fit that role. Can you please change that? Descriptions don't have to be very long. You can imagine describing the essential information to someone over the phone, it generally helps to write good ones.
There was a problem hiding this comment.
Thanks for review. The image is made by my teacher and he thought that we need to make the template can be used by idiot. I mean, he might think that without the picture, someone in our university can't know how to use this template. The network not a very big problem. Because my teacher know that some students may hard to browser GitHub, he make a mirror under the chinese network. This picture is not for who using typst init, but for who using the mirror.
There was a problem hiding this comment.
The package won't be distributed using GitHub. Once this PR is merged it will be copied to Typst Universe, which is independent. It may still be difficult to access for some students depending on the network situation. In any case, this doesn't invalidate my remark about the alternative text not being very helpful in their current state: the remark was not about the contents of the images (which is fine) but about the way you describe them to people who can't see them directly for various reasons.
| 详细说明见下面代码的注释。 | ||
|
|
||
| ```typst | ||
| #show: text-body => template-main( |
There was a problem hiding this comment.
This more of a style nit: the show: template-main.with(…) style is generally preferred and considered more idiomatic. But it's up to you, and if you feel like this version is cleaner or easier to understand you can also keep it as is.
| #import "chapter_1.typ": * | ||
| #import "chapter_2.typ": * | ||
| #import "chapter_3.typ": * | ||
| #import "chapter_4.typ": * | ||
| #Chapter_one;//显示第一章内容 | ||
| #Chapter_two;//显示第二章内容 | ||
| #Chapter_three;//显示第三章内容 | ||
| #Chapter_four;//显示第四章内容 |
There was a problem hiding this comment.
I feel like #include would be more idiomatic here.
There was a problem hiding this comment.
But if we use #include, the tinymist will give me some error because some citation not in the same file. I have no idea how to fix them and using #import seems better.
There was a problem hiding this comment.
Have you tried using the Typst: Pin the main file to the currently open document command, while editing main.typ? This should tell Tinymist to always consider the same file as the one to preview, and fix the citation issues.
| ````typst | ||
| #import "@preview/codly:1.3.0": * | ||
| #import "@preview/codly-languages:0.1.10": * | ||
| #show: codly-init.with() |
There was a problem hiding this comment.
On the contrary, the .with() is useless here, #show: codly-init would be enough.
| @@ -0,0 +1,20 @@ | |||
| [package] | |||
| name = "stu-bachelor-thesis" | |||
There was a problem hiding this comment.
If this isn't an official package of the university, could you pick another name please? It should be distinctive enough so that another package with the same purpose can be published without one of the two having an unfair advantage, and it should be clear from the name that it is community-built and not officially endorsed by the university. See our naming rules.
If you want to make this an official template, to keep the current name, that's also an option. In that case a member of the University staff should send an email to hello@typst.app stating that they officially endorse your package. In practice it means that they will accept submission of works built using it, and ideally promote it and guarantee that it will be maintained in the long term.
| repository = "https://github.com/weixinhum2023/shantou-university-thesis-typst-template" | ||
| keywords = ["thesis", "stu", "shantou-university", "chinese", "academic"] | ||
| categories = ["thesis"] | ||
| compiler = "0.14.2" |
There was a problem hiding this comment.
This field corresponds to the oldest compiler version your template supports. Unless you really depend on patches that were introduced in 0.14.2 it should be 0.14.0 or even lower than that.
There was a problem hiding this comment.
Under which license is this logo? Do you have rights to distribute it? If yes, can you please specify this information at the end of your README, license file or in another dedicated file? If not, can you replace it with a placeholder and give instructions on how to import the actual logo to your users?
3 participants
I am submitting
Description: Undergraduate's thesis at the Shantou University(STU).
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