Skip to content

lumen:0.1.0 #2365

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

Merged
merged 17 commits into from
May 22, 2025
Merged

lumen:0.1.0 #2365

merged 17 commits into from
May 22, 2025

Conversation

mo-nonym
Copy link
Contributor

@mo-nonym mo-nonym commented May 12, 2025

I am submitting

  • a new package

This is a typst transcription of my university's standard PhD cover. The files provided by the institution are currently either a .docx or a .tex file. A typst template fills the gap between these two formats. Only the cover is standardized; the formatting of the manuscript is left to the PhD candidate. This template is intended for generating a personalized PhD cover as a single-page PDF file.

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 added the new A new package submission. label May 15, 2025
# SPDX-License-Identifier: MIT-0

[package]
name = "ulb-phd-cover"
Copy link
Member

Choose a reason for hiding this comment

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

I feel like this name is a bit too descriptive of what the package does, can you please change it to something a bit more unique? It should also be clear that this is not an official template, which the current name may convey because of how generic it sounds.

@mo-nonym
Copy link
Contributor Author

Hello, and thanks for your comment !

For now the package is indeed not official:

  • The template provided by my institution are extremely buggy. I only heard of people ending up imitating the cover of an existing thesis as close as possible than actually making use of the provided official template files. Just to say that the word 'official' does not have much meaning here. It's more about a general appearance (;
  • As I know my institution, there's no way that the package woud become official without them seeing it in action. Therefore, my plan was to do my best and publish it (as unofficial, as you suggested) and then show them the benefits in action. No idea who that would be, but what would then be the process to mark it eventually as official ?

For the name, I was doubting. The whole university uses the same template replacing only the faculty and funding logo. The acronym of the university is ULB. Then, the format of the thesis is free, the template only applies to the cover of a submitted thesis. So I came up with the name ulb-phd-cover. In the end, I would propose ulb-phd-cover-unofficial.

Maybe there's something I don't understand about the naming conventions of typst packages. You want a proper noun ? In that case I can come up with some things losely connected to the university's motto (Scientia vincere tenebras) like the word lumen or spectra… And I put the context and info of the package in the README.

@elegaanz
Copy link
Member

Hello and thank you for all these information. ulb-phd-cover-unofficial would meet our guidelines, but still feels a bit descriptive in my opinion. I would encourage you to incorporate another noun to the mix ("lumen" or "spectra" both sound good), it would give your package name a bit more personality. All information about what the package is should not be present in its name, putting the additional context in the README and/or the description field is actually a good practice.

mo-nonym and others added 2 commits May 21, 2025 14:27
The new name is lumen, chosen in relation to the ULB motto. More
specific info is now in the description and README.
@typst-package-check typst-package-check bot changed the title ulb-phd-cover:0.1.0 lumen:0.1.0 May 21, 2025
@mo-nonym
Copy link
Contributor Author

I changed the name simply to lumen and moved all other info (+unofficial) to the description and README.

@elegaanz
Copy link
Member

Looks good, thank you!

@elegaanz elegaanz merged commit 37ad367 into typst:main May 22, 2025
2 checks passed
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