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

touying-flow:1.0.0 and touying-ustc:0.1.0 #1308

Closed
wants to merge 8 commits into from

Conversation

Quaternijkon
Copy link

I am submitting

  • a new package
  • an update for a package

Description: Explain what the package does and why it's useful.

This package is a template file created based on the Touying project, with simplicity and practicality as its primary features. It integrates a variety of functions, making it convenient for users to learn and use Typst to create presentations. It is particularly well-suited for academic exchanges in settings such as universities.

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.

@typst-package-check typst-package-check bot changed the title Feature/touying-flow touying-flow:1.0.0 and touying-ustc:0.1.0 Nov 21, 2024
@typst-package-check typst-package-check bot added the new A new package submission. label Nov 21, 2024
@elegaanz
Copy link
Member

Hello, I think your package need to be reworked a little bit. From what I understand, they both include a copy of an old version of touying, which I believe is not the correct way to define themes. You can have a look at what [touying-brandred-uobristol]'https://github.com/typst/packages/tree/main/packages/preview/touying-brandred-uobristol/0.1.2) does. If I'm mistaken and there is a good reason for copying all of touying, please tell me.

@Quaternijkon
Copy link
Author

Hello, I think your package need to be reworked a little bit. From what I understand, they both include a copy of an old version of touying, which I believe is not the correct way to define themes. You can have a look at what [touying-brandred-uobristol]'https://github.com/typst/packages/tree/main/packages/preview/touying-brandred-uobristol/0.1.2) does. If I'm mistaken and there is a good reason for copying all of touying, please tell me.

At first, I felt that the styles of components in Touying did not align with my theme, so I referred to Touying's source code and made some modifications. For convenience, I copied some of Touying's original components, but certain components have been implemented differently from Touying. If this structure is not considered best practice, I will replace them in future updates. By the way, the USTC project does not include packages from Touying.

@Quaternijkon
Copy link
Author

@elegaanz
I have checked, and the components I copied from Touying Dewdrop are not the same as those imported via import touying. For example, the side-by-side implementation is not available in the imported Touying package but is implemented in the Dewdrop theme. I wanted to customize these components to better adapt them to my template, so I copied some components from Touying Dewdrop. Although they are all originally created by Touying, they cannot be achieved through import @preview/touying:xyz.

I have copied more component implementations than I currently use because I hope to gradually adapt them to my theme in the future while reserving appropriate interfaces in advance. To be honest, these components are not large in size, but they are definitely not redundant parts of the Touying package.

@OrangeX4
Copy link
Contributor

First of all, thank you for your contribution! However, I don't think you should fork touying now, because it will cause you to not be able to keep up with touying's updates in the future. Touying doesn't make assumptions about how you should write your layout functions, and it ensures the decoupling of various interfaces. You can just copy a small part of it and update it with config-xxx(); Or you can use the built-in layout functions using syntax like components.side-by-side. If you think touying should add or change any part of the code, you are welcome to open an issue or PR, and you are welcome to join the touying-typ organization. If you just need to write a new theme or template, you can also refer to the existing touying themes and templates, I believe they can inspire you.

@Quaternijkon
Copy link
Author

@OrangeX4 thanks for your reply, I will refactor it later.

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.

3 participants