Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

modern-cqut-thesis:0.1.0 #1437

Merged
merged 1 commit into from
Dec 19, 2024
Merged

modern-cqut-thesis:0.1.0 #1437

merged 1 commit into from
Dec 19, 2024

Conversation

aFei-CQUT
Copy link
Contributor

@aFei-CQUT aFei-CQUT commented Dec 16, 2024

Submission Type:

  • New package
  • Package update

Description:
This package provides a Typst template for Chongqing University of Technology (CQUT) thesis. It aims to help students quickly generate PDF format graduation theses that comply with university requirements. Key features include:

  • Support for undergraduate and postgraduate thesis formats
  • Customizable cover pages, declaration page, abstracts, table of contents, and acknowledgments
  • Configurable font settings and double-sided printing mode
  • Roman numeral pagination for preface and appendix sections
  • Numbered environments for tables, equations, and theorems
  • Local editing and preview support

Users can easily customize their thesis by modifying the thesis.typ file. The template is designed to be extensible and can be adapted for various CQUT academic document needs.

This submission includes all necessary files, documentation, and license information as per the package submission guidelines.

I have read and followed the submission guidelines, particularly I have:

  • 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
  • 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

Copy link
Member

@elegaanz elegaanz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your package. I left a few comments, feel free to ask me if you need more explanations on how to fix these issues.

Also, just so that you know for next time, you don't have to close and re-open pull requests if you make mistakes. It is fine to have a dirty commit history, they will be squashed into a single one upon merge.

Comment on lines 1 to 5
// 这个是当前目录下导入 lib 编译
#import "../lib.typ": *

// 这个是 ~/preview/CQUT-Thesis-Typst:0.1.0/目录下导入 lib 编译,可用 install 脚本使用
// #import "@preview/CQUT-Thesis-Typst:0.1.0": documentclass, indent
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your template should use the "absolute" import by default.

Suggested change
// 这个是当前目录下导入 lib 编译
#import "../lib.typ": *
// 这个是 ~/preview/CQUT-Thesis-Typst:0.1.0/目录下导入 lib 编译,可用 install 脚本使用
// #import "@preview/CQUT-Thesis-Typst:0.1.0": documentclass, indent
#import "@preview/cqut-thesis-typst:0.1.0": documentclass, indent

This way the template works out of the box, as soon as a new project is created from it.

@@ -0,0 +1,205 @@
// 这个是当前目录下导入 lib 编译
#import "../lib.typ": *
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for this import.

@@ -0,0 +1,16 @@
[package]
name = "cqut-thesis-typst"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless this template is official and endorsed by the university staff, you should change the name of the package to something more unique (you can add a distinctive adjective for instance). If someone else was to submit another non-official alternative to this package, they should not be disadvantaged because you already took the "canonical" name.
If this template is an official one, please tell me by writing an email to [email protected] stating so, using your academic email.

And regardless of whether the package is official or not, its name should not include typst: it is obvious that this is a Typst package, so the information is just redundant.

Can you please rename it to conform to our guidelines?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your guide.

I've renamed the package name from "cqut-thesis-typst" to "modern-cqut-thesis" , and used the lastest package...

image

If there any problem feel free to point out.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, the new name is fine.

bodyfmt: x => x,
separator: [#h(0.1em)\ ],
base: "heading",
base_level: none,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be more coherent with the rest of the package (and with Typst conventions in general) it would be nice to rename this to base-level.

@@ -0,0 +1,165 @@
#import "@preview/ctheorems:1.1.2": *
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ctheorems 1.1.2 reports deprecation warnings with Typst 0.12.0. It would be nice if you could update to 1.1.3, which should work better.

@elegaanz elegaanz added the new A new package submission. label Dec 17, 2024
@aFei-CQUT aFei-CQUT force-pushed the feature-branch branch 3 times, most recently from 9900a70 to 2157cee Compare December 17, 2024 14:25
@aFei-CQUT
Copy link
Contributor Author

aFei-CQUT commented Dec 17, 2024

But I found the page numbering have some problems... so I roolback the package named "anti-matter" from 0.1.1 to 0.0.2 again...

@aFei-CQUT aFei-CQUT force-pushed the feature-branch branch 4 times, most recently from 4693d51 to c059119 Compare December 17, 2024 19:48
@elegaanz elegaanz changed the title cqut-thesis-typst:0.1.0 modern-cqut-thesis:0.1.0 Dec 18, 2024
@elegaanz
Copy link
Member

If you want to fix the issue with anti-matter, a solution seems to just reimplement it yourself, which is apparently more reliable, and will avoid deprecation warnings (which will become hard errors with the next version of Typst).

@aFei-CQUT
Copy link
Contributor Author

aFei-CQUT commented Dec 18, 2024

If you want to fix the issue with anti-matter, a solution seems to just reimplement it yourself, which is apparently more reliable, and will avoid deprecation warnings (which will become hard errors with the next version of Typst).

Thanks for the advice! I really fell into my original mistake and didn't think of this idea.

update coments

update anti-matter with the original codes

now is just import * ,this does not elegant...

Update thesis.typ

退回 anti-matter 到0.0.2
@elegaanz
Copy link
Member

Did that fix the numbering issue?

@aFei-CQUT
Copy link
Contributor Author

Did that fix the numbering issue?

Yes I have fixed the numbering issue. It works fine now.

@elegaanz
Copy link
Member

Great, I'll merge this PR then. Thanks again for the package :)

@elegaanz elegaanz merged commit 7197724 into typst:main Dec 19, 2024
1 check passed
@aFei-CQUT
Copy link
Contributor Author

aFei-CQUT commented Dec 19, 2024 via email

@aFei-CQUT aFei-CQUT deleted the feature-branch branch December 19, 2024 11:58
@elegaanz
Copy link
Member

Fonts are usually not committed to this repository. What we recommend instead is to have a guide on how to install/import them in the README of the package (or in a comment in the template file), and let each user follow these steps.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new A new package submission.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants